DtObjectNameDeconflictionEntry Class Reference

VR-Link. More...

Public Member Functions
	DtObjectNameDeconflictionEntry ()
	default constructor
	DtObjectNameDeconflictionEntry (const DtString &originalName, const DtString &scenarioName)
	alternative constructor Initializes with originalName and scenarioName as indices
virtual	~DtObjectNameDeconflictionEntry ()
	destructor
	DtObjectNameDeconflictionEntry (const DtObjectNameDeconflictionEntry &orig)
	copy constructor
DtObjectNameDeconflictionEntry &	operator= (const DtObjectNameDeconflictionEntry &orig)
	assignment operator
virtual const DtString &	aliasObjectName () const
	aliasObjectName() A new name for the object, as assigned during the name deconfliction process
virtual void	setAliasObjectName (const DtString &alias)
virtual unsigned	incrementNameCount ()
	incrementNameCount() Used by the deconfliction process to track the number of times a name is used, so that it can append digits to conflicted names during reconciliation.
virtual unsigned	nameCount () const
	nameCount() The number of times that this name is used to define an identity key for scenario objects
virtual void	setNameCount (unsigned num)
virtual bool	hasAliasName () const
	hasAliasName() Checks to see if an object name alias has been assigned to this entry
virtual int	originalDesignator () const
	originalDesignator() Designators are used to indicate an object's position in a subordinate hierarchy.
virtual void	setOriginalDesignator (int num)
virtual const DtString &	originalObjectName () const
	originalObjectName() This is the identity key for a simulated object, as recorded in a scenario file
virtual void	setOriginalObjectName (const DtString &name)
virtual const DtString &	parentName () const
	parentName() This is the original name of the hierarchical parent of this object.
virtual void	setParentName (const DtString &name)
virtual const DtString &	safeObjectName () const
	safeObjectName() If hasAliasName(), returns aliasObjectName(), else returns originalObjectName().
virtual const DtString &	scenarioName () const
	scenarioName() This is the name of the scenario from which the object name originated.
virtual void	setScenarioName (const DtString &name)

Protected Attributes
DtString	myAliasObjectName
unsigned	myNameCount
int	myOriginalDesignator
DtString	myOriginalObjectName
DtString	myParentName
DtString	myScenarioName

Detailed Description

VR-Link.

class DtObjectNameDeconflictionEntry

Instances of DtObjectNameDeconflictionEntry are used during scenario merge to reconcile duplicate VRF object names.

Constructor & Destructor Documentation

DtObjectNameDeconflictionEntry::DtObjectNameDeconflictionEntry

(

)

default constructor

DtObjectNameDeconflictionEntry::DtObjectNameDeconflictionEntry	(	const DtString &	originalName,
		const DtString &	scenarioName
	)

alternative constructor Initializes with originalName and scenarioName as indices

virtual DtObjectNameDeconflictionEntry::~DtObjectNameDeconflictionEntry ( )

virtual

destructor

DtObjectNameDeconflictionEntry::DtObjectNameDeconflictionEntry

(

const DtObjectNameDeconflictionEntry &

orig

)

copy constructor

Member Function Documentation

DtObjectNameDeconflictionEntry& DtObjectNameDeconflictionEntry::operator=

(

const DtObjectNameDeconflictionEntry &

orig

)

assignment operator

virtual const DtString& DtObjectNameDeconflictionEntry::aliasObjectName ( ) const

virtual

aliasObjectName() A new name for the object, as assigned during the name deconfliction process

virtual void DtObjectNameDeconflictionEntry::setAliasObjectName ( const DtString &  alias )

virtual

virtual unsigned DtObjectNameDeconflictionEntry::incrementNameCount ( )

virtual

incrementNameCount() Used by the deconfliction process to track the number of times a name is used, so that it can append digits to conflicted names during reconciliation.

virtual unsigned DtObjectNameDeconflictionEntry::nameCount ( ) const

virtual

nameCount() The number of times that this name is used to define an identity key for scenario objects

virtual void DtObjectNameDeconflictionEntry::setNameCount ( unsigned  num )

virtual

virtual bool DtObjectNameDeconflictionEntry::hasAliasName ( ) const

virtual

hasAliasName() Checks to see if an object name alias has been assigned to this entry

virtual int DtObjectNameDeconflictionEntry::originalDesignator ( ) const

virtual

originalDesignator() Designators are used to indicate an object's position in a subordinate hierarchy.

The original designator for an object is retained during the deconfliction process, to sort subordinates properly when merging hierarchies

virtual void DtObjectNameDeconflictionEntry::setOriginalDesignator ( int  num )

virtual

virtual const DtString& DtObjectNameDeconflictionEntry::originalObjectName ( ) const

virtual

originalObjectName() This is the identity key for a simulated object, as recorded in a scenario file

virtual void DtObjectNameDeconflictionEntry::setOriginalObjectName ( const DtString &  name )

virtual

virtual const DtString& DtObjectNameDeconflictionEntry::parentName ( ) const

virtual

parentName() This is the original name of the hierarchical parent of this object.

virtual void DtObjectNameDeconflictionEntry::setParentName ( const DtString &  name )

virtual

virtual const DtString& DtObjectNameDeconflictionEntry::safeObjectName ( ) const

virtual

safeObjectName() If hasAliasName(), returns aliasObjectName(), else returns originalObjectName().

This is a convenience function for retrieving deconflicted names, once the deconfliction process is complete

virtual const DtString& DtObjectNameDeconflictionEntry::scenarioName ( ) const

virtual

scenarioName() This is the name of the scenario from which the object name originated.

Used as a key to distinguish between objects with the same name, e.g. scenario1.object1 vs. scenario2.object1

virtual void DtObjectNameDeconflictionEntry::setScenarioName ( const DtString &  name )

virtual

Member Data Documentation

DtString DtObjectNameDeconflictionEntry::myAliasObjectName

protected

unsigned DtObjectNameDeconflictionEntry::myNameCount

protected

int DtObjectNameDeconflictionEntry::myOriginalDesignator

protected

DtString DtObjectNameDeconflictionEntry::myOriginalObjectName

protected

DtString DtObjectNameDeconflictionEntry::myParentName

protected

DtString DtObjectNameDeconflictionEntry::myScenarioName

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/objectNameDeconflictionEntry.h