DtVrfEntityIdentifierFactory Class Reference

Public Member Functions
	DtVrfEntityIdentifierFactory (DtVrfObjectManager *)
	CTOR. More...
virtual	~DtVrfEntityIdentifierFactory ()
	DTOR. More...
virtual DtEntityIdentifier	nextId (const DtVrfObject *, const DtEntityIdentifier &base=DtEntityIdentifier::nullId())
	Return the next available identifier. More...
virtual void	startScenarioLoad ()
	Call when about to start loading a scenario. Initializes internal structures for load. More...
virtual void	endScenarioLoad ()
	Call when scenario load is over. More...
virtual void	setAppId (int)
	Accessor for the current app id. More...
int	appId () const
virtual int	setAppIdRangeMax (int upper)
	Returns the max range in case it is lower than the app id or -1. More...
int	appIdRangeMax () const

Protected Member Functions
virtual bool	checkAndChange (int &appId, int &entityNum)
	Checks the entity num and app id to be in a valid range. If not returns false. More...
virtual bool	checkAndChange (DtEntityIdentifier &id)

Protected Attributes
DtVrfObjectManager *	myVrfObjectManager
std::set< DtString >	myUsedIdentifiers
bool	myLoadingScenario
int	myAppId
int	myAppIdRangeMax
std::map< int, int >	myAppIdRanges

Constructor & Destructor Documentation

DtVrfEntityIdentifierFactory::DtVrfEntityIdentifierFactory

(

DtVrfObjectManager *

)

CTOR.

virtual DtVrfEntityIdentifierFactory::~DtVrfEntityIdentifierFactory ( )

virtual

DTOR.

Member Function Documentation

virtual DtEntityIdentifier DtVrfEntityIdentifierFactory::nextId ( const DtVrfObject *  , const DtEntityIdentifier &  base = DtEntityIdentifier::nullId()  )

virtual

Return the next available identifier.

If there is a given identifer and the site/app does not match the current exercise connection site/app, the user will be warned and a new id created

virtual void DtVrfEntityIdentifierFactory::startScenarioLoad ( )

virtual

Call when about to start loading a scenario. Initializes internal structures for load.

virtual void DtVrfEntityIdentifierFactory::endScenarioLoad ( )

virtual

Call when scenario load is over.

Clears out internal structures and sets factory to always create a new identifier regardless of whether or not one is passed in

virtual void DtVrfEntityIdentifierFactory::setAppId ( int  )

virtual

Accessor for the current app id.

int DtVrfEntityIdentifierFactory::appId ( ) const

inline

virtual int DtVrfEntityIdentifierFactory::setAppIdRangeMax ( int  upper )

virtual

Returns the max range in case it is lower than the app id or -1.

int DtVrfEntityIdentifierFactory::appIdRangeMax ( ) const

inline

virtual bool DtVrfEntityIdentifierFactory::checkAndChange ( int &  appId, int &  entityNum  )

protectedvirtual

Checks the entity num and app id to be in a valid range. If not returns false.

virtual bool DtVrfEntityIdentifierFactory::checkAndChange ( DtEntityIdentifier &  id )

protectedvirtual

Member Data Documentation

DtVrfObjectManager* DtVrfEntityIdentifierFactory::myVrfObjectManager

protected

std::set<DtString> DtVrfEntityIdentifierFactory::myUsedIdentifiers

protected

bool DtVrfEntityIdentifierFactory::myLoadingScenario

protected

int DtVrfEntityIdentifierFactory::myAppId

protected

int DtVrfEntityIdentifierFactory::myAppIdRangeMax

protected

std::map<int, int> DtVrfEntityIdentifierFactory::myAppIdRanges

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfobjcore/vrfEntityIdentifierFactory.h