Channel identification. More...

#include <Identifier.hpp>

Collaboration diagram for Identifier:

Public Member Functions
	Identifier ()

	~Identifier ()

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

void	SetDammID (unsigned int &a)

void	SetType (const std::string &a)

void	SetSubtype (const std::string &a)

void	SetLocation (const unsigned int &a)

unsigned int	GetDammID () const

const std::string &	GetType () const

const std::string &	GetSubtype () const

unsigned int	GetLocation () const

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

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

int	GetTag (const std::string &s) const

std::map< std::string, int >	GetTagMap (void) 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

bool	operator> (const Identifier &rhs) const

std::string	GetPlaceName () const

Static Public Member Functions
static void	PrintHeaders (void)

Private Attributes
std::string	type_

std::string	subtype_

unsigned int	dammID_

unsigned int	location_

std::map< std::string, int >	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, ...)

Definition at line 23 of file Identifier.hpp.

Constructor & Destructor Documentation

§ Identifier() [1/2]

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.

Definition at line 30 of file Identifier.hpp.

Here is the call graph for this function:

§ ~Identifier()

Identifier::~Identifier ( )

inline

Default Destructor

Definition at line 32 of file Identifier.hpp.

§ Identifier() [2/2]

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

inline

Constructor taking arguments and setting values

Parameters

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

Definition at line 38 of file Identifier.hpp.

Member Function Documentation

§ AddTag()

void Identifier::AddTag	(	const std::string &	s,
		int	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

Definition at line 70 of file Identifier.hpp.

§ GetDammID()

unsigned int Identifier::GetDammID ( ) const

inline

Returns: The value of the private variable dammID

Definition at line 59 of file Identifier.hpp.

§ GetLocation()

unsigned int Identifier::GetLocation ( ) const

inline

Returns: The value of the private variable location

Definition at line 65 of file Identifier.hpp.

Here is the caller graph for this function:

§ GetPlaceName()

std::string Identifier::GetPlaceName ( ) const

inline

Returns: The name of the place associated with the channel

Definition at line 140 of file Identifier.hpp.

Here is the caller graph for this function:

§ GetSubtype()

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

inline

Returns: the value of the private variable subtype

Definition at line 63 of file Identifier.hpp.

Here is the caller graph for this function:

§ GetTag()

int Identifier::GetTag ( const std::string & s ) const

Returns: Get the requested tag

Parameters

[in] s : the name of the tag to get

Definition at line 12 of file Identifier.cpp.

Here is the caller graph for this function:

§ GetTagMap()

std::map<std::string, int> Identifier::GetTagMap ( void ) const

inline

Returns: The map with the list of tags

Definition at line 85 of file Identifier.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

§ GetType()

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

inline

Returns: The value of the private variable type

Definition at line 61 of file Identifier.hpp.

Here is the caller graph for this function:

§ HasTag()

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

Definition at line 75 of file Identifier.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

§ operator!=()

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

Definition at line 110 of file Identifier.hpp.

Here is the call graph for this function:

§ operator<()

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

Definition at line 117 of file Identifier.hpp.

Here is the caller graph for this function:

§ operator==()

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

Definition at line 101 of file Identifier.hpp.

Here is the caller graph for this function:

§ operator>()

bool Identifier::operator> ( const Identifier & rhs ) const

inline

Parameters

[in] rhs : The right hand side that we are comparing with.

Returns: The negative of the less than operator.

Definition at line 135 of file Identifier.hpp.

Here is the call graph for this function:

§ Print()

void Identifier::Print ( void ) const

Print all of the info for the Identifier

Definition at line 36 of file Identifier.cpp.

Here is the caller graph for this function:

§ PrintHeaders()

void Identifier::PrintHeaders ( void )

static

Print the headers for the Identifier

Definition at line 28 of file Identifier.cpp.

Here is the caller graph for this function:

§ SetDammID()

void Identifier::SetDammID ( unsigned int & a )

inline

Sets the DAMM ID

Parameters

[in] a : the id to set

Definition at line 47 of file Identifier.hpp.

§ SetLocation()

void Identifier::SetLocation ( const unsigned int & a )

inline

Sets the location

Parameters

[in] a : sets the location for the channel

Definition at line 56 of file Identifier.hpp.

§ SetSubtype()

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

inline

Sets the subtype of the channel

Parameters

[in] a : the subtype to set

Definition at line 53 of file Identifier.hpp.

§ SetType()

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

inline

Sets the type

Parameters

[in] a : the type to set

Definition at line 50 of file Identifier.hpp.

§ Zero()

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.

Definition at line 19 of file Identifier.cpp.

Here is the caller graph for this function:

Field Documentation

§ dammID_

unsigned int Identifier::dammID_

private

Damm spectrum number for plotting calibrated energies

Definition at line 148 of file Identifier.hpp.

§ location_

unsigned int Identifier::location_

private

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

Definition at line 150 of file Identifier.hpp.

§ subtype_

std::string Identifier::subtype_

private

Specifies the detector sub type

Definition at line 147 of file Identifier.hpp.

§ tag_

std::map<std::string, int> Identifier::tag_

private

A list of tags associated with the Identifier

Definition at line 153 of file Identifier.hpp.

§ type_

std::string Identifier::type_

private

Specifies the detector type

Definition at line 146 of file Identifier.hpp.

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

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

§ Identifier() [1/2]

§ ~Identifier()

§ Identifier() [2/2]

Member Function Documentation

§ AddTag()

§ GetDammID()

§ GetLocation()

§ GetPlaceName()

§ GetSubtype()

§ GetTag()

§ GetTagMap()

§ GetType()

§ HasTag()

§ operator!=()

§ operator<()

§ operator==()

§ operator>()

§ Print()

§ PrintHeaders()

§ SetDammID()

§ SetLocation()

§ SetSubtype()

§ SetType()

§ Zero()

Field Documentation

§ dammID_

§ location_

§ subtype_

§ tag_

§ type_