DtShipClutterAreaPSR Class Reference

Instances of DtShipClutterAreaPSR are used to hold the checkpointable state data for the DtShipClutterAreaController class.

Inheritance diagram for DtShipClutterAreaPSR:

Public Types
typedef std::map< DtRwInt, DtRwUUID >	TrackIdUuidMap
typedef std::map< DtRwUUID, DtRwInt >	UuidTrackIdMap
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()

Public Member Functions
	DtShipClutterAreaPSR (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtShipClutterAreaPSR (const DtShipClutterAreaPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtShipClutterAreaPSR ()
DtShipClutterAreaPSR &	operator= (const DtShipClutterAreaPSR &orig)
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const override
virtual void	postGetSelf () override
virtual DtString	type () const override
virtual void	addClutterEntity (int trackId, const DtUUID &entity)
virtual void	removeClutterEntity (int trackId)
virtual void	clearClutterEntities ()
virtual const TrackIdUuidMap &	clutterEntities () const
virtual int	trackId (const DtUUID &entity) const
virtual DtUUID	entityUuid (int trackId) const
virtual void	addPromotedEntity (int trackId, const DtUUID &entity)
virtual void	removePromotedEntity (int trackId)
virtual void	clearPromotedEntities ()
virtual const TrackIdUuidMap &	promotedEntites () const
virtual double	nextCheckTime () const
virtual void	setNextCheckTime (double t)
virtual double	nextRequestTime () const
virtual void	setNextRequestTime (double t)
virtual unsigned	maxNumberOfEntities () const
virtual void	setMaxNumberOfEntities (unsigned n)
virtual bool	maxNumberOfEntitiesSpecified () const
Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfProcessStateRepository &	operator= (const DtVrfProcessStateRepository &orig)
virtual	~DtVrfProcessStateRepository ()
virtual bool	init ()
virtual bool	loadedFromMTL () const
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs) const
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtLocalObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()
static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtLocalObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Attributes
DtRwReal	myNextCheckTime
DtRwReal	myNextRequestTime
DtRwInt	myMaxNumberOfEntities
DtRwTemplatedMapPtr< DtRwInt, DtRwUUID >	myClutterEntities
DtRwTemplatedMapPtr< DtRwInt, DtRwUUID >	myPromotedEntities
UuidTrackIdMap	myTracksByUuid
Protected Attributes inherited from DtVrfProcessStateRepository
DtLocalObject *	myVrfObject
bool	myLoadedFromMTL
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
bool	myInvalid
bool	myChangedFlag

Additional Inherited Members
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
const DtSimObject *	vrfObject () const
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Member Typedef Documentation

typedef std::map<DtRwInt, DtRwUUID> DtShipClutterAreaPSR::TrackIdUuidMap

typedef std::map<DtRwUUID, DtRwInt> DtShipClutterAreaPSR::UuidTrackIdMap

Constructor & Destructor Documentation

DtShipClutterAreaPSR::DtShipClutterAreaPSR	(	DtLocalObject *	vrfObject,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtShipClutterAreaPSR::DtShipClutterAreaPSR	(	const DtShipClutterAreaPSR &	orig,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtShipClutterAreaPSR::~DtShipClutterAreaPSR ( )

virtual

destructor

Member Function Documentation

DtShipClutterAreaPSR& DtShipClutterAreaPSR::operator=

(

const DtShipClutterAreaPSR &

orig

)

assignment operator

virtual DtVrfProcessStateRepository* DtShipClutterAreaPSR::clone ( const DtString &  rwName = DtString::nullString(), DtReaderWriterRegistry *  parentRegistry = 0  ) const

overridevirtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual void DtShipClutterAreaPSR::postGetSelf ( )

overridevirtual

Constructs myTracksByUuid from the loaded myClutterEntities.

Reimplemented from DtReaderWriter.

virtual DtString DtShipClutterAreaPSR::type ( ) const

overridevirtual

Returns the string type of the repository, as defined in procSRTypes.h.

Implements DtVrfProcessStateRepository.

virtual void DtShipClutterAreaPSR::addClutterEntity ( int  trackId, const DtUUID &  entity  )

virtual

Adds to the list of clutter entities managed by the controller.

virtual void DtShipClutterAreaPSR::removeClutterEntity ( int  trackId )

virtual

Removes from the list of clutter entities managed by the controller.

virtual void DtShipClutterAreaPSR::clearClutterEntities ( )

virtual

Clears the list of clutter entities managed by the controller.

virtual const TrackIdUuidMap& DtShipClutterAreaPSR::clutterEntities ( ) const

virtual

Returns the list of clutter entities managed by the controller.

virtual int DtShipClutterAreaPSR::trackId ( const DtUUID &  entity ) const

virtual

Returns the track ID for the entity with the given UUID, or -1 if it doesn't exist.

virtual DtUUID DtShipClutterAreaPSR::entityUuid ( int  trackId ) const

virtual

Returns the entity UUID for the track with the given ID, or a null UUID if it doesn't exist.

virtual void DtShipClutterAreaPSR::addPromotedEntity ( int  trackId, const DtUUID &  entity  )

virtual

Adds to the list of promoted entities which used to be managed by the controller.

virtual void DtShipClutterAreaPSR::removePromotedEntity ( int  trackId )

virtual

Removes from the list of promoted entities which used to be managed by the controller.

virtual void DtShipClutterAreaPSR::clearPromotedEntities ( )

virtual

Clears the list of promoted entities which used to be managed by the controller.

virtual const TrackIdUuidMap& DtShipClutterAreaPSR::promotedEntites ( ) const

virtual

Returns the list of promoted entities that used to be managed by the controller.

virtual double DtShipClutterAreaPSR::nextCheckTime ( ) const

virtual

Returns the next time the controller will check for ships entering and exiting the area.

virtual void DtShipClutterAreaPSR::setNextCheckTime ( double  t )

virtual

Sets the next time the controller will check for ships entering and exiting the area.

virtual double DtShipClutterAreaPSR::nextRequestTime ( ) const

virtual

Returns the next time the controller will make a request.

virtual void DtShipClutterAreaPSR::setNextRequestTime ( double  t )

virtual

Sets the next time the controller will make a request.

virtual unsigned DtShipClutterAreaPSR::maxNumberOfEntities ( ) const

virtual

Returns the maximum number of entities this area can manage at a time.

virtual void DtShipClutterAreaPSR::setMaxNumberOfEntities ( unsigned  n )

virtual

Sets the maximum number of entities this area can manage at a time.

virtual bool DtShipClutterAreaPSR::maxNumberOfEntitiesSpecified ( ) const

virtual

Returns true if the maximum number of entities was specified.

static DtVrfProcessStateRepository* DtShipClutterAreaPSR::creator ( const DtString &  rwName, DtLocalObject *  vrfObject, DtReaderWriterRegistry *  parentRegistry  )

static

Returns a newly created instance of this class.

Member Data Documentation

DtRwReal DtShipClutterAreaPSR::myNextCheckTime

protected

DtRwReal DtShipClutterAreaPSR::myNextRequestTime

protected

DtRwInt DtShipClutterAreaPSR::myMaxNumberOfEntities

protected

DtRwTemplatedMapPtr<DtRwInt, DtRwUUID> DtShipClutterAreaPSR::myClutterEntities

protected

DtRwTemplatedMapPtr<DtRwInt, DtRwUUID> DtShipClutterAreaPSR::myPromotedEntities

protected

UuidTrackIdMap DtShipClutterAreaPSR::myTracksByUuid

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjcore/shipClutterAreaPSR.h