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
DtSetSwitchSystem Class Reference

Set data request for switching out one system for another for the entity.

DtSetSwitchSystem is used to set the aggregate state for an aggregate entity.

Inheritance diagram for DtSetSwitchSystem:
Inheritance graph
[legend]

Public Member Functions

 DtSetSwitchSystem ()
 
 DtSetSwitchSystem (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 
 DtSetSwitchSystem (const DtString &writeName, const DtSetSwitchSystem &orig, DtReaderWriterRegistry *parentRegistry=0)
 
const DtSetSwitchSystem & operator= (const DtSetSwitchSystem &orig)
 
virtual ~DtSetSwitchSystem ()
 
virtual const DtSetMessageType & type () const
 
virtual DtSetDataRequest * clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
 
virtual DtString stringRep () const
 
virtual const DtString & systemCategory () const
 
virtual void setSystemCategory (const DtString &cat)
 
- Public Member Functions inherited from DtSetDataRequest
virtual ~DtSetDataRequest ()
 
virtual bool init ()
 
virtual void putData (std::string &fp, int indentLevel=0)
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual char * netRep ()
 
- 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)
 
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 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 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)
 
DtRwString mySystemCategory
 
DtRwString mySystemToTurnOn
 
DtRwString mySystemToSwitchOff
 
virtual const DtString & systemToActivateName () const
 
virtual void setSystemToActivateName (const DtString &activeSys)
 
virtual const DtString & systemToDeactivateName () const
 
virtual void setSystemToDeactivateName (const DtString &deactiveSys)
 
virtual int netRepSize () const
 
virtual bool setFromNet (const char *contentBuffer, unsigned contentSize)
 
virtual bool setToNet ()
 
static DtSetDataRequest * creator ()
 

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 DtSetDataRequest
static DtSetDataRequest * createSetDataRequest (DtlObjPtr mtlStream)
 
static DtSetDataRequest * createSetDataRequest (DtSetMessageType requestType)
 
static void addSetDataRequestCreatorFcn (const DtSetMessageType &setDataName, DtSetDataRequestCreatorFcn fcn)
 
static void setFactory (DtSetDataRequestFactory *factory)
 
static DtSetDataRequestFactory * factory ()
 
static bool isTypeRegistered (DtSetMessageType setDataType)
 
- 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 Member Functions inherited from DtSetDataRequest
 DtSetDataRequest ()
 
 DtSetDataRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 
 DtSetDataRequest (const DtString &writeName, const DtSetDataRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
 
const DtSetDataRequest & operator= (const DtSetDataRequest &orig)
 
virtual char * createNetworkBuffer ()
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 
- Protected Attributes inherited from DtSetDataRequest
char * myNetRep
 
- 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
 
- Static Protected Attributes inherited from DtSetDataRequest
static DtSetDataRequestFactory * myFactory
 
- 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
 

Constructor & Destructor Documentation

DtSetSwitchSystem::DtSetSwitchSystem ( )

default constructor

DtSetSwitchSystem::DtSetSwitchSystem ( const DtString &  writeName,
DtReaderWriterRegistry *  parentRegistry = 0 
)

constructor If you have a request 'put' itself, the writeName will preface it.

DtSetSwitchSystem::DtSetSwitchSystem ( const DtString &  writeName,
const DtSetSwitchSystem &  orig,
DtReaderWriterRegistry *  parentRegistry = 0 
)

copy constructor

virtual DtSetSwitchSystem::~DtSetSwitchSystem ( )
virtual

Member Function Documentation

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

assignment operator

virtual const DtSetMessageType& DtSetSwitchSystem::type ( ) const
virtual

Returns DtSetSwitchSystemType.

Implements DtSetDataRequest.

virtual DtSetDataRequest* DtSetSwitchSystem::clone ( const DtString &  name,
DtReaderWriterRegistry *  parentRegistry = 0 
) const
virtual

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetSwitchSystem::stringRep ( ) const
virtual

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual const DtString& DtSetSwitchSystem::systemCategory ( ) const
virtual

The name of the system category in which to switch systems.

virtual void DtSetSwitchSystem::setSystemCategory ( const DtString &  cat)
virtual

The name of the system category in which to switch systems.

virtual const DtString& DtSetSwitchSystem::systemToActivateName ( ) const
virtual

The name of the system to activate.

virtual void DtSetSwitchSystem::setSystemToActivateName ( const DtString &  activeSys)
virtual

The name of the system to activate.

virtual const DtString& DtSetSwitchSystem::systemToDeactivateName ( ) const
virtual

The name of the system to deactivate.

virtual void DtSetSwitchSystem::setSystemToDeactivateName ( const DtString &  deactiveSys)
virtual

The name of the system to activate.

virtual int DtSetSwitchSystem::netRepSize ( ) const
virtual

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSetDataRequest.

virtual bool DtSetSwitchSystem::setFromNet ( const char *  contentBuffer,
unsigned  contentSize 
)
virtual

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetSwitchSystem::setToNet ( )
virtual

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtSetDataRequest.

static DtSetDataRequest* DtSetSwitchSystem::creator ( )
static

The name of the system to activate.

Member Data Documentation

DtRwString DtSetSwitchSystem::mySystemCategory
protected

The name of the system to activate.

DtRwString DtSetSwitchSystem::mySystemToTurnOn
protected

The name of the system to activate.

DtRwString DtSetSwitchSystem::mySystemToSwitchOff
protected

The name of the system to activate.

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)