DtVrfProcessStateRepository Class Reference

Class DtVrfProcessStateRepository: Abstract base class for all process state repositories. More...

Inherits DtReaderWriter.

Inherited by BHAVE::DtKynapsePSR, BHAVE::DtSpawnControllerPSR, DtAggregatedMoveAlongPSR, DtAggregatedMoveToPSR, DtAggregatedPatrolPSR, DtAggregatedResolutionPSR, DtAggregateMoveAlongPSR, DtAggregateMoveToLocationPSR, DtAggregateMoveToPSR, DtAggregatePatrolAlongPSR, DtAggregatePatrolBetweenPSR, DtAutomotivePSR, DtBaseWeaponComponentInterface, DtBombPSR, DtComponentSystemPSR, DtConvoyPSR, DtCruiseMissileLaunchControllerPSR, DtDIGuyControllerPSR, DtEmitterPSR, DtFixedWingFlightPSR, DtFormationPSR, DtGroundMovementChooserPSR, DtHumanCollisionAvoidancePSR, DtHumanFollowPSR, DtHumanMoveAlongPSR, DtHumanMoveToPSR, DtHumanPatrolPSR, DtHumanPosturePSR, DtIndirectArtilleryPSR, DtIndirectFireControllerPSR, DtLaserDetectorPSR, DtLaserLauncherPSR, DtLaserTrackerPSR, DtLasingPSR, DtLaunchExpendableResourcePSR, DtLaunchSmokePSR, DtLimitExistencePSR, DtLocalEntitySetControllerPSR, DtMissileDistractionPSR, DtMissileFlightPSR, DtMissileTargetControllerPSR, DtMultipleHitDamagePSR, DtObjectSensorPSR, DtObstructionSensorPSR, DtPseudoAggregateMovementPSR, DtRailMovementControllerPSR, DtRailPathControllerPSR, DtRotaryWingFlightPSR, DtScriptedMovementControllerPSR, DtScriptMultiTaskControllerPSR, DtScriptReactiveTaskControllerPSR, DtSimpleProximitySensorPSR, DtSpotReportGeneratorControllerPSR, DtSurfaceMovementPSR, DtSwingingPartActuatorPSR, DtSwitchSystemComponentPSR, DtTargetSelectionControllerPSR, DtTimeKeeperPSR, DtTranslatablePartActuatorPSR, DtVrfEmbarkationPSR, DtVrfFixedWingLandingPSR, DtVrfFixedWingTakeoffPSR, DtVrfIffPSR, DtVrfOccupancyDirectorPSR, DtVrfWeaponPSR, DtWaitingPSR, and DtWarheadDetonationActuatorPSR.

Public Member Functions
	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 DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const =0
virtual bool	init ()
	Used for virtual construction. This base method simply returns true.
virtual DtString	type () const =0
	Returns the string type of the repository, as defined in procSRTypes.h.
virtual bool	loadedFromMTL () const
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
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
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
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 void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
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 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.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()

Protected Member Functions
	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
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.

Static Protected Attributes
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

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
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()

Detailed Description

Class DtVrfProcessStateRepository: Abstract base class for all process state repositories.

Process state repositories represent (potentially) shared, savable information for one or more components functioning together to achieve some process or set of processes; such as aiming and firing a weapon; moving an object; or just waiting a specified amount of time.

Each DtVrfObjectStateRepository maintains a list of the process states used by that object (via a DtVrfProcessStateRepositoryManager), and all the components that use the process state rep maintain pointers to it. Eventually, the proposed sub-system mechanism will be used to create and delete these process state repositories, but for now, one of the components participating in the process (typically an actuator if one exists) will create and delete these repositories.

Related examples

• Time Keeper PSR
• Subtasking Example

Constructor & Destructor Documentation

DtVrfProcessStateRepository::DtVrfProcessStateRepository ( )

protected

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

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

virtual DtVrfProcessStateRepository::~DtVrfProcessStateRepository ( )

virtual

Member Function Documentation

const DtVrfProcessStateRepository& DtVrfProcessStateRepository::operator=

(

const DtVrfProcessStateRepository &

orig

)

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

pure virtual

Implemented in DtPseudoAggregateMovementPSR, DtSurfaceMovementPSR, DtVrfEmbarkationPSR, DtVrfBalGunPSR, DtLaserDetectorPSR, DtLaserTrackerPSR, DtLaserLauncherPSR, DtRailMovementControllerPSR, DtBaseWeaponComponentInterface, DtAutomotivePSR, DtMissileFlightPSR, DtAggregateMoveAlongPSR, DtRotaryWingFlightPSR, DtVrfFixedWingLandingPSR, DtFixedWingFlightPSR, DtVrfWeaponPSR, DtWaitingPSR, BHAVE::DtKynapsePSR, DtConvoyPSR, DtVrfFixedWingTakeoffPSR, DtLasingPSR, DtTranslatablePartActuatorPSR, DtAggregatedResolutionPSR, DtBombPSR, DtHumanCollisionAvoidancePSR, DtVrfOccupancyDirectorPSR, DtScriptReactiveTaskControllerPSR, DtAggregatedMoveAlongPSR, DtAggregatedMoveToPSR, DtDIGuyControllerPSR, DtHumanMoveAlongPSR, DtHumanMoveToPSR, DtIndirectWeaponComponentInterface, DtVrfIndirectFirePSR, DtObjectSensorPSR, BHAVE::DtSpawnControllerPSR, DtComponentSystemPSR, DtCruiseMissileLaunchControllerPSR, DtFormationPSR, DtVrfTurretedBalGunPSR, DtAggregateMoveToPSR, DtMissileDistractionPSR, DtSimpleProximitySensorPSR, DtSwingingPartActuatorPSR, DtWarheadDetonationActuatorPSR, DtHumanFollowPSR, DtIndirectArtilleryPSR, DtLocalEntitySetControllerPSR, DtWeaponComponentInterface, DtEmitterPSR, DtVrfIffPSR, DtLaunchExpendableResourcePSR, DtObstructionSensorPSR, DtRailPathControllerPSR, DtAggregateMoveToLocationPSR, DtAggregatePatrolAlongPSR, DtAggregatePatrolBetweenPSR, DtHumanPatrolPSR, DtHumanPosturePSR, DtMultipleHitDamagePSR, DtTimeKeeperPSR, DtGroundMovementChooserPSR, DtActiveSonarSensorPSR, DtAggregatedPatrolPSR, DtRadarObjectSensorPSR, DtSwitchSystemComponentPSR, DtTargetSelectionControllerPSR, DtLimitExistencePSR, DtScriptedMovementControllerPSR, DtLaunchSmokePSR, DtRotaryWingFlightCommandControllerPSR, DtSpotReportGeneratorControllerPSR, DtPassiveSonarSensorPSR, DtScriptMultiTaskControllerPSR, DtIndirectFireControllerPSR, and DtMissileTargetControllerPSR.

virtual bool DtVrfProcessStateRepository::init ( )

virtual

Used for virtual construction. This base method simply returns true.

Reimplemented in DtVrfOccupancyDirectorPSR, DtObjectSensorPSR, DtMissileDistractionPSR, and DtObstructionSensorPSR.

virtual DtString DtVrfProcessStateRepository::type ( ) const

pure virtual

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

Implemented in DtPseudoAggregateMovementPSR, DtSurfaceMovementPSR, DtVrfEmbarkationPSR, DtVrfTurretedBalGunPSR, DtVrfBalGunPSR, DtLaserDetectorPSR, DtLaserTrackerPSR, DtRailMovementControllerPSR, DtLaserLauncherPSR, DtAutomotivePSR, DtMissileFlightPSR, DtAggregateMoveAlongPSR, DtRotaryWingFlightPSR, DtVrfFixedWingLandingPSR, DtFixedWingFlightPSR, DtWaitingPSR, DtVrfWeaponPSR, DtConvoyPSR, DtVrfFixedWingTakeoffPSR, BHAVE::DtKynapsePSR, DtLasingPSR, DtAggregatedResolutionPSR, DtBombPSR, DtHumanCollisionAvoidancePSR, DtVrfOccupancyDirectorPSR, DtScriptReactiveTaskControllerPSR, DtTranslatablePartActuatorPSR, DtAggregatedMoveAlongPSR, DtAggregatedMoveToPSR, DtHumanMoveAlongPSR, DtHumanMoveToPSR, DtDIGuyControllerPSR, DtIndirectWeaponComponentInterface, DtFormationPSR, DtVrfIndirectFirePSR, DtObjectSensorPSR, BHAVE::DtSpawnControllerPSR, DtAggregateMoveToPSR, DtComponentSystemPSR, DtCruiseMissileLaunchControllerPSR, DtSimpleProximitySensorPSR, DtHumanFollowPSR, DtLocalEntitySetControllerPSR, DtMissileDistractionPSR, DtObstructionSensorPSR, DtSwingingPartActuatorPSR, DtWarheadDetonationActuatorPSR, DtAggregateMoveToLocationPSR, DtEmitterPSR, DtVrfIffPSR, DtIndirectArtilleryPSR, DtWeaponComponentInterface, DtAggregatePatrolAlongPSR, DtAggregatePatrolBetweenPSR, DtHumanPatrolPSR, DtHumanPosturePSR, DtLaunchExpendableResourcePSR, DtRailPathControllerPSR, DtMultipleHitDamagePSR, DtTimeKeeperPSR, DtAggregatedPatrolPSR, DtGroundMovementChooserPSR, DtActiveSonarSensorPSR, DtRadarObjectSensorPSR, DtSwitchSystemComponentPSR, DtScriptMultiTaskControllerPSR, DtTargetSelectionControllerPSR, DtLimitExistencePSR, DtLaunchSmokePSR, DtRotaryWingFlightCommandControllerPSR, DtScriptedMovementControllerPSR, DtPassiveSonarSensorPSR, DtSpotReportGeneratorControllerPSR, DtIndirectFireControllerPSR, and DtMissileTargetControllerPSR.

virtual bool DtVrfProcessStateRepository::loadedFromMTL ( ) const

virtual

virtual void DtVrfProcessStateRepository::getSelf ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

virtual

Reimplemented in DtAggregateMoveAlongPSR, DtPseudoAggregateMovementPSR, BHAVE::DtKynapsePSR, DtObjectSensorPSR, DtMissileDistractionPSR, DtVrfOccupancyDirectorPSR, DtAggregateMoveToPSR, DtAggregatedResolutionPSR, DtMissileTargetControllerPSR, DtScriptedMovementControllerPSR, DtScriptReactiveTaskControllerPSR, and DtScriptMultiTaskControllerPSR.

static DtVrfProcessStateRepositoryFactory* DtVrfProcessStateRepository::factory ( )

static

a DtVrfProcessStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set.

The DtSimCreator deletes this pointer when it is deleted. This is done this way because we don't allow static initialization

Reimplemented from DtReaderWriter.

static void DtVrfProcessStateRepository::setFactory ( DtVrfProcessStateRepositoryFactory *  factory )

static

static void DtVrfProcessStateRepository::addVrfProcessStateRepositoryCreatorFcn ( const DtString &  type, DtVrfProcessStateRepositoryCreatorFcn  fcn  )

static

static DtVrfProcessStateRepository* DtVrfProcessStateRepository::createRepository ( const DtString &  name, const DtString &  type, DtVrfObject *  vrfObject, DtReaderWriterRegistry *  parentRegistry = 0  )

static

Creates a new state repository object, using the factory.

Member Data Documentation

DtVrfObject* DtVrfProcessStateRepository::myVrfObject

protected

bool DtVrfProcessStateRepository::myLoadedFromMTL

protected

DtVrfProcessStateRepositoryFactory* DtVrfProcessStateRepository::theFactory

staticprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/processSR.h