Identifier Class Reference

Channel identification. More...

#include <Identifier.hpp>

Collaboration diagram for Identifier:

Public Types
typedef int	TagValue
	Type definition for the tag vaule.

Public Member Functions
	Identifier ()
	~Identifier ()
	Identifier (const std::string &type, const std::string &subType, const int &loc)
void	SetDammID (int a)
void	SetType (const std::string &a)
void	SetSubtype (const std::string &a)
void	SetLocation (int a)
int	GetDammID () const
const std::string &	GetType () const
const std::string &	GetSubtype () const
int	GetLocation () const
void	AddTag (const std::string &s, TagValue n)
bool	HasTag (const std::string &s) const
TagValue	GetTag (const std::string &s) const
void	Zero ()
void	Print (void) const
bool	operator== (const Identifier &x) const
bool	operator!= (const Identifier &x) const
bool	operator< (const Identifier &x) const
std::string	GetPlaceName () const

Static Public Member Functions
static void	PrintHeaders (void)

Private Attributes
std::string	type
std::string	subtype
int	dammID
int	location
std::map< std::string, TagValue >	tag

Detailed Description

Channel identification.

All parameters needed to uniquely specify the detector connected to a specific channel are set here. A vector of identifiers for all channels is created on initialization in InitID(). Each event that is created in ScanList() in PixieStd.cpp has its channel identifier attached to it in the variable chanID inside RawEvent

Identifier is a class that will contain basic channel information that will not change including the damm spectrum number where the raw energies will be plotted, the detector type and subtype, and the detector's physical location (strip number, detector location, ...)

Constructor & Destructor Documentation

Identifier::Identifier ( )

inline

Default constructor

The dammid and detector location variable are set to -1 and the detector type and sub type are both set to "" when an identifier object is created.

Identifier::~Identifier ( )

inline

Default Destructor

Identifier::Identifier	(	const std::string &	type,
		const std::string &	subType,
		const int &	loc
	)

Constructor taking arguments and setting values

Parameters

[in]	type	: the type to set
[in]	subType	: the subType to set
[in]	loc	: the location to set

Member Function Documentation

void Identifier::AddTag ( const std::string &  s, TagValue  n  )

inline

Insert a tag to the Identifier

Parameters

[in]	s	: the name of the tag to insert
[in]	n	: the value of the tag to insert

int Identifier::GetDammID ( ) const

inline

Returns

Get the dammid

int Identifier::GetLocation ( ) const

inline

Returns

Get the detector location

std::string Identifier::GetPlaceName ( ) const

inline

Returns

The name of the place associated with the channel

const std::string& Identifier::GetSubtype ( ) const

inline

Returns

Get the detector subtype

TagValue Identifier::GetTag

(

const std::string &

s

)

const

Returns

Get the requested tag

Parameters

[in]

s

: the name of the tag to get

const std::string& Identifier::GetType ( ) const

inline

Returns

Get the detector type

bool Identifier::HasTag ( const std::string &  s ) const

inline

Check if an identifier has a tag

Parameters

[in]

s

: the tag to search for

Returns

true if the tag is in the identifier

bool Identifier::operator!= ( const Identifier &  x ) const

inline

Not - Equality operator for identifier

Parameters

[in]

x

: the Identifier to compare to

Returns

true if this is not equal to x

bool Identifier::operator< ( const Identifier &  x ) const

inline

Less-then operator needed for map container in WalkCorrector.hpp

Parameters

[in]

x

: the Identifier to compare

Returns

true if this is less than x

bool Identifier::operator== ( const Identifier &  x ) const

inline

Equality operator for identifier

Parameters

[in]

x

: the Identifier to compare to

Returns

true if this is equal to x

void Identifier::Print

(

void

)

const

Print all of the info for the Identifier

static void Identifier::PrintHeaders ( void  )

static

Print the headers for the Identifier

void Identifier::SetDammID ( int  a )

inline

Sets the DAMM ID

Parameters

[in]

a

: the id to set

void Identifier::SetLocation ( int  a )

inline

Sets the location

Parameters

[in]

a

: sets the location for the channel

void Identifier::SetSubtype ( const std::string &  a )

inline

Sets the subtype of the channel

Parameters

[in]

a

: the subtype to set

void Identifier::SetType ( const std::string &  a )

inline

Sets the type

Parameters

[in]

a

: the type to set

void Identifier::Zero

(

)

Zeroes an identifier

The dammid and detector location variable are reset to -1 and the detector type and sub type are both reset to "" when an identifier object is zeroed.

Field Documentation

int Identifier::dammID

private

Damm spectrum number for plotting calibrated energies

int Identifier::location

private

Specifies the real world location of the channel. For the DSSD this variable is the strip number

std::string Identifier::subtype

private

Specifies the detector sub type

std::map<std::string, TagValue> Identifier::tag

private

A list of tags associated with the Identifier

std::string Identifier::type

private

Specifies the detector type

---

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

• include/Identifier.hpp