DtScriptMultiTaskControllerPSR Class Reference

Process State Repository for the DtRotaryWingFlightCommandController component. More...

Inheritance diagram for DtScriptMultiTaskControllerPSR:

Public Member Functions
	DtScriptMultiTaskControllerPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtScriptMultiTaskControllerPSR (const DtScriptMultiTaskControllerPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtScriptMultiTaskControllerPSR &	operator= (const DtScriptMultiTaskControllerPSR &orig)
virtual	~DtScriptMultiTaskControllerPSR ()
virtual DtScriptMultiTaskControllerPSR *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
virtual void	putSelf (FILE *, int, bool, const DtFilename &)
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual DtString	type () const
	Returns the string type of the repository, as defined in procSRTypes.h.
virtual void	addEntry (int tid, DtReaderWriter *entry, bool overwrite=true)
	Adds the entry to the PSR.
virtual void	removeEntry (int tid)
virtual const DtReaderWriter *	findEntry (int tid)
virtual void	clearEntries ()
virtual void	setCallback (DtScriptPSRScenarioSaveFcn callback, void *usr)
virtual void	removeScriptInformation (const DtString &)
	Removes any information associated with the script.
virtual void	setScriptTickPeriod (const DtString &scriptId, double d, double curScenarioTime)
	Schedule to tick the particular script at the current tick rate.
virtual double	scriptTickPeriod (const DtString &scriptId) const
	Returns the tick period for the script.
virtual bool	timeToExecuteScript (const DtString &, double curSimTime)
	Returns true if it is time to execute the provided script id.
virtual double	nextTimeToExecuteScript (const DtString &, double curTime) const
	Returns the next time to execute the script, given a script id and the current time.
virtual void	setNextTimeToExecuteScript (const DtString &scriptId, double time)
	Set the next time to execute the script.
virtual void	setScriptBackgroundProcessId (const DtString &scriptId, int id)
	For background process scripts, sets the background process id.
virtual int	scriptBackgroundProcessId (const DtString &scriptId) const
	For background process scripts, returns the background process id.
virtual DtRwUserQuestionHandler &	userQuestionHandler ()
	User question handler access.
virtual const DtRwUserQuestionHandler &	userQuestionHandler () const
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	init ()
	Used for virtual construction. This base method simply returns true.
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
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	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
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 void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
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.
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Creates a new state repository object, using the factory.
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 char *	theXmlType ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Protected Types
typedef void(*	DtScriptPSRScenarioSaveFcn )(void *)
typedef DtRwTemplatedListPtr < DtRwScriptInformation, true >	ScriptInformation
typedef std::map< DtString, DtRwScriptInformation >	MapScriptInformation

Protected Attributes
DtRwVariableBindings	myEntries
ScriptInformation	myScriptInformation
MapScriptInformation	myMapScriptInformation
DtScriptPSRScenarioSaveFcn	mySaveCallback
void *	myCallbackObject
DtRwUserQuestionHandler	myUserQuestionHandler
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	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
	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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Detailed Description

Process State Repository for the DtRotaryWingFlightCommandController component.

Member Typedef Documentation

typedef void(* DtScriptMultiTaskControllerPSR::DtScriptPSRScenarioSaveFcn)(void *)

protected

typedef DtRwTemplatedListPtr<DtRwScriptInformation, true> DtScriptMultiTaskControllerPSR::ScriptInformation

protected

typedef std::map<DtString, DtRwScriptInformation> DtScriptMultiTaskControllerPSR::MapScriptInformation

protected

Constructor & Destructor Documentation

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

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

virtual DtScriptMultiTaskControllerPSR::~DtScriptMultiTaskControllerPSR ( )

virtual

Member Function Documentation

const DtScriptMultiTaskControllerPSR& DtScriptMultiTaskControllerPSR::operator=

(

const DtScriptMultiTaskControllerPSR &

orig

)

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

virtual

Implements DtVrfProcessStateRepository.

virtual void DtScriptMultiTaskControllerPSR::putSelf ( FILE *  fp, int  indentLevel, bool  writeUnspecified, const DtFilename &  path  )

virtual

Top level call to write itself to file.

If write unspecified is true, will write entries that are unspecified, in the format (name <use-default>). Path is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the path is specified with a non-NULL string, then the path prepended to the filename before writing the entry to file.

Reimplemented from DtReaderWriter.

virtual void DtScriptMultiTaskControllerPSR::getSelf ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

virtual

Reimplemented from DtVrfProcessStateRepository.

virtual DtString DtScriptMultiTaskControllerPSR::type ( ) const

virtual

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

Implements DtVrfProcessStateRepository.

virtual void DtScriptMultiTaskControllerPSR::addEntry ( int  tid, DtReaderWriter *  entry, bool  overwrite = true  )

virtual

Adds the entry to the PSR.

However, if the entry exists, it will remove the old entry first and replace it with the new entry unless the second argument is false, in which case it will simply leave the old entry there if it exists.

virtual void DtScriptMultiTaskControllerPSR::removeEntry ( int  tid )

virtual

virtual const DtReaderWriter* DtScriptMultiTaskControllerPSR::findEntry ( int  tid )

virtual

virtual void DtScriptMultiTaskControllerPSR::clearEntries ( )

virtual

virtual void DtScriptMultiTaskControllerPSR::setCallback ( DtScriptPSRScenarioSaveFcn  callback, void *  usr  )

virtual

virtual void DtScriptMultiTaskControllerPSR::removeScriptInformation ( const DtString &  )

virtual

Removes any information associated with the script.

virtual void DtScriptMultiTaskControllerPSR::setScriptTickPeriod ( const DtString &  scriptId, double  d, double  curScenarioTime  )

virtual

Schedule to tick the particular script at the current tick rate.

The next tick period will be the tick period given plus a variance of the amount of time given capped at 1 second. This will prevent all scripts from being ticked at once. Default tick period is 1/2 second

virtual double DtScriptMultiTaskControllerPSR::scriptTickPeriod ( const DtString &  scriptId ) const

virtual

Returns the tick period for the script.

virtual bool DtScriptMultiTaskControllerPSR::timeToExecuteScript ( const DtString &  , double  curSimTime  )

virtual

Returns true if it is time to execute the provided script id.

virtual double DtScriptMultiTaskControllerPSR::nextTimeToExecuteScript ( const DtString &  , double  curTime  ) const

virtual

Returns the next time to execute the script, given a script id and the current time.

virtual void DtScriptMultiTaskControllerPSR::setNextTimeToExecuteScript ( const DtString &  scriptId, double  time  )

virtual

Set the next time to execute the script.

virtual void DtScriptMultiTaskControllerPSR::setScriptBackgroundProcessId ( const DtString &  scriptId, int  id  )

virtual

For background process scripts, sets the background process id.

virtual int DtScriptMultiTaskControllerPSR::scriptBackgroundProcessId ( const DtString &  scriptId ) const

virtual

For background process scripts, returns the background process id.

static DtVrfProcessStateRepository* DtScriptMultiTaskControllerPSR::creator ( const DtString &  rwName, DtVrfObject *  vrfObject, DtReaderWriterRegistry *  parentRegistry  )

static

Creates a new state repository object, using the factory.

virtual DtRwUserQuestionHandler& DtScriptMultiTaskControllerPSR::userQuestionHandler ( )

virtual

User question handler access.

virtual const DtRwUserQuestionHandler& DtScriptMultiTaskControllerPSR::userQuestionHandler ( ) const

virtual

Member Data Documentation

DtRwVariableBindings DtScriptMultiTaskControllerPSR::myEntries

protected

ScriptInformation DtScriptMultiTaskControllerPSR::myScriptInformation

protected

MapScriptInformation DtScriptMultiTaskControllerPSR::myMapScriptInformation

protected

DtScriptPSRScenarioSaveFcn DtScriptMultiTaskControllerPSR::mySaveCallback

protected

void* DtScriptMultiTaskControllerPSR::myCallbackObject

protected

DtRwUserQuestionHandler DtScriptMultiTaskControllerPSR::myUserQuestionHandler

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfobjcore/scriptMultiTaskControllerPSR.h