VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions | Protected Attributes
DtTriggerData Class Reference

class DtTriggerData: More...

Inheritance diagram for DtTriggerData:
Inheritance graph
[legend]

Public Member Functions

 DtTriggerData ()
 default constructor
virtual ~DtTriggerData ()
 destructor
 DtTriggerData (const DtString &name, DtReaderWriterRegistry *parentRegistry=0, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream.
 DtTriggerData (const DtString &name, const DtTriggerData &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const DtTriggerDataoperator= (const DtTriggerData &orig)
 assignment operrator
virtual void setWhenStmtCursor (int cursor)
 set/get the when statement cursor
virtual int whenStmtCursor () const
virtual void setIsEnabled (bool flag)
 set/get the is-enabled flag
virtual bool isEnabled () const
virtual void setIsDone (bool flag)
 set/get the is-done flag
virtual bool isDone () 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)
 copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
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 aliasContaineraliases () 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 const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
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 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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

Protected Attributes

DtRwInt myWhenStmtCursor
DtRwBoolean myIsEnabled
DtRwBoolean myIsDone
- 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
- 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 DtReaderWriterFactoryfactory ()
- 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 DtReaderWriterFactory theFactory

Detailed Description

class DtTriggerData:

Instances of DtTriggerData are

Constructor & Destructor Documentation

DtTriggerData::DtTriggerData ( )

default constructor

virtual DtTriggerData::~DtTriggerData ( )
virtual

destructor

DtTriggerData::DtTriggerData ( const DtString name,
DtReaderWriterRegistry parentRegistry = 0,
bool  readonly = false 
)

real constructor Setting the readonly flag prevents object from writing itself to the stream.

By default, DtReaderWriter objects are read/write.

DtTriggerData::DtTriggerData ( const DtString name,
const DtTriggerData orig,
DtReaderWriterRegistry parentRegistry = 0 
)

copy constructor

Member Function Documentation

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

assignment operrator

virtual void DtTriggerData::setWhenStmtCursor ( int  cursor)
virtual

set/get the when statement cursor

virtual int DtTriggerData::whenStmtCursor ( ) const
virtual
virtual void DtTriggerData::setIsEnabled ( bool  flag)
virtual

set/get the is-enabled flag

virtual bool DtTriggerData::isEnabled ( ) const
virtual
virtual void DtTriggerData::setIsDone ( bool  flag)
virtual

set/get the is-done flag

virtual bool DtTriggerData::isDone ( ) const
virtual

Member Data Documentation

DtRwInt DtTriggerData::myWhenStmtCursor
protected
DtRwBoolean DtTriggerData::myIsEnabled
protected
DtRwBoolean DtTriggerData::myIsDone
protected

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

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)