class DtVrfOccupancyDirectorPSR: More...

Inheritance diagram for DtVrfOccupancyDirectorPSR:

Public Member Functions
	DtVrfOccupancyDirectorPSR (DtVrfObject vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)
	constructor
	DtVrfOccupancyDirectorPSR (const DtVrfOccupancyDirectorPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtVrfOccupancyDirectorPSR ()
	destructor
DtVrfOccupancyDirectorPSR &	operator= (const DtVrfOccupancyDirectorPSR &orig)
	assignment operator
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	returns a newly created copy of this object
virtual DtString	type () const
	Returns the string type of the repository, as defined in procSRTypes.h.
DtEmbarkationSlotManager *	embarkationSlotManager ()
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Override to put contents of myCurrentlyDisembarkingObjectNames into mySerializableCurrentlyDisembarkingObjectNames, to put it in a writeable form.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Override to put contents of mySerializableCurrentlyDisembarkingObjectNames into myCurrentlyDisembarkingObjectNames.

virtual DtString	disembarkingObjectName () const
	The name of the object currently disembarking when a disembark-all task is being performed.
virtual void	setDisembarkingObjectName (const DtString &name)
	The name of the object currently disembarking when a disembark-all task is being performed.

virtual void	addDisembarkingObjectName (const DtString &objectName)
	The list of the disembarking objects when a disembark-all task is being performed.
virtual void	removeDisembarkingObjectName (const DtString &objectName)
	The list of the disembarking objects when a disembark-all task is being performed.
virtual void	clearDisembarkingObjectNames ()
	The list of the disembarking objects when a disembark-all task is being performed.
virtual bool	disembarkingObjectNamesEmpty () const
	The list of the disembarking objects when a disembark-all task is being performed.
virtual const std::set < DtString > &	disembarkingObjectNames () const
	The list of the disembarking objects when a disembark-all task is being performed.
virtual bool	disembarkedObjectNameInList (const DtString &objectName) const
	The list of the disembarking objects when a disembark-all task is being performed.
Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtVrfObject 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	loadedFromMTL () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject vrfObject, DtReaderWriterRegistry parentRegistry)
	Returns a newly created instance of this class.
Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()
	a DtVrfProcessStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set.
static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtVrfObject vrfObject, DtReaderWriterRegistry parentRegistry=0)
	Creates a new state repository object, using the factory.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.

Protected Member Functions
virtual bool	init ()
	Used for virtual construction. This base method simply returns true.
virtual void	createEmbarkationSlotManager ()
	Override to create your own type of slot manager and set it to mySlotManager variable.
virtual void	copyCurrentlyDisembarkingObjectNames (const DtRwStringList &other)
	Copy the saved list of objects to be disembarked.
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
DtEmbarkationSlotManager *	mySlotManager
DtRwString	myDisembarkingObjectName
	The name of the object currently disembarking, when a disembark-all task is being performed.
std::set< DtString >	myCurrentlyDisembarkingObjectNames
	Set of currently objects to be disembarked when a disembark-all task is being performed.
DtRwStringList	mySerializableCurrentlyDisembarkingObjectNames
	Readable writeable list of currently objects to be disembarked.
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	myVrfObject
bool	myLoadedFromMTL
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Additional Inherited Members
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::pair < DtSymbolString, DtString >	DtVariableNameType
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Detailed Description

class DtVrfOccupancyDirectorPSR:

Instances of DtVrfOccupancyDirectorPSR are used to hold the shared/checkpointable data for an occupancy data for items that are to be embarked.

Constructor & Destructor Documentation

DtVrfOccupancyDirectorPSR::DtVrfOccupancyDirectorPSR	(	DtVrfObject *	vrfObject,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

constructor

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

copy constructor

virtual DtVrfOccupancyDirectorPSR::~DtVrfOccupancyDirectorPSR ( )

virtual

destructor

Member Function Documentation

DtVrfOccupancyDirectorPSR& DtVrfOccupancyDirectorPSR::operator= ( const DtVrfOccupancyDirectorPSR & orig )

assignment operator

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

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtVrfOccupancyDirectorPSR::type ( ) const

virtual

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

(DtVrfAutomotiveProcessStateRepositoryType).

Implements DtVrfProcessStateRepository.

DtEmbarkationSlotManager * DtVrfOccupancyDirectorPSR::embarkationSlotManager ( )

inline

References createEmbarkationSlotManager(), and mySlotManager.

virtual DtString DtVrfOccupancyDirectorPSR::disembarkingObjectName ( ) const

virtual

The name of the object currently disembarking when a disembark-all task is being performed.

virtual void DtVrfOccupancyDirectorPSR::setDisembarkingObjectName ( const DtString & name )

virtual

The name of the object currently disembarking when a disembark-all task is being performed.

virtual void DtVrfOccupancyDirectorPSR::addDisembarkingObjectName ( const DtString & objectName )

virtual