LATtypeId Class Reference

Support classes for labeling the various classes involved in decoding event data from the LAT. More...

#include <LATtypeId.h>

List of all members.

Public Types
	LATtypeIdPrimOff = 0
	LATtypeIdPrimMax = 0x000FFFFF
	LATtypeIdPrimMsk = LATtypeIdPrimMax
	LATtypeIdSecyOff = 20
	LATtypeIdSecyMax = 0x00000FFF
	LATtypeIdSecyMsk = LATtypeIdSecyMax << LATtypeIdSecyOff
	LATtypeIdSecyAny = 0
	LATtypeIdAny = 0
	LATtypeIdNull = 0
enum	{ LATtypeIdPrimOff = 0, LATtypeIdPrimMax = 0x000FFFFF, LATtypeIdPrimMsk = LATtypeIdPrimMax }
enum	{ LATtypeIdSecyOff = 20, LATtypeIdSecyMax = 0x00000FFF, LATtypeIdSecyMsk = LATtypeIdSecyMax << LATtypeIdSecyOff }
enum	{ LATtypeIdSecyAny = 0 }
enum	{ LATtypeIdAny = 0 }
enum	{ LATtypeIdNull = 0 }
Public Member Functions
LATtypeIdValue_t	value () const
LATtypeIdPrimary_t	getPrimary () const
LATtypeIdSecondary_t	getSecondary () const
int	setPrimary (LATtypeIdPrimary_t prim)
	Set the primary ID in a LATtypeId.
int	setSecondary (LATtypeIdSecondary_t secy)
	Set the secondary ID in a LATtypeId.
	LATtypeId (const LATtypeId &v2)
	LATtypeId (LATtypeIdPrimary_t prim, LATtypeIdSecondary_t secy)
	LATtypeId (LATtypeIdValue_t value)
	LATtypeId ()
	~LATtypeId ()
	Destructor.
LATtypeId &	operator= (const LATtypeId &id)
	Assignment.
int	operator== (const LATtypeId &id) const
	Equality test.
int	operator!= (const LATtypeId &id) const
	Inequality test.

---

Detailed Description

Support classes for labeling the various classes involved in decoding event data from the LAT.

Ideas here are loosely copied from "Software developed for the BaBar Detector at the SLAC B-Factory". A number of the comments were copied verbatim.

Original notes from GDPF:
Concrete base class that contains all the knowledge necessary to decode type ID codes for DataFlow's transmissible objects. This is a fully private class not intended for use outside the odfTypeIdPrimary and odfTypeIdQualified classes, its subclasses.

Author:

Gregory Dubois-Felsmann gpdf Originator

R. Claus -- GLAST LAT I&T/Online - (claus@slac.stanford.edu)

Revision

1.2

Date:

February 9, 2004 -- Created

Id

LATtypeId.h,v 1.2 2004/10/14 04:41:09 claus Exp

Copyright: Copyright (C) 1997 California Institute of Technology

Copyright 2004 by The Board of Trustees of the Leland Stanford Junior University. All rights reserved.

---

Constructor & Destructor Documentation

LATtypeId::LATtypeId

(

const LATtypeId &

v2

)

[inline]

Copy constructor

LATtypeId::LATtypeId	(	LATtypeIdPrimary_t	prim,
		LATtypeIdSecondary_t	secy
	)			[inline]

Constructor initializing a LATtypeId from a LATtypeIdPrimary_t and a LATtypeIdSecondary_t

LATtypeId::LATtypeId

(

LATtypeIdValue_t

value

)

[inline]

Constructor initializing a LATtypeId from an LATtypeIdValue_t

LATtypeId::LATtypeId

(

)

[inline]

Constructor to set up a NULL LATtypeId

LATtypeId::~LATtypeId

(

)

[inline]

Destructor.

This is a transmissible class and may contain no virtual functions.

---

Member Function Documentation

LATtypeIdPrimary_t LATtypeId::getPrimary

(

)

const [inline]

Return the primary ID portion of a LATtypeId

LATtypeIdSecondary_t LATtypeId::getSecondary

(

)

const [inline]

Return the secondary ID portion of a LATtypeId

int LATtypeId::setPrimary

(

LATtypeIdPrimary_t

prim

)

[inline]

Set the primary ID in a LATtypeId.

Returns:

Success or failure (if value is out-of-range).

int LATtypeId::setSecondary

(

LATtypeIdSecondary_t

secy

)

[inline]

Set the secondary ID in a LATtypeId.

Returns:

Success or failure (if value is out-of-range).

LATtypeIdValue_t LATtypeId::value

(

)

const [inline]

Return a LATtypeId as an LATtypeIdValue_t

---

The documentation for this class was generated from the following file:

• LATtypeId.h

---