The element definition class contains the element definition information. More...

Public Member Functions
const DtUnicode &	name () const
	Get the name of the element definition. More...

const std::string &	fileName () const
	Get the file name of the element definition. More...

const std::vector< std::string > &	duplicateNames () const
	Gets the list of all file names saved to show duplicates. More...

void	setFileName (const std::string &)
	Assigns the file name to the model definition. More...

bool	isEqual (const DtElementDefinitionNew &) const
	check if two element definitions are equal we don't comapre the parent or children More...

int	numberOfVisualizerDefinitionSets () const
	Get the number of visualizer definition sets the definition has. More...

DtVisualizerDefinitionSet &	visualizerDefinitionSet (int modelSet)
	Get the visualizer set for the model set. More...

const DtVisualizerDefinitionSet &	visualizerDefinitionSet (int modelSet) const
	Get the visualizer set for the model set. More...

DtElementDefinitionNew *	findParent ()
	Find the element definition that his inherits from. More...

const DtElementDefinitionNew *	findParent () const
	Find the element definition that his inherits from. More...

unsigned int	numberOfChildren () const
	Get the number of element definitions which inherit from this definition. More...

DtElementDefinitionNew *	findChild (unsigned int index)
	Find a child at a given index. More...

const DtElementDefinitionNew *	findChild (unsigned int index) const
	Find a child at a given index. More...

int	findChildIndex (const DtElementDefinitionNew *child) const
	Get the index of a child definition. More...

std::vector < DtElementDefinitionNew * >	getChildren ()
	Gets the list of children of the element definition. More...

DtVisualizerDefinition *	findOrCreateLocalVisualizer (int modelSet, int visualizerIndex)
	Finds or creates a local visualizer, there must be a visualizer at the visualizerIndex, either a local visualizer or an inherited visualizer. More...

DtVisualizerAttribute *	findOrCreateLocalAttribute (int modelSet, int visualizerIndex, const std::string &attributeName)
	Utility function for finding or creating a local visualizer and local attribute. More...

bool	isHier () const
	Is this element definition a hierarchy node? More...

void	setIsHier (bool isHier)
	Set the name of the element definition. More...

bool	isDuplicate () const
	Whether or not the element definition is in another file as well. More...

void	addDuplicateName (const std::string &duplicateName)
	Adds file locations where duplicates of file are found. More...

void	setDuplicateFlag (bool duplicate)
	Set whether or not this def is a duplicate. More...

DtElementDefinitionNew *	clone () const
	Create a clone of this element definition. More...

	~DtElementDefinitionNew ()
	DTOR. More...

DtElementDefinitionNew *	clone (const DtUnicode &name, DtElementDefinitionNew *newParent) const
	Create a clone of this element definition with a new name and a new parent. More...

void	setName (const DtUnicode &name)
	Set the name of the element definition. More...

void	addChild (DtElementDefinitionNew *child)
	Internal function. More...

void	removeChild (DtElementDefinitionNew *child)
	Internal function. More...

Protected Types
typedef std::vector < DtElementDefinitionNew * >	DefinitionList

typedef std::vector < DtVisualizerDefinitionSet * >	DefinitionSetList

Protected Member Functions
	DtElementDefinitionNew (const DtUnicode &name)
	Create a top level element definition. More...

	DtElementDefinitionNew (const DtUnicode &name, DtElementDefinitionNew *parent)
	Create an element definition which inherits from another definition. More...

Protected Attributes
DtUnicode	myName

std::string	myFileName

DefinitionSetList	mySets

std::vector< std::string >	myDuplicateNames

bool	myIsHier

bool	myDuplicateFlag

DtElementDefinitionNew *	myParent

DefinitionList	myChildren

Private Member Functions
	DtElementDefinitionNew ()
	CTOR. More...

	DtElementDefinitionNew (const DtElementDefinitionNew &copy)
	Copy Constructor Not implemented. More...

DtElementDefinitionNew &	operator= (const DtElementDefinitionNew &)
	Assignment Operator Not implemented. More...

Friends
class	DtElementDefinitionManager
	Use the element definition manager to create, copy and destroy element definitions. More...

Detailed Description

The element definition class contains the element definition information.

The makVrv::DtElementDefinitionManager is responsible for create and destroying instances of the element definitions.

Member Typedef Documentation

typedef std::vector<DtElementDefinitionNew*> makVrv::DtElementDefinitionNew::DefinitionList

protected

typedef std::vector<DtVisualizerDefinitionSet*> makVrv::DtElementDefinitionNew::DefinitionSetList

protected

Constructor & Destructor Documentation

makVrv::DtElementDefinitionNew::DtElementDefinitionNew ( const DtUnicode & name )

protected

Create a top level element definition.

makVrv::DtElementDefinitionNew::DtElementDefinitionNew	(	const DtUnicode &	name,
		DtElementDefinitionNew *	parent
	)

protected

Create an element definition which inherits from another definition.

makVrv::DtElementDefinitionNew::~DtElementDefinitionNew ( )

DTOR.

makVrv::DtElementDefinitionNew::DtElementDefinitionNew ( )

private

CTOR.

makVrv::DtElementDefinitionNew::DtElementDefinitionNew ( const DtElementDefinitionNew & copy )

private

Copy Constructor Not implemented.

Member Function Documentation

const DtUnicode& makVrv::DtElementDefinitionNew::name ( ) const

Get the name of the element definition.

The name of an element is unique.

const std::string& makVrv::DtElementDefinitionNew::fileName ( ) const

Get the file name of the element definition.

Each fileName links to a corresponding file

const std::vector<std::string>& makVrv::DtElementDefinitionNew::duplicateNames ( ) const

Gets the list of all file names saved to show duplicates.

void makVrv::DtElementDefinitionNew::setFileName ( const std::string & )

Assigns the file name to the model definition.

bool makVrv::DtElementDefinitionNew::isEqual ( const DtElementDefinitionNew & ) const

check if two element definitions are equal we don't comapre the parent or children

Returns: true is those two element Definitions are identical

int makVrv::DtElementDefinitionNew::numberOfVisualizerDefinitionSets ( ) const

Get the number of visualizer definition sets the definition has.

DtVisualizerDefinitionSet& makVrv::DtElementDefinitionNew::visualizerDefinitionSet ( int modelSet )

Get the visualizer set for the model set.

If visualizer definition set for the definition does not exist yet one will be created.

const DtVisualizerDefinitionSet& makVrv::DtElementDefinitionNew::visualizerDefinitionSet ( int modelSet ) const

Get the visualizer set for the model set.

If the visualizer definition set does not exist for the model set an exception (DtInvalidInput) will be thrown.

DtElementDefinitionNew* makVrv::DtElementDefinitionNew::findParent ( )

Find the element definition that his inherits from.

Returns: 0 if this is a top level definition.

const DtElementDefinitionNew* makVrv::DtElementDefinitionNew::findParent ( ) const

Find the element definition that his inherits from.

Returns: 0 if this is a top level definition.

unsigned int makVrv::DtElementDefinitionNew::numberOfChildren ( ) const

Get the number of element definitions which inherit from this definition.

DtElementDefinitionNew* makVrv::DtElementDefinitionNew::findChild ( unsigned int index )

Find a child at a given index.

Returns: 0 if the child does not exist at the provided index.

const DtElementDefinitionNew* makVrv::DtElementDefinitionNew::findChild ( unsigned int index ) const

Find a child at a given index.

Returns: 0 if the child does not exist at the provided index.

int makVrv::DtElementDefinitionNew::findChildIndex ( const DtElementDefinitionNew * child ) const

Get the index of a child definition.

The index of the child may change if any children are removed.

Returns: -1 if the definition passed in is not a child.

std::vector<DtElementDefinitionNew*> makVrv::DtElementDefinitionNew::getChildren ( )

Gets the list of children of the element definition.

DtVisualizerDefinition* makVrv::DtElementDefinitionNew::findOrCreateLocalVisualizer	(	int	modelSet,
		int	visualizerIndex
	)

Finds or creates a local visualizer, there must be a visualizer at the visualizerIndex, either a local visualizer or an inherited visualizer.

Returns: 0 if the Visualizer definition index is invalid.

DtVisualizerAttribute* makVrv::DtElementDefinitionNew::findOrCreateLocalAttribute	(	int	modelSet,
		int	visualizerIndex,
		const std::string &	attributeName
	)

Utility function for finding or creating a local visualizer and local attribute.

A local visualizer is owned by this element.

Returns: 0 if the Visualizer definition index is invalid. See findOrCreateLocalVisualizer function.

bool makVrv::DtElementDefinitionNew::isHier ( ) const

Is this element definition a hierarchy node?

void makVrv::DtElementDefinitionNew::setIsHier ( bool isHier )

Set the name of the element definition.

bool makVrv::DtElementDefinitionNew::isDuplicate ( ) const

Whether or not the element definition is in another file as well.

void makVrv::DtElementDefinitionNew::addDuplicateName ( const std::string & duplicateName )

Adds file locations where duplicates of file are found.

void makVrv::DtElementDefinitionNew::setDuplicateFlag ( bool duplicate )

Set whether or not this def is a duplicate.

DtElementDefinitionNew* makVrv::DtElementDefinitionNew::clone ( ) const

Create a clone of this element definition.

DtElementDefinitionNew& makVrv::DtElementDefinitionNew::operator= ( const DtElementDefinitionNew & )

private

Assignment Operator Not implemented.

DtElementDefinitionNew* makVrv::DtElementDefinitionNew::clone	(	const DtUnicode &	name,
		DtElementDefinitionNew *	newParent
	)		const

Create a clone of this element definition with a new name and a new parent.

void makVrv::DtElementDefinitionNew::setName ( const DtUnicode & name )

Set the name of the element definition.

void makVrv::DtElementDefinitionNew::addChild ( DtElementDefinitionNew * child )

Internal function.

void makVrv::DtElementDefinitionNew::removeChild ( DtElementDefinitionNew * child )

Internal function.

Friends And Related Function Documentation

friend class DtElementDefinitionManager

friend

Use the element definition manager to create, copy and destroy element definitions.

Member Data Documentation

DtUnicode makVrv::DtElementDefinitionNew::myName

protected

std::string makVrv::DtElementDefinitionNew::myFileName

protected

DefinitionSetList makVrv::DtElementDefinitionNew::mySets

protected

std::vector<std::string> makVrv::DtElementDefinitionNew::myDuplicateNames

protected

bool makVrv::DtElementDefinitionNew::myIsHier

protected

bool makVrv::DtElementDefinitionNew::myDuplicateFlag

protected

DtElementDefinitionNew* makVrv::DtElementDefinitionNew::myParent

protected

DefinitionList makVrv::DtElementDefinitionNew::myChildren

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvCore/DtElementDefinitionNew.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation