makVrv::DtFaccCode Class Reference

A data type which represents a FACC code. More...

Public Member Functions
	DtFaccCode (char cat=InvalidCategory, char subcat=InvalidCategory, short type=InvalidType)
	Default constructor.
std::string	toString () const
	Utility function for converting from a string.
bool	operator== (const DtFaccCode &other) const
	Are these two codes identical.
bool	operator!= (const DtFaccCode &other) const
	Are these two codes different.
bool	sameCategory (const DtFaccCode &other) const
	Are these two codes in the same category.
bool	sameSubcategory (const DtFaccCode &other) const
	Are these two codes in the same category and subcategory.
bool	isAbstract () const
	Is this an abstract code, with invalid categories or types.
bool	operator< (const DtFaccCode &other) const
	Test for less, used for sorted containers.

Static Public Member Functions
static DtFaccCode	fromString (const std::string &str)
	Utility function for converting from a string.

Public Attributes
char	myCategory
	Variables are public to simplify interface.
char	mySubcategory
short	myType

Static Public Attributes
static const char	InvalidCategory = ' '
static const short	InvalidType = -1

Detailed Description

A data type which represents a FACC code.

Constructor & Destructor Documentation

makVrv::DtFaccCode::DtFaccCode ( char  cat = InvalidCategory, char  subcat = InvalidCategory, short  type = InvalidType  )

inline

Default constructor.

The use of invalid types allows for FACC codes which do not have a subcategory and a type. Thus they are only valid for testing whether a FaccCode has a given category and subcategory.

Member Function Documentation

static DtFaccCode makVrv::DtFaccCode::fromString ( const std::string &  str )

inlinestatic

Utility function for converting from a string.

std::string makVrv::DtFaccCode::toString ( ) const

inline

Utility function for converting from a string.

bool makVrv::DtFaccCode::operator== ( const DtFaccCode &  other ) const

inline

Are these two codes identical.

bool makVrv::DtFaccCode::operator!= ( const DtFaccCode &  other ) const

inline

Are these two codes different.

bool makVrv::DtFaccCode::sameCategory ( const DtFaccCode &  other ) const

inline

Are these two codes in the same category.

bool makVrv::DtFaccCode::sameSubcategory ( const DtFaccCode &  other ) const

inline

Are these two codes in the same category and subcategory.

bool makVrv::DtFaccCode::isAbstract ( ) const

inline

Is this an abstract code, with invalid categories or types.

bool makVrv::DtFaccCode::operator< ( const DtFaccCode &  other ) const

inline

Test for less, used for sorted containers.

Member Data Documentation

const char makVrv::DtFaccCode::InvalidCategory = ' '

static

const short makVrv::DtFaccCode::InvalidType = -1

static

char makVrv::DtFaccCode::myCategory

Variables are public to simplify interface.

char makVrv::DtFaccCode::mySubcategory

short makVrv::DtFaccCode::myType

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvUtil/DtFaccCode.h