DtSimulationObjectCategoryInformation Class Reference

The DtSimulationObjectCategoryInformation class is a class that will read the comma delimited category information file as well as provide access for adding, removing and saving informatiion. More...

Classes
struct	CategoryInformation

Public Types
typedef std::map< DtString, CategoryInformation >	Categories

Public Member Functions
	DtSimulationObjectCategoryInformation ()
	CTOR. More...
	DtSimulationObjectCategoryInformation (const DtSimulationObjectCategoryInformation &)
virtual	~DtSimulationObjectCategoryInformation ()
	DTOR. More...
virtual bool	load (const DtFilename &, bool clear=false)
	Loads the given file. More...
virtual void	clear ()
	Clears category information. More...
virtual bool	save (const DtFilename &)
	Saves category information to the given file. More...
virtual void	addCategoryInformation (const DtString &, int rank=100, bool topLevelTag=false, const DtString &iconFilename="", bool visible=true, const DtString &displayName="")
	Adds a row of category information. More...
virtual void	addCategoryInformation (const DtString &, const CategoryInformation &cat)
virtual void	removeCategoryInformation (const DtString &)
	Removes a category row. More...
virtual bool	hasCategory (const DtString &) const
	Returns true if the category exists. More...
virtual bool	isTopLevelTag (const DtString &cat) const
	Returns true if this is a top level tag. More...
virtual CategoryInformation	categoryInformation (const DtString &) const
	Returns category information for the given category. More...
const Categories &	categories () const
	Returns the category information as a map. More...
DtSimulationObjectCategoryInformation &	operator= (const DtSimulationObjectCategoryInformation &)
bool	operator== (const DtSimulationObjectCategoryInformation &) const
bool	operator!= (const DtSimulationObjectCategoryInformation &orig) const

Static Public Member Functions
static DtFilename	categoriesFilename ()
	Accessors for global categories filename. Default is categories.csv. More...
static void	setCategoriesFilename (const DtFilename &)

Protected Attributes
Categories	myCategories

Detailed Description

The DtSimulationObjectCategoryInformation class is a class that will read the comma delimited category information file as well as provide access for adding, removing and saving informatiion.

Member Typedef Documentation

typedef std::map<DtString, CategoryInformation> DtSimulationObjectCategoryInformation::Categories

Constructor & Destructor Documentation

DtSimulationObjectCategoryInformation::DtSimulationObjectCategoryInformation

(

)

CTOR.

DtSimulationObjectCategoryInformation::DtSimulationObjectCategoryInformation

(

const DtSimulationObjectCategoryInformation &

)

virtual DtSimulationObjectCategoryInformation::~DtSimulationObjectCategoryInformation ( )

virtual

DTOR.

Member Function Documentation

virtual bool DtSimulationObjectCategoryInformation::load ( const DtFilename &  , bool  clear = false  )

virtual

Loads the given file.

Will merge information read from the file with current information. If you want to load and then clear in the process of loading set the clear flag to true. Note that the first line of the file is assumed to be the columns of the data of the file

virtual void DtSimulationObjectCategoryInformation::clear ( )

virtual

Clears category information.

virtual bool DtSimulationObjectCategoryInformation::save ( const DtFilename &  )

virtual

Saves category information to the given file.

virtual void DtSimulationObjectCategoryInformation::addCategoryInformation ( const DtString &  , int  rank = 100, bool  topLevelTag = false, const DtString &  iconFilename = "", bool  visible = true, const DtString &  displayName = ""  )

virtual

Adds a row of category information.

If the information exists will overwrite. If displayName is empty, category name will be used for display (and possibly run through Qt translation). The displayName will not be – it will be taken as is

virtual void DtSimulationObjectCategoryInformation::addCategoryInformation ( const DtString &  , const CategoryInformation &  cat  )

virtual

virtual void DtSimulationObjectCategoryInformation::removeCategoryInformation ( const DtString &  )

virtual

Removes a category row.

virtual bool DtSimulationObjectCategoryInformation::hasCategory ( const DtString &  ) const

virtual

Returns true if the category exists.

virtual bool DtSimulationObjectCategoryInformation::isTopLevelTag ( const DtString &  cat ) const

virtual

Returns true if this is a top level tag.

virtual CategoryInformation DtSimulationObjectCategoryInformation::categoryInformation ( const DtString &  ) const

virtual

Returns category information for the given category.

const Categories& DtSimulationObjectCategoryInformation::categories ( ) const

inline

Returns the category information as a map.

DtSimulationObjectCategoryInformation& DtSimulationObjectCategoryInformation::operator=

(

const DtSimulationObjectCategoryInformation &

)

bool DtSimulationObjectCategoryInformation::operator==

(

const DtSimulationObjectCategoryInformation &

)

const

bool DtSimulationObjectCategoryInformation::operator!= ( const DtSimulationObjectCategoryInformation &  orig ) const

inline

static DtFilename DtSimulationObjectCategoryInformation::categoriesFilename ( )

static

Accessors for global categories filename. Default is categories.csv.

static void DtSimulationObjectCategoryInformation::setCategoriesFilename ( const DtFilename &  )

static

Member Data Documentation

Categories DtSimulationObjectCategoryInformation::myCategories

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfutil/simulationObjectCategoryInformation.h