DtRwScriptReactiveTaskEntry Class Reference

Inheritance diagram for DtRwScriptReactiveTaskEntry:

Public Member Functions
	DtRwScriptReactiveTaskEntry ()
	DtRwScriptReactiveTaskEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwScriptReactiveTaskEntry (const DtString &name, const DtRwScriptReactiveTaskEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtRwScriptReactiveTaskEntry &	operator= (const DtRwScriptReactiveTaskEntry &orig)
virtual	~DtRwScriptReactiveTaskEntry ()
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual bool	isDefaultEnabled () const
	This means if this entry was originally created due to being enabled by default rather than an explicit "setEnable" type call.
virtual void	setIsDefaultEnabled (bool enabled)
virtual bool	isEnabled () const
virtual void	setIsEnabled (bool enabled)
virtual bool	isActive () const
virtual void	setIsActive (bool active)
virtual bool	isSuspended () const
virtual void	setIsSuspended (bool suspended)
virtual bool	isDefaultPriority () const
virtual void	setIsDefaultPriority (bool isDefault)
virtual bool	shouldInvokeCheckInit () const
virtual void	setShouldInvokeCheckInit (bool shouldInvoke)
virtual int	priority () const
virtual void	setPriority (int level)
virtual int	taskId () const
virtual void	setTaskId (int tid)
virtual int	suspendId () const
virtual void	setSuspendId (int spid)
virtual const DtString &	scriptId () const
virtual void	setScriptId (const std::string &sid)
virtual void	setScriptId (const DtString &sid)
virtual std::set< DtString >	actionCategories () const
	This will return a copy of the list.
virtual void	setActionCategories (const std::set< std::string > &categories)
virtual const DtString &	scriptInterfaceState ()
virtual void	setScriptInterfaceState (const DtString &state)
virtual const DtRwVariableBindings &	parameters () const
virtual void	setParameters (const DtRwVariableBindings &params)
virtual double	tickPeriod () const
virtual void	setTickPeriod (double period)
virtual double	nextTickTime () const
virtual void	setNextTickTime (double period)
virtual boost::shared_ptr < DtScriptInterface >	scriptInterface ()
virtual void	setScriptInterface (boost::shared_ptr< DtScriptInterface > ptr)
virtual bool	isMarkedForDeletion () const
virtual void	markForDeletion ()
virtual bool	isTimeToExecuteScript (double currentTime)
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 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.

Protected Attributes
DtRwBoolean	myIsDefaultEnabled
DtRwBoolean	myIsEnabled
DtRwBoolean	myIsActive
DtRwBoolean	myIsSuspended
DtRwBoolean	myIsDefaultPriority
DtRwBoolean	myShouldInvokeCheckInit
DtRwInt	myPriority
DtRwInt	myTaskId
DtRwInt	mySuspendId
DtRwString	myScriptId
DtRwStringList	myActionCategories
DtRwString	myScriptInterfaceState
DtRwVariableBindings	myParameters
DtRwReal	myTickPeriod
DtRwReal	myNextTickTime
boost::shared_ptr < DtScriptInterface >	myScriptInterface
bool	myIsMarkedForDeletion
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
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
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 ()
static DtReaderWriterFactory *	factory ()
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.
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

Constructor & Destructor Documentation

DtRwScriptReactiveTaskEntry::DtRwScriptReactiveTaskEntry

(

)

DtRwScriptReactiveTaskEntry::DtRwScriptReactiveTaskEntry	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtRwScriptReactiveTaskEntry::DtRwScriptReactiveTaskEntry	(	const DtString &	name,
		const DtRwScriptReactiveTaskEntry &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtRwScriptReactiveTaskEntry::~DtRwScriptReactiveTaskEntry ( )

virtual

Member Function Documentation

DtRwScriptReactiveTaskEntry& DtRwScriptReactiveTaskEntry::operator=

(

const DtRwScriptReactiveTaskEntry &

orig

)

virtual const char* DtRwScriptReactiveTaskEntry::readerWriterType ( ) const

virtual

Used to supply a string type that this reader writer type is.

This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create

Reimplemented from DtReaderWriter.

virtual bool DtRwScriptReactiveTaskEntry::isDefaultEnabled ( ) const

inlinevirtual

This means if this entry was originally created due to being enabled by default rather than an explicit "setEnable" type call.

The difference matters in how these entries will be handled

virtual void DtRwScriptReactiveTaskEntry::setIsDefaultEnabled ( bool  enabled )

inlinevirtual

virtual bool DtRwScriptReactiveTaskEntry::isEnabled ( ) const

inlinevirtual

virtual void DtRwScriptReactiveTaskEntry::setIsEnabled ( bool  enabled )

inlinevirtual

virtual bool DtRwScriptReactiveTaskEntry::isActive ( ) const

inlinevirtual

virtual void DtRwScriptReactiveTaskEntry::setIsActive ( bool  active )

inlinevirtual

virtual bool DtRwScriptReactiveTaskEntry::isSuspended ( ) const

inlinevirtual

virtual void DtRwScriptReactiveTaskEntry::setIsSuspended ( bool  suspended )

inlinevirtual

virtual bool DtRwScriptReactiveTaskEntry::isDefaultPriority ( ) const

inlinevirtual

virtual void DtRwScriptReactiveTaskEntry::setIsDefaultPriority ( bool  isDefault )

inlinevirtual

virtual bool DtRwScriptReactiveTaskEntry::shouldInvokeCheckInit ( ) const

inlinevirtual

virtual void DtRwScriptReactiveTaskEntry::setShouldInvokeCheckInit ( bool  shouldInvoke )

inlinevirtual

virtual int DtRwScriptReactiveTaskEntry::priority ( ) const

inlinevirtual

virtual void DtRwScriptReactiveTaskEntry::setPriority ( int  level )

inlinevirtual

virtual int DtRwScriptReactiveTaskEntry::taskId ( ) const

inlinevirtual

virtual void DtRwScriptReactiveTaskEntry::setTaskId ( int  tid )

inlinevirtual

virtual int DtRwScriptReactiveTaskEntry::suspendId ( ) const

inlinevirtual

virtual void DtRwScriptReactiveTaskEntry::setSuspendId ( int  spid )

inlinevirtual

virtual const DtString& DtRwScriptReactiveTaskEntry::scriptId ( ) const

inlinevirtual

virtual void DtRwScriptReactiveTaskEntry::setScriptId ( const std::string &  sid )

inlinevirtual

virtual void DtRwScriptReactiveTaskEntry::setScriptId ( const DtString &  sid )

inlinevirtual

virtual std::set<DtString> DtRwScriptReactiveTaskEntry::actionCategories ( ) const

virtual

This will return a copy of the list.

virtual void DtRwScriptReactiveTaskEntry::setActionCategories ( const std::set< std::string > &  categories )

virtual

virtual const DtString& DtRwScriptReactiveTaskEntry::scriptInterfaceState ( )

inlinevirtual

virtual void DtRwScriptReactiveTaskEntry::setScriptInterfaceState ( const DtString &  state )

inlinevirtual

virtual const DtRwVariableBindings& DtRwScriptReactiveTaskEntry::parameters ( ) const

inlinevirtual

virtual void DtRwScriptReactiveTaskEntry::setParameters ( const DtRwVariableBindings &  params )

inlinevirtual

virtual double DtRwScriptReactiveTaskEntry::tickPeriod ( ) const

inlinevirtual

virtual void DtRwScriptReactiveTaskEntry::setTickPeriod ( double  period )

inlinevirtual

virtual double DtRwScriptReactiveTaskEntry::nextTickTime ( ) const

inlinevirtual

virtual void DtRwScriptReactiveTaskEntry::setNextTickTime ( double  period )

inlinevirtual

virtual boost::shared_ptr<DtScriptInterface> DtRwScriptReactiveTaskEntry::scriptInterface ( )

inlinevirtual

virtual void DtRwScriptReactiveTaskEntry::setScriptInterface ( boost::shared_ptr< DtScriptInterface >  ptr )

inlinevirtual

virtual bool DtRwScriptReactiveTaskEntry::isMarkedForDeletion ( ) const

inlinevirtual

virtual void DtRwScriptReactiveTaskEntry::markForDeletion ( )

inlinevirtual

virtual bool DtRwScriptReactiveTaskEntry::isTimeToExecuteScript ( double  currentTime )

virtual

Member Data Documentation

DtRwBoolean DtRwScriptReactiveTaskEntry::myIsDefaultEnabled

protected

DtRwBoolean DtRwScriptReactiveTaskEntry::myIsEnabled

protected

DtRwBoolean DtRwScriptReactiveTaskEntry::myIsActive

protected

DtRwBoolean DtRwScriptReactiveTaskEntry::myIsSuspended

protected

DtRwBoolean DtRwScriptReactiveTaskEntry::myIsDefaultPriority

protected

DtRwBoolean DtRwScriptReactiveTaskEntry::myShouldInvokeCheckInit

protected

DtRwInt DtRwScriptReactiveTaskEntry::myPriority

protected

DtRwInt DtRwScriptReactiveTaskEntry::myTaskId

protected

DtRwInt DtRwScriptReactiveTaskEntry::mySuspendId

protected

DtRwString DtRwScriptReactiveTaskEntry::myScriptId

protected

DtRwStringList DtRwScriptReactiveTaskEntry::myActionCategories

protected

DtRwString DtRwScriptReactiveTaskEntry::myScriptInterfaceState

protected

DtRwVariableBindings DtRwScriptReactiveTaskEntry::myParameters

protected

DtRwReal DtRwScriptReactiveTaskEntry::myTickPeriod

protected

DtRwReal DtRwScriptReactiveTaskEntry::myNextTickTime

protected

boost::shared_ptr<DtScriptInterface> DtRwScriptReactiveTaskEntry::myScriptInterface

protected

bool DtRwScriptReactiveTaskEntry::myIsMarkedForDeletion

protected

---

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

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