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 | Protected Attributes
DtRwSimObjectReference Class Reference

Specialized reader/writer version of the shared object reference that will encapsulate the actual shared reference and provide a pointer to the underlying shared reference.

Inheritance diagram for DtRwSimObjectReference:
Inheritance graph
[legend]

Public Member Functions

 DtRwSimObjectReference (const DtSimulationServices *services, const DtString &name, DtReaderWriterRegistry *=0)
 
 DtRwSimObjectReference (const DtRwSimObjectReference &rhs, DtReaderWriterRegistry *=0)
 
virtual ~DtRwSimObjectReference ()
 
DtRwSimObjectReferenceoperator= (const DtRwSimObjectReference &)
 
DtRwSimObjectReferenceoperator= (const DtSimObjectReference &)
 
DtRwSimObjectReferenceoperator= (const DtUUID &)
 
 operator DtSimObjectReference () const
 
const DtSimObjectoperator-> () const
 
bool isValid () const
 
bool isDeleted () const
 
void setSimulationServices (DtSimulationServices *s)
 
virtual void setUUID (const DtUUID &)
 
- Public Member Functions inherited from DtRwUUID
 DtRwUUID ()
 
 DtRwUUID (const char *name, DtReaderWriterRegistry *const parentRegistry=nullptr)
 
 DtRwUUID (const DtString &name, DtReaderWriterRegistry *const parentRegistry)
 
 DtRwUUID (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry)
 
 DtRwUUID (const DtString &name, const DtRwUUID &, DtReaderWriterRegistry *const parentRegistry)
 
 DtRwUUID (const DtSymbolString &name, const DtRwUUID &, DtReaderWriterRegistry *const parentRegistry)
 
 DtRwUUID (const DtSymbolString &name, const DtUUID &, DtReaderWriterRegistry *const parentRegistry)
 
 DtRwUUID (const DtString &name, const DtUUID &, DtReaderWriterRegistry *const parentRegistry)
 
 DtRwUUID (const DtString &name, const char *, DtReaderWriterRegistry *const parentRegistry)
 
 DtRwUUID (const DtSymbolString &name, const char *, DtReaderWriterRegistry *const parentRegistry)
 
 DtRwUUID (const DtRwUUID &, DtReaderWriterRegistry *const parentRegistry)
 
 DtRwUUID (const DtRwUUID &)
 
 DtRwUUID (const DtUUID &)
 
 DtRwUUID (const DtVrlUuid &)
 
virtual ~DtRwUUID ()
 
virtual const charreaderWriterType () const override
 
virtual void setMarkingText (const DtString &)
 
virtual DtString markingText () const
 
 operator const DtUUID & () const
 
DtRwUUIDoperator= (const DtRwUUID &orig)
 
DtRwUUIDoperator= (const DtUUID &orig)
 
DtRwUUIDoperator= (const DtVrlUuid &orig)
 
bool operator!= (const DtRwUUID &orig) const
 
bool operator== (const DtRwUUID &orig) const
 
bool operator< (const DtRwUUID &rhs) const
 
bool operator> (const DtRwUUID &rhs) const
 
virtual const charxmlType () const override
 
const DtUUIDuuid () const
 
DtUUIDuuid ()
 
virtual void clearUUID ()
 
virtual DtString uuidString () const
 
virtual void generateUUID ()
 
virtual void setUUID (const DtVrlUuid &u)
 
virtual void setUUID (const DtRwUUID &u)
 
virtual void setUUID (const DtString &uuid)
 
virtual void setStringUUID (const DtString &uuid)
 
bool isVrfUUID () const
 
const chardata () const
 
unsigned int dataSize () const
 
void setBuffer (const char *)
 
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
 
virtual void getSelf (DtlObjPtr args, const SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=DtVariableBindingsList()) override
 
virtual void getSelf (const DtEnvironmentSP env, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &varBindings=DtVariableBindingsList()) override
 
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) override
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) override
 
virtual void putSelf (DtEnvironmentSP env, DtEnvValueSP parent) const override
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const override
 
virtual void putData (std::string &fp, int) override
 
virtual DtVrlUuid vrlUuid () const
 
virtual DtString prettyPrint () const override
 
- 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 postPutSelf ()
 
virtual void prePutSelf ()
 
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 &)
 
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 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 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 void uuidChanged () override
 
virtual void postGetSelf ()
 
- Protected Member Functions inherited from DtRwUUID
virtual void noRwValueSpecified ()
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 

Protected Attributes

const DtSimulationServicesmySimulationServices
 
DtSimObjectReference myObjectReference
 
- Protected Attributes inherited from DtRwUUID
DtUUID myUUID
 
- 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 DtRwUUID
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)
 
- 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

DtRwSimObjectReference::DtRwSimObjectReference ( const DtSimulationServices services,
const DtString name,
DtReaderWriterRegistry = 0 
)
DtRwSimObjectReference::DtRwSimObjectReference ( const DtRwSimObjectReference rhs,
DtReaderWriterRegistry = 0 
)
virtual DtRwSimObjectReference::~DtRwSimObjectReference ( )
virtual

Member Function Documentation

DtRwSimObjectReference& DtRwSimObjectReference::operator= ( const DtRwSimObjectReference )
DtRwSimObjectReference& DtRwSimObjectReference::operator= ( const DtSimObjectReference )
DtRwSimObjectReference& DtRwSimObjectReference::operator= ( const DtUUID )
DtRwSimObjectReference::operator DtSimObjectReference ( ) const
inline
const DtSimObject* DtRwSimObjectReference::operator-> ( ) const
bool DtRwSimObjectReference::isValid ( void  ) const
inlinevirtual

Reimplemented from DtRwUUID.

bool DtRwSimObjectReference::isDeleted ( ) const
inline
void DtRwSimObjectReference::setSimulationServices ( DtSimulationServices s)
virtual void DtRwSimObjectReference::setUUID ( const DtUUID )
virtual
virtual void DtRwSimObjectReference::uuidChanged ( )
overrideprotectedvirtual

No-op at this level. Override to get notification when this UUID has changed, possibly from a remapping.

Reimplemented from DtRwUUID.

virtual void DtRwSimObjectReference::postGetSelf ( )
protectedvirtual

Called after either version of getSelf (mtl or environment). Default is no-op.

Reimplemented from DtReaderWriter.

Member Data Documentation

const DtSimulationServices* DtRwSimObjectReference::mySimulationServices
protected
DtSimObjectReference DtRwSimObjectReference::myObjectReference
protected

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

Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)