Process State Repository for the DtRotaryWingFlightCommandController component.

Inheritance diagram for DtScriptMultiTaskControllerPSR:

Public Member Functions
	DtScriptMultiTaskControllerPSR (DtLocalObject 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 (std::string &, int, bool, const DtFilename &)

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

virtual DtString	type () const

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

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 &)

virtual void	setScriptTickPeriod (int taskId, const DtString &scriptId, double d, double curScenarioTime)

virtual double	scriptTickPeriod (int taskId, const DtString &scriptId) const

virtual void	setScriptTickWhilePaused (int taskId, const DtString &scriptId, bool enable)

virtual bool	scriptTickWhilePaused (int taskId, const DtString &scriptId) const

virtual bool	timeToExecuteScript (int taskId, const DtString &, double curSimTime, double curRealTime, bool isPaused)

virtual double	nextTimeToExecuteScript (int taskId, const DtString &, double curTime) const

virtual void	setNextTimeToExecuteScript (int taskId, const DtString &scriptId, double time)

virtual void	setNextTimeToExecuteScriptWhilePaused (int taskId, const DtString &scriptId, double time)

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

virtual int	scriptBackgroundProcessId (const DtString &scriptId) const

virtual DtRwUserQuestionHandler &	userQuestionHandler ()

virtual const DtRwUserQuestionHandler &	userQuestionHandler () const

virtual void	addScriptedSet (DtScriptedTaskSet *)

virtual DtScriptedTaskSet *	findScriptedSet (const DtString &scriptId) const

virtual void	removeScriptedSet (const DtString &)

virtual void	setCheckpointModeUseCheckpointState (int taskId, const DtString &scriptId, bool)

virtual bool	checkpointModeUseCheckpointState (int taskId, const DtString &scriptId) 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

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)

virtual	~DtReaderWriter ()

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	postGetSelf ()

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 Types
typedef void(*	DtScriptPSRScenarioSaveFcn )(void *)

typedef DtRwTemplatedListPtr < DtRwScriptInformation, false >	ScriptInformation

typedef std::map< DtString, DtRwScriptInformation >	ScriptInformationByScriptId

typedef std::map< int, DtRwScriptInformation >	ScriptInformationByTaskId

typedef DtRwTemplatedListPtr < DtScriptedTaskSet, true >	ScriptedSets

Protected Attributes
DtRwVariableBindings	myEntries

ScriptInformation	myScriptInformation

ScriptInformationByScriptId	myScriptInformationByScriptId

ScriptInformationByTaskId	myScriptInformationByTaskId

DtScriptPSRScenarioSaveFcn	mySaveCallback

void *	myCallbackObject

DtRwUserQuestionHandler	myUserQuestionHandler

ScriptedSets	myScriptedSets

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
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 ()

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 void(* DtScriptMultiTaskControllerPSR::DtScriptPSRScenarioSaveFcn)(void *)

protected

typedef DtRwTemplatedListPtr<DtRwScriptInformation, false> DtScriptMultiTaskControllerPSR::ScriptInformation

protected

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

protected

typedef std::map<int, DtRwScriptInformation> DtScriptMultiTaskControllerPSR::ScriptInformationByTaskId

protected

typedef DtRwTemplatedListPtr<DtScriptedTaskSet, true> DtScriptMultiTaskControllerPSR::ScriptedSets

protected

Constructor & Destructor Documentation

DtScriptMultiTaskControllerPSR::DtScriptMultiTaskControllerPSR	(	DtLocalObject *	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	(	std::string &	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

Top level to read itself from an input stream. searchPath 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 searchPath is specified with a non-NULL string, then file to be read in is searched for in the given path.

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	(	int	taskId,
		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	(	int	taskId,
		const DtString &	scriptId
	)		const

virtual

Returns the tick period for the script.

virtual void DtScriptMultiTaskControllerPSR::setScriptTickWhilePaused	(	int	taskId,
		const DtString &	scriptId,
		bool	enable
	)

virtual

Set whether the script should be ticked while simulation is paused.

virtual bool DtScriptMultiTaskControllerPSR::scriptTickWhilePaused	(	int	taskId,
		const DtString &	scriptId
	)		const

virtual

Returns whether the script should be ticked while simulation is paused.

virtual bool DtScriptMultiTaskControllerPSR::timeToExecuteScript	(	int	taskId,
		const DtString &	,
		double	curSimTime,
		double	curRealTime,
		bool	isPaused
	)

virtual

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

virtual double DtScriptMultiTaskControllerPSR::nextTimeToExecuteScript	(	int	taskId,
		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	(	int	taskId,
		const DtString &	scriptId,
		double	time
	)

virtual

Set the next time to execute the script.

virtual void DtScriptMultiTaskControllerPSR::setNextTimeToExecuteScriptWhilePaused	(	int	taskId,
		const DtString &	scriptId,
		double	time
	)

virtual

Set the next real time to execute the script if simulation is paused.

virtual void DtScriptMultiTaskControllerPSR::setScriptBackgroundProcessId	(	int	oldId,
		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,
		DtLocalObject *	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

virtual void DtScriptMultiTaskControllerPSR::addScriptedSet ( DtScriptedTaskSet * )

virtual

Adds/removes currently active scripted sets and their variables.

virtual DtScriptedTaskSet* DtScriptMultiTaskControllerPSR::findScriptedSet ( const DtString & scriptId ) const

virtual

virtual void DtScriptMultiTaskControllerPSR::removeScriptedSet ( const DtString & )

virtual

virtual void DtScriptMultiTaskControllerPSR::setCheckpointModeUseCheckpointState	(	int	taskId,
		const DtString &	scriptId,
		bool
	)

virtual

virtual bool DtScriptMultiTaskControllerPSR::checkpointModeUseCheckpointState	(	int	taskId,
		const DtString &	scriptId
	)		const

virtual

Member Data Documentation

DtRwVariableBindings DtScriptMultiTaskControllerPSR::myEntries

protected

ScriptInformation DtScriptMultiTaskControllerPSR::myScriptInformation

protected

ScriptInformationByScriptId DtScriptMultiTaskControllerPSR::myScriptInformationByScriptId

protected

ScriptInformationByTaskId DtScriptMultiTaskControllerPSR::myScriptInformationByTaskId

protected

DtScriptPSRScenarioSaveFcn DtScriptMultiTaskControllerPSR::mySaveCallback

protected

void* DtScriptMultiTaskControllerPSR::myCallbackObject

protected

DtRwUserQuestionHandler DtScriptMultiTaskControllerPSR::myUserQuestionHandler

protected

ScriptedSets DtScriptMultiTaskControllerPSR::myScriptedSets

protected

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

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

Public Member Functions

Static Public Member Functions

Protected Types

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation