Inheritance diagram for DtScriptReactiveTaskControllerPSR:

Public Types
typedef std::map < DtSimTaskMessageType, DtRwScriptReactiveTaskEntry * >	ReactiveTaskEntryMap

typedef std::map< int, std::list < DtSimTaskMessageType > >	PriorityMap

typedef std::map< DtString, int >	CategoryReactionLevelMap

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
	DtScriptReactiveTaskControllerPSR (DtLocalObject vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)

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

virtual	~DtScriptReactiveTaskControllerPSR () override

DtScriptReactiveTaskControllerPSR &	operator= (const DtScriptReactiveTaskControllerPSR &orig)

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

virtual DtString	type () const override

virtual void	putSelf (std::string &fp, int indentLevel, bool writeUnspecified, const DtFilename &path) override

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

virtual void	addTaskPriority (const DtSimTaskMessageType &scriptId, int priority)

virtual void	removeTaskPriority (const DtSimTaskMessageType &scriptId)

virtual const PriorityMap &	priorityMap () const

virtual void	updateAllPriorities ()

virtual void	addReactiveTaskEntry (const DtSimTaskMessageType &scriptId, DtRwScriptReactiveTaskEntry *entry, bool deleteOnUpdate=true)

virtual void	removeReactiveTaskEntry (const DtSimTaskMessageType &scriptId, bool deleteEntry=true)

virtual DtRwScriptReactiveTaskEntry *	findReactiveTaskEntry (const DtSimTaskMessageType &scriptId) const

virtual const ReactiveTaskEntryMap &	reactiveTaskEntryMap () const

virtual void	addActionCategories (const std::set< DtString > &actionCategories)

virtual int	currentReactionLevel (const std::set< DtString > &actionCategories) const

virtual void	updateReactionLevels (const std::set< DtString > &actionCategories)

virtual void	updateAllReactionLevels ()

virtual void	sweepMarkedForDeletion ()

virtual DtRwUserQuestionHandler &	userQuestionHandler ()

virtual const DtRwUserQuestionHandler &	userQuestionHandler () 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 () override

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

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(*	DtScriptPSRScenarioSaveLoadFcn )(void *)

Protected Member Functions
bool	doCategoriesOverlap (const std::set< DtString > &firstSet, const std::set< DtString > &secondSet, std::set< DtString > &overlap) const

Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()

const DtSimObject *	vrfObject () const

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtRwTemplatedListPtr < DtRwScriptReactiveTaskEntry, false >	myReactiveTasks

ReactiveTaskEntryMap	myReactiveTaskEntryMap

PriorityMap	myPriorityMap

CategoryReactionLevelMap	myCategoryReactionLevelMap

DtRwUserQuestionHandler	myUserQuestionHandler

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
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(* DtScriptReactiveTaskControllerPSR::DtScriptPSRScenarioSaveLoadFcn)(void *)

protected

typedef std::map<DtSimTaskMessageType, DtRwScriptReactiveTaskEntry*> DtScriptReactiveTaskControllerPSR::ReactiveTaskEntryMap

typedef std::map<int, std::list<DtSimTaskMessageType> > DtScriptReactiveTaskControllerPSR::PriorityMap

typedef std::map<DtString, int> DtScriptReactiveTaskControllerPSR::CategoryReactionLevelMap

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtScriptReactiveTaskControllerPSR::~DtScriptReactiveTaskControllerPSR ( )

overridevirtual

destructor

Member Function Documentation

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

assignment operator

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

overridevirtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtScriptReactiveTaskControllerPSR::type ( ) const

overridevirtual

Returns the string type of this process state repository, defined in psrTypes.h. Returns "script-reaction-controller-process-state-repository".

Implements DtVrfProcessStateRepository.

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

static

Returns a newly created instance of this class.

virtual void DtScriptReactiveTaskControllerPSR::putSelf	(	std::string &	fp,
		int	indentLevel,
		bool	writeUnspecified,
		const DtFilename &	path
	)

overridevirtual

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 DtScriptReactiveTaskControllerPSR::getSelf	(	DtlObjPtr	args,
		const DtReaderWriter::SearchPaths &	searchPaths,
		const DtVariableBindingsList &	variableBindings
	)

overridevirtual

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 void DtScriptReactiveTaskControllerPSR::addTaskPriority	(	const DtSimTaskMessageType &	scriptId,
		int	priority
	)

virtual

virtual void DtScriptReactiveTaskControllerPSR::removeTaskPriority ( const DtSimTaskMessageType & scriptId )

virtual

remove task priority depends on it being in the reactive task entry map, so you should call the removal of the priority first if you are ever to remove both at once.

virtual const PriorityMap& DtScriptReactiveTaskControllerPSR::priorityMap ( ) const

virtual

virtual void DtScriptReactiveTaskControllerPSR::updateAllPriorities ( )

virtual

virtual void DtScriptReactiveTaskControllerPSR::addReactiveTaskEntry	(	const DtSimTaskMessageType &	scriptId,
		DtRwScriptReactiveTaskEntry *	entry,
		bool	deleteOnUpdate = `true`
	)

virtual

Adds the new reactive task entry to the map. If the item already exists, the existing entry is then updated to match the given entry. If deleteOnUpdate is set, then the passed in entry is deleted to avoid memory leak. The entry parameter is then set with the entry in the map.

virtual void DtScriptReactiveTaskControllerPSR::removeReactiveTaskEntry	(	const DtSimTaskMessageType &	scriptId,
		bool	deleteEntry = `true`
	)

virtual

virtual DtRwScriptReactiveTaskEntry* DtScriptReactiveTaskControllerPSR::findReactiveTaskEntry ( const DtSimTaskMessageType & scriptId ) const

virtual

virtual const ReactiveTaskEntryMap& DtScriptReactiveTaskControllerPSR::reactiveTaskEntryMap ( ) const

virtual

virtual void DtScriptReactiveTaskControllerPSR::addActionCategories ( const std::set< DtString > & actionCategories )

virtual

virtual int DtScriptReactiveTaskControllerPSR::currentReactionLevel ( const std::set< DtString > & actionCategories ) const

virtual

virtual void DtScriptReactiveTaskControllerPSR::updateReactionLevels ( const std::set< DtString > & actionCategories )

virtual

virtual void DtScriptReactiveTaskControllerPSR::updateAllReactionLevels ( )

virtual

virtual void DtScriptReactiveTaskControllerPSR::sweepMarkedForDeletion ( )

virtual

virtual DtRwUserQuestionHandler& DtScriptReactiveTaskControllerPSR::userQuestionHandler ( )

virtual

User question handler access.

virtual const DtRwUserQuestionHandler& DtScriptReactiveTaskControllerPSR::userQuestionHandler ( ) const

virtual

bool DtScriptReactiveTaskControllerPSR::doCategoriesOverlap	(	const std::set< DtString > &	firstSet,
		const std::set< DtString > &	secondSet,
		std::set< DtString > &	overlap
	)		const

protected

Member Data Documentation

DtRwTemplatedListPtr<DtRwScriptReactiveTaskEntry, false> DtScriptReactiveTaskControllerPSR::myReactiveTasks

protected

ReactiveTaskEntryMap DtScriptReactiveTaskControllerPSR::myReactiveTaskEntryMap

protected

Fast access only, though state will be saved through members above these.

PriorityMap DtScriptReactiveTaskControllerPSR::myPriorityMap

protected

CategoryReactionLevelMap DtScriptReactiveTaskControllerPSR::myCategoryReactionLevelMap

protected

DtRwUserQuestionHandler DtScriptReactiveTaskControllerPSR::myUserQuestionHandler

protected

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation