DtNodeIconXmlReader Class Reference

Non copyable. More...

Collaboration diagram for DtNodeIconXmlReader:

Public Member Functions
	DtNodeIconXmlReader (const MAKRti::DtFilename &xmlFile)
	Constructor.
virtual	~DtNodeIconXmlReader ()
	Destructor.
virtual const std::vector < DtNodeIconFile > &	getNodeIconFiles ()
	Return the loaded file names.
virtual void	setNodeIconFiles (const std::vector< DtNodeIconFile > &iconFiles)
	Set the currently used file names and save to disk.

Protected Member Functions
virtual void	parse ()
	Parse the file.
virtual MAKRti::DtString	fedIdTypeToString (DtFederateIdentifierType idType) const
	Convert a DtFederateIdentifierType to a string for the xml file.
virtual DtFederateIdentifierType	stringToFedIdType (const MAKRti::DtString &str) const
	Convert an xml string to a DtFederateIdentifierType.

Protected Attributes
MAKRti::DtEnvironment	myEnvironment
	the cached environment
MAKRti::DtFilename	myXmlFile
	the name of the default xml file to read from
MAKRti::DtString	myReadFileVersion
	The version of the file that was read.
bool	myFileWasRead
	Indicates whether a cache file was found and read.
std::vector< DtNodeIconFile >	myImageFiles
	Vector that holds the simple image file information.

Static Protected Attributes
static const MAKRti::DtString	theVersionString = "version"
	String constants for parsing the xml file.
static const MAKRti::DtString	theRootNodeString = "nodeIcons"
	String constants for parsing the xml file.
static const MAKRti::DtString	theNodeIconString = "nodeIcon"
	String constants for parsing the xml file.
static const MAKRti::DtString	theIdentifierString = "identifier"
	String constants for parsing the xml file.
static const MAKRti::DtString	theIconFileString = "iconFile"
	String constants for parsing the xml file.
static const MAKRti::DtString	theIdTypeString = "idType"
	String constants for parsing the xml file.
static const MAKRti::DtString	theFederateTypeString = "federateType"
	String constants for parsing the xml file.
static const MAKRti::DtString	theFederateNameString = "federateName"
	String constants for parsing the xml file.
static const MAKRti::DtString	theProcessNameString = "processName"
	String constants for parsing the xml file.

Private Member Functions
	DtNodeIconXmlReader (const DtNodeIconXmlReader &copy)
	Not copyable.
DtNodeIconXmlReader &	operator= (const DtNodeIconXmlReader &rhs)

Detailed Description

Non copyable.

Constructor & Destructor Documentation

DtNodeIconXmlReader::DtNodeIconXmlReader

(

const MAKRti::DtFilename &

xmlFile

)

Constructor.

References myEnvironment, myFileWasRead, myReadFileVersion, myXmlFile, parse(), and theVersionString.

DtNodeIconXmlReader::~DtNodeIconXmlReader ( )

virtual

Destructor.

DtNodeIconXmlReader::DtNodeIconXmlReader ( const DtNodeIconXmlReader &  copy )

private

Not copyable.

Member Function Documentation

MAKRti::DtString DtNodeIconXmlReader::fedIdTypeToString ( DtFederateIdentifierType  idType ) const

protectedvirtual

Convert a DtFederateIdentifierType to a string for the xml file.

References DtIdentifyByFederateName, DtIdentifyByFederateType, DtIdentifyByProcessName, theFederateNameString, theFederateTypeString, and theProcessNameString.

Referenced by setNodeIconFiles().

const std::vector< DtNodeIconFile > & DtNodeIconXmlReader::getNodeIconFiles ( )

virtual

Return the loaded file names.

References myImageFiles.

Referenced by DtIconAndTextureManager::initialize().

DtNodeIconXmlReader& DtNodeIconXmlReader::operator= ( const DtNodeIconXmlReader &  rhs )

private

void DtNodeIconXmlReader::parse ( )

protectedvirtual

Parse the file.

References DtNodeIconFile::fedIdType, DtNodeIconFile::imageFile, myEnvironment, myImageFiles, DtNodeIconFile::nodeId, stringToFedIdType(), theIconFileString, theIdentifierString, theIdTypeString, and theNodeIconString.

Referenced by DtNodeIconXmlReader().

void DtNodeIconXmlReader::setNodeIconFiles ( const std::vector< DtNodeIconFile > &  iconFiles )

virtual

Set the currently used file names and save to disk.

References fedIdTypeToString(), myEnvironment, myImageFiles, myXmlFile, stringToFedIdType(), theIconFileString, theIdentifierString, theIdTypeString, theNodeIconString, and theRootNodeString.

Referenced by DtIconAndTextureManager::saveToFile().

DtFederateIdentifierType DtNodeIconXmlReader::stringToFedIdType ( const MAKRti::DtString &  str ) const

protectedvirtual

Convert an xml string to a DtFederateIdentifierType.

References DtIdentifyByFederateName, DtIdentifyByFederateType, DtIdentifyByProcessName, theFederateNameString, and theProcessNameString.

Referenced by parse(), and setNodeIconFiles().

Member Data Documentation

MAKRti::DtEnvironment DtNodeIconXmlReader::myEnvironment

protected

the cached environment

Referenced by DtNodeIconXmlReader(), parse(), and setNodeIconFiles().

bool DtNodeIconXmlReader::myFileWasRead

protected

Indicates whether a cache file was found and read.

Referenced by DtNodeIconXmlReader().

std::vector< DtNodeIconFile > DtNodeIconXmlReader::myImageFiles

protected

Vector that holds the simple image file information.

Referenced by getNodeIconFiles(), parse(), and setNodeIconFiles().

MAKRti::DtString DtNodeIconXmlReader::myReadFileVersion

protected

The version of the file that was read.

Referenced by DtNodeIconXmlReader().

MAKRti::DtFilename DtNodeIconXmlReader::myXmlFile

protected

the name of the default xml file to read from

Referenced by DtNodeIconXmlReader(), and setNodeIconFiles().

const MAKRti::DtString DtNodeIconXmlReader::theFederateNameString = "federateName"

staticprotected

String constants for parsing the xml file.

Referenced by fedIdTypeToString(), and stringToFedIdType().

const MAKRti::DtString DtNodeIconXmlReader::theFederateTypeString = "federateType"

staticprotected

String constants for parsing the xml file.

Referenced by fedIdTypeToString().

const MAKRti::DtString DtNodeIconXmlReader::theIconFileString = "iconFile"

staticprotected

String constants for parsing the xml file.

Referenced by parse(), and setNodeIconFiles().

const MAKRti::DtString DtNodeIconXmlReader::theIdentifierString = "identifier"

staticprotected

String constants for parsing the xml file.

Referenced by parse(), and setNodeIconFiles().

const MAKRti::DtString DtNodeIconXmlReader::theIdTypeString = "idType"

staticprotected

String constants for parsing the xml file.

Referenced by parse(), and setNodeIconFiles().

const MAKRti::DtString DtNodeIconXmlReader::theNodeIconString = "nodeIcon"

staticprotected

String constants for parsing the xml file.

Referenced by parse(), and setNodeIconFiles().

const MAKRti::DtString DtNodeIconXmlReader::theProcessNameString = "processName"

staticprotected

String constants for parsing the xml file.

Referenced by fedIdTypeToString(), and stringToFedIdType().

const MAKRti::DtString DtNodeIconXmlReader::theRootNodeString = "nodeIcons"

staticprotected

String constants for parsing the xml file.

Referenced by setNodeIconFiles().

const MAKRti::DtString DtNodeIconXmlReader::theVersionString = "version"

staticprotected

String constants for parsing the xml file.

Referenced by DtNodeIconXmlReader().

---

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

• nodeIconXmlReader.h
• nodeIconXmlReader.cxx