SiStripNullKey Class Reference

Concrete implementation of abstract base, signifying null values or an "unknown" position or view. More...

#include <SiStripNullKey.h>

Inheritance diagram for SiStripNullKey:

Public Member Functions
bool	isConsistent (const SiStripKey &) const
bool	isEqual (const SiStripKey &) const
bool	isInvalid () const
bool	isInvalid (const sistrip::Granularity &) const
bool	isValid () const
bool	isValid (const sistrip::Granularity &) const
virtual void	print (std::stringstream &ss) const
	SiStripNullKey ()
virtual void	terse (std::stringstream &ss) const
Public Member Functions inherited from SiStripKey
const uint16_t &	channel () const
const sistrip::Granularity &	granularity () const
const uint32_t &	key () const
const SiStripKey &	operator= (const SiStripKey &)
const std::string &	path () const
	SiStripKey (const uint32_t &key)
	SiStripKey (const std::string &directory_path)
	SiStripKey (const SiStripKey &)
	SiStripKey ()
virtual	~SiStripKey ()

Private Member Functions
void	initFromKey ()
void	initFromPath ()
void	initFromValue ()
void	initGranularity ()

Additional Inherited Members
Protected Member Functions inherited from SiStripKey
void	channel (const uint16_t &)
void	granularity (const sistrip::Granularity &)
void	key (const uint32_t &)
void	path (const std::string &)

Detailed Description

Concrete implementation of abstract base, signifying null values or an "unknown" position or view.

Author

R.Bainbridge

Definition at line 20 of file SiStripNullKey.h.

Constructor & Destructor Documentation

SiStripNullKey::SiStripNullKey

(

)

Default constructor

Definition at line 8 of file SiStripNullKey.cc.

: SiStripKey() {;}

Member Function Documentation

void SiStripNullKey::initFromKey ( )

privatevirtual

Reimplemented from SiStripKey.

Definition at line 53 of file SiStripNullKey.cc.

{;}

void SiStripNullKey::initFromPath ( )

privatevirtual

Reimplemented from SiStripKey.

Definition at line 57 of file SiStripNullKey.cc.

{;}

void SiStripNullKey::initFromValue ( )

privatevirtual

Reimplemented from SiStripKey.

Definition at line 49 of file SiStripNullKey.cc.

{;}

void SiStripNullKey::initGranularity ( )

privatevirtual

Reimplemented from SiStripKey.

Definition at line 61 of file SiStripNullKey.cc.

{;}

bool SiStripNullKey::isConsistent ( const SiStripKey &  input ) const

virtual

"Consistent" means identical and/or null (ie, "all") data.

Reimplemented from SiStripKey.

Definition at line 19 of file SiStripNullKey.cc.

References isEqual().

                                                                 {
  return isEqual(input);
}

bool SiStripNullKey::isEqual ( const SiStripKey &  input ) const

virtual

Identifies key objects with identical member data.

Reimplemented from SiStripKey.

Definition at line 12 of file SiStripNullKey.cc.

Referenced by isConsistent().

                                                            {
  if ( &dynamic_cast<const SiStripNullKey&>(input) ) { return true; }
  else { return false; }
}

bool SiStripNullKey::isInvalid ( ) const

virtual

Identifies all member data as being invalid.

Reimplemented from SiStripKey.

Definition at line 37 of file SiStripNullKey.cc.

                                     { 
  return true;
}

bool SiStripNullKey::isInvalid ( const sistrip::Granularity &  gran ) const

virtual

All member data to level of "Granularity" are invalid. If sistrip::Granularity is "undefined", returns true.

Reimplemented from SiStripKey.

Definition at line 43 of file SiStripNullKey.cc.

                                                                     {
  return true;
}

bool SiStripNullKey::isValid ( void  ) const

virtual

Identifies all member data as being "valid" or null ("all").

Reimplemented from SiStripKey.

Definition at line 25 of file SiStripNullKey.cc.

Referenced by print().

                                   { 
  return false;
}

bool SiStripNullKey::isValid ( const sistrip::Granularity &  gran ) const

virtual

All member data to level of "Granularity" are valid. If sistrip::Granularity is "undefined", returns false.

Reimplemented from SiStripKey.

Definition at line 31 of file SiStripNullKey.cc.

                                                                   {
  return false; 
}

void SiStripNullKey::print ( std::stringstream &  ss ) const

virtual

Print member data of the key

Reimplemented from SiStripKey.

Definition at line 65 of file SiStripNullKey.cc.

References SiStripKey::channel(), SiStripEnumsAndStrings::granularity(), SiStripKey::granularity(), isValid(), SiStripKey::key(), and SiStripKey::path().

Referenced by operator<<().

                                                      {
  ss << " [SiStripNullKey::print]" << std::endl
     << std::hex
     << " 32-bit key  : 0x" 
     << std::setfill('0') 
     << std::setw(8) << key() << std::endl
     << std::setfill(' ') 
     << std::dec
     << " Directory   : " << path() << std::endl
     << " Granularity : "
     << SiStripEnumsAndStrings::granularity( granularity() ) << std::endl
     << " Channel     : " << channel() << std::endl
     << " isValid    : " << isValid();
}

virtual void SiStripNullKey::terse ( std::stringstream &  ss ) const

inlinevirtual

A terse summary of the key

Reimplemented from SiStripKey.

Definition at line 57 of file SiStripNullKey.h.

{;}