VR-Forces 5.0.3 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
DtRwSimulationAddress Class Reference

class DtRwSimulationAddress:

Instances of DtRwSimulationAddress are readable/writeable DtSimulationAddresses.

Inheritance diagram for DtRwSimulationAddress:
Inheritance graph
[legend]

Public Member Functions

 DtRwSimulationAddress ()
 
 DtRwSimulationAddress (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwSimulationAddress (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwSimulationAddress (const DtString &name, int siteId, int appId, DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwSimulationAddress (const DtSymbolString &name, int siteId, int appId, DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwSimulationAddress (const DtSimulationAddress &simulationAddress, const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwSimulationAddress (const DtSimulationAddress &simulationAddress, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual ~DtRwSimulationAddress ()
 
 DtRwSimulationAddress (const DtRwSimulationAddress &orig)
 
DtRwSimulationAddressoperator= (const DtRwSimulationAddress &orig)
 
DtRwSimulationAddressoperator= (const DtString &orig)
 
virtual void putData (std::string &fp, int indentlLevel=0)
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual const charreaderWriterType () const
 
bool operator== (const DtRwSimulationAddress &) const
 
bool operator!= (const DtRwSimulationAddress &rhs) 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)
 
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 wasUpdatedSince (DtTime t) 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 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 getSelf (const DtEnvironmentSP, const DtEnvValueSP root, 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 Member Functions

virtual void putData (DtEnvironmentSP env, DtEnvValueSP value) const
 
virtual void getData (const DtEnvironmentSP env, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 
- 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 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

DtRwSimulationAddress::DtRwSimulationAddress ( )

default constructor

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

real constructors - Set up to perform reader/writer operations correctly.

DtRwSimulationAddress::DtRwSimulationAddress ( const DtSymbolString name,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
DtRwSimulationAddress::DtRwSimulationAddress ( const DtString name,
int  siteId,
int  appId,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
DtRwSimulationAddress::DtRwSimulationAddress ( const DtSymbolString name,
int  siteId,
int  appId,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
DtRwSimulationAddress::DtRwSimulationAddress ( const DtSimulationAddress &  simulationAddress,
const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
)
DtRwSimulationAddress::DtRwSimulationAddress ( const DtSimulationAddress &  simulationAddress,
const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
)
virtual DtRwSimulationAddress::~DtRwSimulationAddress ( )
virtual

destructor

DtRwSimulationAddress::DtRwSimulationAddress ( const DtRwSimulationAddress orig)

copy constructor

Member Function Documentation

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

assignment operator: assigns value only

DtRwSimulationAddress& DtRwSimulationAddress::operator= ( const DtString orig)
virtual void DtRwSimulationAddress::putData ( std::string &  fp,
int  indentlLevel = 0 
)
virtual

Overridden to write and read the new field (as local data) from/to file. Format for the type is as follows: (site app)

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtRwSimulationAddress::getData ( DtlObjPtr  args,
const DtReaderWriter::SearchPaths searchPaths,
const DtVariableBindingsList variableBindings 
)
virtual

Deriving class overrides these to get/put class specific data.

Reimplemented from DtReaderWriter.

virtual const char* DtRwSimulationAddress::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.

bool DtRwSimulationAddress::operator== ( const DtRwSimulationAddress ) const
bool DtRwSimulationAddress::operator!= ( const DtRwSimulationAddress rhs) const
inline
virtual void DtRwSimulationAddress::putData ( DtEnvironmentSP  ,
DtEnvValueSP  value 
) const
protectedvirtual

Override to add attributes of actual data.

Reimplemented from DtReaderWriter.

virtual void DtRwSimulationAddress::getData ( const DtEnvironmentSP  ,
const DtEnvValueSP  ,
const DtReaderWriter::SearchPaths searchPaths,
const DtVariableBindingsList bindings 
)
protectedvirtual

Gets data from the environment value.

Reimplemented from DtReaderWriter.


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

Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)