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 Member Functions
DtRwTriggersList Class Reference

Instances of DtRwTriggersList are lists of readable, writeable when statements (triggers) The list contains pointers to DtTriggerStmt instances.

Inheritance diagram for DtRwTriggersList:
Inheritance graph
[legend]

Public Member Functions

 DtRwTriggersList ()
 
 DtRwTriggersList (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwTriggersList (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwTriggersList (const DtRwTriggersList &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 
virtual ~DtRwTriggersList () override
 
virtual DtTriggerStmttriggerStatement (const DtUUID &w) const
 
virtual DtTriggerStmtaddTrigger (const DtTriggerStmt &)
 
virtual void renameTrigger (const DtUUID &, const DtString &newName)
 
virtual void updateTrigger (const DtTriggerStmt *)
 
virtual void removeTrigger (const DtUUID &)
 
virtual DtTriggerStmttrigger (int) const
 
DtRwTriggersListoperator= (const DtRwTriggersList &orig)
 
void emptyList ()
 
void copyList (const DtRwTriggersList &orig)
 
virtual bool operator== (const DtRwTriggersList &) const
 
virtual bool operator!= (const DtRwTriggersList &rhs) const
 
 DtRwTriggersList (const DtString &name, const DtRwTriggersList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwTriggersList (const DtSymbolString &name, const DtRwTriggersList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
- Public Member Functions inherited from DtRwList
 DtRwList ()
 
 DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual ~DtRwList () override
 
const DtRwListoperator= (const DtRwList &orig)
 
virtual DtListItem * add (DtReaderWriter *data)
 
virtual DtListItem * addWithAlternateName (DtReaderWriter *data, const DtString &name)
 
virtual DtListItem * addToStart (DtReaderWriter *data)
 
virtual DtListItem * addToEnd (DtReaderWriter *data)
 
virtual void * remove (DtReaderWriter *data, DtListItem *item)
 
virtual DtlObjPtr getLocalData (DtlObjPtr args)
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) override
 
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) override
 
virtual DtListItem * addBefore (DtReaderWriter *data, DtReaderWriter *before)
 
virtual DtListItem * addAfter (DtReaderWriter *data, DtReaderWriter *after)
 
virtual void removeAll ()
 
virtual void removeAndDeleteAll ()
 
virtual void reset () override
 
virtual const charreaderWriterType () const override
 
bool operator== (const DtRwList &rhs) const
 
bool operator!= (const DtRwList &rhs) const
 
virtual void populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
 
virtual void populateListByType (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtString &bindingType, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
 
 DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual DtListItem * addBefore (DtReaderWriter *data, const DtString &before)
 
virtual DtListItem * addBefore (DtReaderWriter *data, const DtSymbolString &before)
 
virtual DtListItem * addAfter (DtReaderWriter *data, const DtString &after)
 
virtual DtListItem * addAfter (DtReaderWriter *data, const DtSymbolString &after)
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP parent) const override
 
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) override
 
virtual const charxmlType () const override
 
virtual std::set< DtStringsupportedXmlTypes () 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 DtReaderWriteroperator= (const DtReaderWriter &orig)
 
bool operator== (const DtReaderWriter &) const
 
bool operator!= (const DtReaderWriter &rhs) const
 
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 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 int alignment () const
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 
virtual void setName (const DtString &)
 
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 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 putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 

Protected Member Functions

virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
 
virtual void removeTriggerRegistrationFrom (DtTriggerStmt *, const DtUUID &)
 
virtual void removeTriggerRegistrationFrom (DtSimBlock *, const DtUUID &)
 
virtual void removeTriggerRegistrationFrom (DtSimBlock *, DtSimStatement *, const DtUUID &)
 
- Protected Member Functions inherited from DtRwList
virtual DtListItem * addBefore (DtReaderWriter *data, DtListItem *before)
 
virtual DtListItem * addAfter (DtReaderWriter *data, DtListItem *after)
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 

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 DtRwList
static const chartheXmlType ()
 
- 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 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
 
- 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

DtRwTriggersList::DtRwTriggersList ( )

default constructor

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

constructor

DtRwTriggersList::DtRwTriggersList ( const DtSymbolString name,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
DtRwTriggersList::DtRwTriggersList ( const DtRwTriggersList name,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
virtual DtRwTriggersList::~DtRwTriggersList ( )
overridevirtual

destructor

DtRwTriggersList::DtRwTriggersList ( const DtString name,
const DtRwTriggersList orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor This performs a deep copy of the list, and creates new DtRwInt instances for each item on the list.

DtRwTriggersList::DtRwTriggersList ( const DtSymbolString name,
const DtRwTriggersList orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor This performs a deep copy of the list, and creates new DtRwInt instances for each item on the list.

Member Function Documentation

virtual DtTriggerStmt* DtRwTriggersList::triggerStatement ( const DtUUID w) const
virtual

Returns a trigger of the given name.

virtual DtTriggerStmt* DtRwTriggersList::addTrigger ( const DtTriggerStmt )
virtual

Adds a new trigger into the trigger list. Will clone and return.

virtual void DtRwTriggersList::renameTrigger ( const DtUUID ,
const DtString newName 
)
virtual

Renames the trigger to the new name.

virtual void DtRwTriggersList::updateTrigger ( const DtTriggerStmt )
virtual

Sets the trigger to have the contents of the supplied trigger. If trigger does not exist by UUID will not add.

virtual void DtRwTriggersList::removeTrigger ( const DtUUID )
virtual

Removes the triger with the given name. Will also go through all triggers that are not of that name and remove any unregister/register statements of a trigger with that name.

virtual DtTriggerStmt* DtRwTriggersList::trigger ( int  ) const
virtual

Gets the trigger at the current index (if valid)

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

assignment operator Empties the current list (including deleting all items) before making a deep copy of the specified list.

void DtRwTriggersList::emptyList ( )

Removes and deletes all DtRwInt entries from our list.

void DtRwTriggersList::copyList ( const DtRwTriggersList orig)

Copies list of DtRwInts to ourself.

virtual bool DtRwTriggersList::operator== ( const DtRwTriggersList ) const
virtual

Returns true if triggers lists are equivalent.

virtual bool DtRwTriggersList::operator!= ( const DtRwTriggersList rhs) const
inlinevirtual
virtual DtlObjPtr DtRwTriggersList::getData ( DtlObjPtr  args,
const DtReaderWriter::SearchPaths searchPaths,
const DtVariableBindingsList variableBindings 
)
overrideprotectedvirtual

Constructs a DtRwInt item, and then retrieves it from the stream.

Implements DtRwList.

virtual void DtRwTriggersList::removeTriggerRegistrationFrom ( DtTriggerStmt ,
const DtUUID  
)
protectedvirtual

Removes any trigger register statement with the given trigger name from the when statement.

virtual void DtRwTriggersList::removeTriggerRegistrationFrom ( DtSimBlock ,
const DtUUID  
)
protectedvirtual
virtual void DtRwTriggersList::removeTriggerRegistrationFrom ( DtSimBlock ,
DtSimStatement ,
const DtUUID  
)
protectedvirtual

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

Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)