DtSubordinateOrderEntry Class Reference

stl std::list More...

List of all members.

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 ()
	default constructor
	DtSubordinateOrderEntry (const DtString &originalName)
	alternative constructor Initializes with originalName and scenarioName as indices
virtual	~DtSubordinateOrderEntry ()
	destructor
	DtSubordinateOrderEntry (const DtSubordinateOrderEntry &orig)
	copy constructor
DtSubordinateOrderEntry &	operator= (const DtSubordinateOrderEntry &orig)
	assignment operator
virtual void	addSubordinateEntry (const DtString &sObjectNameAlias, int nDesiredDesignator)
	addSubordinateEntry() Given a unique object name alias, insert the alias into SubordinateList, ahead of any entries that are greater than nDesiredDesignator
virtual void	clear ()
	clear() Erase all subordinate entries
virtual int	computeSubordinateDesignator (const DtString &sObjectNameAlias) const
	computeSubordinateDesignator() Given an object name alias, iterate through SubordinateList, return subordinate index or -1 to indicate error.
virtual int	desiredDesignatorFor (const DtString &sObjectNameAlias) const
	desiredDesignatorFor() For the subordinate identified by sObjectNameAlias,
virtual void	setDesiredDesignatorFor (const DtString &sObjectNameAlias, int num)
virtual const DtString &	originalObjectName () const
	originalObjectName() The original object name that identified this item in a scenario.
virtual void	setOriginalObjectName (const DtString &namePath)
virtual void	removeSubordinateEntry (const DtString &sObjectNameAlias)
	removeSubordinateEntry() Remove the given alias from SubordinateList
virtual unsigned	size () const
	size() Returns mySubordinateList.size()
Protected Attributes
DtString	myOriginalObjectName
SubordinateList	mySubordinateList

---

Detailed Description

stl std::list

VR-Link class DtSubordinateOrderEntry

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

---

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:

• include/vrfutil/subordinateOrderEntry.h