VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
DtRwScriptReactiveTaskEntry Class Reference
Inheritance diagram for DtRwScriptReactiveTaskEntry:
Inheritance graph
[legend]

Public Member Functions

 DtRwScriptReactiveTaskEntry ()
 
 DtRwScriptReactiveTaskEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwScriptReactiveTaskEntry (const DtString &name, const DtRwScriptReactiveTaskEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
DtRwScriptReactiveTaskEntryoperator= (const DtRwScriptReactiveTaskEntry &orig)
 
virtual ~DtRwScriptReactiveTaskEntry ()
 
virtual const charreaderWriterType () const
 
virtual bool isDefaultEnabled () const
 
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
DtSimTaskMessageType
scriptId () const
 
virtual void setScriptId (const DtSimTaskMessageType &sid)
 
virtual void setScriptId (const std::string &sid)
 
virtual void setScriptId (const DtString &sid)
 
virtual const DtStringsystemName () const
 
virtual void setSystemName (const DtString &sid)
 
virtual std::set< DtStringactionCategories () const
 
virtual void setActionCategories (const std::set< std::string > &categories)
 
virtual const DtStringscriptInterfaceState ()
 
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 bool tickWhilePaused () const
 
virtual void setTickWhilePaused (bool enable)
 
virtual bool checkpointModeUseCheckpointState () const
 
virtual void setCheckpointModeUseCheckpointState (bool enable)
 
virtual double nextTickTimeWhilePaused () const
 
virtual void setNextTickTimeWhilePaused (double t)
 
virtual boost::shared_ptr
< DtScriptInterface
scriptInterface ()
 
virtual void setScriptInterface (boost::shared_ptr< DtScriptInterface > ptr)
 
virtual bool isMarkedForDeletion () const
 
virtual void markForDeletion ()
 
virtual void clearMarkedForDeletion ()
 
virtual bool isTimeToExecuteScript (double currentSimTime, double currentRealTime, bool isPaused)
 
- 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 DtReaderWriteroperator= (const DtReaderWriter &orig)
 
bool operator== (const DtReaderWriter &) const
 
bool operator!= (const DtReaderWriter &rhs)
 
virtual ~DtReaderWriter ()
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual void postPutSelf ()
 
virtual void prePutSelf ()
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
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 aliasContaineraliases () 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 charxmlType () 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 DtReaderWriterdefaultRWValue () const
 
virtual DtReaderWriterdefaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
const DtReaderWriterRegistryregistry () const
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () 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)
 

Protected Attributes

DtRwBoolean myIsDefaultEnabled
 
DtRwBoolean myIsEnabled
 
DtRwBoolean myIsActive
 
DtRwBoolean myIsSuspended
 
DtRwBoolean myIsDefaultPriority
 
DtRwBoolean myShouldInvokeCheckInit
 
DtRwInt myPriority
 
DtRwInt myTaskId
 
DtRwInt mySuspendId
 
DtRwString myScriptId
 
DtSimTaskMessageType myTaskMessageScriptId
 
DtRwString mySystemName
 
DtRwStringList myActionCategories
 
DtRwString myScriptInterfaceState
 
DtRwVariableBindings myParameters
 
DtRwReal myTickPeriod
 
DtRwReal myNextTickTime
 
DtRwBoolean myTickWhilePaused
 
DtReal myNextTickTimeWhilePaused
 
DtRwBoolean myCheckpointModeUseCheckpointState
 
boost::shared_ptr
< DtScriptInterface
myScriptInterface
 
bool myIsMarkedForDeletion
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
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 )()
 
- 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 chartheXmlType ()
 
static const DtFilename & appPath ()
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

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 DtSimTaskMessageType& DtRwScriptReactiveTaskEntry::scriptId ( ) const
virtual
virtual void DtRwScriptReactiveTaskEntry::setScriptId ( const DtSimTaskMessageType sid)
virtual
virtual void DtRwScriptReactiveTaskEntry::setScriptId ( const std::string &  sid)
virtual
virtual void DtRwScriptReactiveTaskEntry::setScriptId ( const DtString sid)
virtual
virtual const DtString& DtRwScriptReactiveTaskEntry::systemName ( ) const
inlinevirtual
virtual void DtRwScriptReactiveTaskEntry::setSystemName ( 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 bool DtRwScriptReactiveTaskEntry::tickWhilePaused ( ) const
inlinevirtual
virtual void DtRwScriptReactiveTaskEntry::setTickWhilePaused ( bool  enable)
inlinevirtual
virtual bool DtRwScriptReactiveTaskEntry::checkpointModeUseCheckpointState ( ) const
inlinevirtual
virtual void DtRwScriptReactiveTaskEntry::setCheckpointModeUseCheckpointState ( bool  enable)
inlinevirtual
virtual double DtRwScriptReactiveTaskEntry::nextTickTimeWhilePaused ( ) const
inlinevirtual
virtual void DtRwScriptReactiveTaskEntry::setNextTickTimeWhilePaused ( double  t)
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 void DtRwScriptReactiveTaskEntry::clearMarkedForDeletion ( )
inlinevirtual
virtual bool DtRwScriptReactiveTaskEntry::isTimeToExecuteScript ( double  currentSimTime,
double  currentRealTime,
bool  isPaused 
)
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
DtSimTaskMessageType DtRwScriptReactiveTaskEntry::myTaskMessageScriptId
mutableprotected
DtRwString DtRwScriptReactiveTaskEntry::mySystemName
protected
DtRwStringList DtRwScriptReactiveTaskEntry::myActionCategories
protected
DtRwString DtRwScriptReactiveTaskEntry::myScriptInterfaceState
protected
DtRwVariableBindings DtRwScriptReactiveTaskEntry::myParameters
protected
DtRwReal DtRwScriptReactiveTaskEntry::myTickPeriod
protected
DtRwReal DtRwScriptReactiveTaskEntry::myNextTickTime
protected
DtRwBoolean DtRwScriptReactiveTaskEntry::myTickWhilePaused
protected
DtReal DtRwScriptReactiveTaskEntry::myNextTickTimeWhilePaused
protected
DtRwBoolean DtRwScriptReactiveTaskEntry::myCheckpointModeUseCheckpointState
protected
boost::shared_ptr<DtScriptInterface> DtRwScriptReactiveTaskEntry::myScriptInterface
protected
bool DtRwScriptReactiveTaskEntry::myIsMarkedForDeletion
protected

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

Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)