DtSubordinateOrderEntry Class Reference

stl std::list

VR-Link class DtSubordinateOrderEntry

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

Public Types
typedef std::pair< DtString, int >	SubordinateRecord
typedef std::list < SubordinateRecord >	SubordinateList
typedef SubordinateList::iterator	SubordinateIterator
typedef SubordinateList::const_iterator	const_SubordinateIterator

Public Member Functions
	DtSubordinateOrderEntry ()
	DtSubordinateOrderEntry (const DtString &originalName)
virtual	~DtSubordinateOrderEntry ()
	DtSubordinateOrderEntry (const DtSubordinateOrderEntry &orig)
DtSubordinateOrderEntry &	operator= (const DtSubordinateOrderEntry &orig)
virtual void	addSubordinateEntry (const DtString &sObjectNameAlias, int nDesiredDesignator)
virtual void	clear ()
virtual int	computeSubordinateDesignator (const DtString &sObjectNameAlias) const
virtual int	desiredDesignatorFor (const DtString &sObjectNameAlias) const
virtual void	setDesiredDesignatorFor (const DtString &sObjectNameAlias, int num)
virtual const DtString &	originalObjectName () const
virtual void	setOriginalObjectName (const DtString &namePath)
virtual void	removeSubordinateEntry (const DtString &sObjectNameAlias)
virtual unsigned	size () const

Protected Attributes
DtString	myOriginalObjectName
SubordinateList	mySubordinateList

Member Typedef Documentation

typedef std::pair<DtString,int> DtSubordinateOrderEntry::SubordinateRecord

typedef std::list<SubordinateRecord> DtSubordinateOrderEntry::SubordinateList

typedef SubordinateList::iterator DtSubordinateOrderEntry::SubordinateIterator

typedef SubordinateList::const_iterator DtSubordinateOrderEntry::const_SubordinateIterator

Constructor & Destructor Documentation

DtSubordinateOrderEntry::DtSubordinateOrderEntry

(

)

default constructor

DtSubordinateOrderEntry::DtSubordinateOrderEntry

(

const DtString &

originalName

)

alternative constructor Initializes with originalName and scenarioName as indices

virtual DtSubordinateOrderEntry::~DtSubordinateOrderEntry ( )

virtual

destructor

DtSubordinateOrderEntry::DtSubordinateOrderEntry

(

const DtSubordinateOrderEntry &

orig

)

copy constructor

Member Function Documentation

DtSubordinateOrderEntry& DtSubordinateOrderEntry::operator=

(

const DtSubordinateOrderEntry &

orig

)

assignment operator

virtual void DtSubordinateOrderEntry::addSubordinateEntry ( const DtString &  sObjectNameAlias, int  nDesiredDesignator  )

virtual

addSubordinateEntry() Given a unique object name alias, insert the alias into SubordinateList, ahead of any entries that are greater than nDesiredDesignator

virtual void DtSubordinateOrderEntry::clear ( )

virtual

clear() Erase all subordinate entries

virtual int DtSubordinateOrderEntry::computeSubordinateDesignator ( const DtString &  sObjectNameAlias ) const

virtual

computeSubordinateDesignator() Given an object name alias, iterate through SubordinateList, return subordinate index or -1 to indicate error.

virtual int DtSubordinateOrderEntry::desiredDesignatorFor ( const DtString &  sObjectNameAlias ) const

virtual

desiredDesignatorFor() For the subordinate identified by sObjectNameAlias,

virtual void DtSubordinateOrderEntry::setDesiredDesignatorFor ( const DtString &  sObjectNameAlias, int  num  )

virtual

virtual const DtString& DtSubordinateOrderEntry::originalObjectName ( ) const

virtual

originalObjectName() The original object name that identified this item in a scenario.

virtual void DtSubordinateOrderEntry::setOriginalObjectName ( const DtString &  namePath )

virtual

virtual void DtSubordinateOrderEntry::removeSubordinateEntry ( const DtString &  sObjectNameAlias )

virtual

removeSubordinateEntry() Remove the given alias from SubordinateList

virtual unsigned DtSubordinateOrderEntry::size ( ) const

virtual

size() Returns mySubordinateList.size()

Member Data Documentation

DtString DtSubordinateOrderEntry::myOriginalObjectName

protected

SubordinateList DtSubordinateOrderEntry::mySubordinateList

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfutil/subordinateOrderEntry.h