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 | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtRwUUID Class Reference

Description: Readable, Writable uuid string. Use this class in order to convert from object marking texts to UUIDs. This class can be used in place of DtRwString This class will take a boost uuid and use it to archive from an mtl/xml file.

Inheritance diagram for DtRwUUID:
Inheritance graph
[legend]

Public Member Functions

 DtRwUUID ()
 
 DtRwUUID (const char *name, DtReaderWriterRegistry *const parentRegistry=0)
 
 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 &)
 
virtual ~DtRwUUID ()
 
virtual const char * readerWriterType () const
 
virtual void setMarkingText (const DtString &)
 
virtual DtString markingText () const
 
 operator const DtUUID & () const
 
DtRwUUID & operator= (const DtRwUUID &orig)
 
DtRwUUID & operator= (const DtUUID &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 char * xmlType () const
 
const DtUUID & uuid () const
 
DtUUID & uuid ()
 
virtual void clearUUID ()
 
virtual DtString uuidString () const
 
virtual bool isValid () const
 
virtual void generateUUID ()
 
virtual void setUUID (const DtRwUUID &u)
 
virtual void setUUID (const DtString &uuid)
 
virtual void setStringUUID (const DtString &uuid)
 
bool isVrfUUID () const
 
const char * data () const
 
unsigned int dataSize () const
 
void setBuffer (const char *)
 
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual void getSelf (DtlObjPtr args, const SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=DtVariableBindingsList())
 
virtual void getSelf (const DtEnvironmentSP env, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &varBindings=DtVariableBindingsList())
 
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual void putSelf (DtEnvironmentSP env, DtEnvValueSP parent) const
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void putData (std::string &fp, int)
 
virtual DtString prettyPrint () 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 DtReaderWriter & operator= (const DtReaderWriter &orig)
 
bool operator== (const DtReaderWriter &) const
 
bool operator!= (const DtReaderWriter &rhs)
 
virtual ~DtReaderWriter ()
 
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 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 &)
 
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 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 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)
 

Static Public Member Functions

static const char * theXmlType ()
 
- 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

virtual void noRwValueSpecified ()
 
virtual void uuidChanged ()
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 

Protected Attributes

DtUUID myUUID
 
- 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
 

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 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

DtRwUUID::DtRwUUID ( )

CTOR. In order to create a UUID call generateUUID.

DtRwUUID::DtRwUUID ( const char *  name,
DtReaderWriterRegistry *const  parentRegistry = 0 
)
DtRwUUID::DtRwUUID ( const DtString &  name,
DtReaderWriterRegistry *const  parentRegistry 
)
DtRwUUID::DtRwUUID ( const DtSymbolString &  name,
DtReaderWriterRegistry *const  parentRegistry 
)
DtRwUUID::DtRwUUID ( const DtString &  name,
const DtRwUUID &  ,
DtReaderWriterRegistry *const  parentRegistry 
)

Copy constructors.

DtRwUUID::DtRwUUID ( const DtSymbolString &  name,
const DtRwUUID &  ,
DtReaderWriterRegistry *const  parentRegistry 
)
DtRwUUID::DtRwUUID ( const DtSymbolString &  name,
const DtUUID &  ,
DtReaderWriterRegistry *const  parentRegistry 
)
DtRwUUID::DtRwUUID ( const DtString &  name,
const DtUUID &  ,
DtReaderWriterRegistry *const  parentRegistry 
)
DtRwUUID::DtRwUUID ( const DtString &  name,
const char *  ,
DtReaderWriterRegistry *const  parentRegistry 
)
DtRwUUID::DtRwUUID ( const DtSymbolString &  name,
const char *  ,
DtReaderWriterRegistry *const  parentRegistry 
)
DtRwUUID::DtRwUUID ( const DtRwUUID &  ,
DtReaderWriterRegistry *const  parentRegistry 
)
DtRwUUID::DtRwUUID ( const DtRwUUID &  )
DtRwUUID::DtRwUUID ( const DtUUID &  )
virtual DtRwUUID::~DtRwUUID ( )
virtual

Member Function Documentation

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

Reimplemented in DtRwObjectName, and DtRwPlanSimulationObject.

virtual void DtRwUUID::setMarkingText ( const DtString &  )
virtual
virtual DtString DtRwUUID::markingText ( ) const
virtual

Reimplemented in DtRwPlanVariable.

static const char* DtRwUUID::theXmlType ( )
static

The type that is used when archiving to an XML stream.

Referenced by DtRwPlanSimulationObject::xmlType(), and DtRwObjectName::xmlType().

DtRwUUID::operator const DtUUID & ( ) const
inline
DtRwUUID& DtRwUUID::operator= ( const DtRwUUID &  orig)

Referenced by DtRwPlanVariable::operator=().

DtRwUUID& DtRwUUID::operator= ( const DtUUID &  orig)
bool DtRwUUID::operator!= ( const DtRwUUID &  orig) const
inline
bool DtRwUUID::operator== ( const DtRwUUID &  orig) const
bool DtRwUUID::operator< ( const DtRwUUID &  rhs) const
inline
bool DtRwUUID::operator> ( const DtRwUUID &  rhs) const
inline
virtual const char* DtRwUUID::xmlType ( ) const
inlinevirtual

Reimplemented from DtReaderWriter.

Reimplemented in DtRwObjectName, and DtRwPlanSimulationObject.

References DtReaderWriter::theXmlType().

const DtUUID& DtRwUUID::uuid ( ) const
inline
DtUUID& DtRwUUID::uuid ( )
inline
virtual void DtRwUUID::clearUUID ( )
virtual
virtual DtString DtRwUUID::uuidString ( ) const
virtual
virtual bool DtRwUUID::isValid ( ) const
virtual

Reimplemented in DtRwSimObjectReference.

Referenced by DtLegacySimObjectStateRepositoryRWData::setAttachedToRepository().

virtual void DtRwUUID::generateUUID ( )
virtual
virtual void DtRwUUID::setUUID ( const DtRwUUID &  u)
virtual
virtual void DtRwUUID::setUUID ( const DtString &  uuid)
virtual
virtual void DtRwUUID::setStringUUID ( const DtString &  uuid)
virtual
bool DtRwUUID::isVrfUUID ( ) const
const char* DtRwUUID::data ( ) const
unsigned int DtRwUUID::dataSize ( ) const
void DtRwUUID::setBuffer ( const char *  )
virtual DtlObjPtr DtRwUUID::getData ( DtlObjPtr  args,
const SearchPaths &  searchPaths,
const DtVariableBindingsList &  variableBindings 
)
virtual

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

Reimplemented from DtReaderWriter.

Reimplemented in DtRwScenarioEventUUID.

virtual void DtRwUUID::getSelf ( DtlObjPtr  args,
const SearchPaths &  searchPaths = DtReaderWriter::SearchPaths(),
const DtVariableBindingsList &  variableBindings = DtVariableBindingsList() 
)
virtual

Top level to read itself from an input stream. searchPath is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the searchPath is specified with a non-NULL string, then file to be read in is searched for in the given path.

Reimplemented from DtReaderWriter.

virtual void DtRwUUID::getSelf ( const DtEnvironmentSP  ,
const DtEnvValueSP  root,
const DtReaderWriter::SearchPaths &  searchPaths = DtReaderWriter::SearchPaths(),
const DtVariableBindingsList &  bindings = DtVariableBindingsList() 
)
virtual

Routines to archive/de-archive from an XML Environment.

Reimplemented from DtReaderWriter.

virtual void DtRwUUID::getData ( const DtEnvironmentSP  ,
const DtEnvValueSP  ,
const SearchPaths &  searchPaths = SearchPaths(),
const DtVariableBindingsList &  bindings = DtVariableBindingsList() 
)
virtual

Gets data from the environment value.

Reimplemented from DtReaderWriter.

Reimplemented in DtRwScenarioEventUUID.

virtual void DtRwUUID::putSelf ( std::string &  fp,
int  indentLevel = 0,
bool  writeUnspecified = false,
const DtFilename &  path = DtFilename::nullFilename() 
)
virtual

Top level call to write itself to file. If write unspecified is true, will write entries that are unspecified, in the format (name <use-default>). Path is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the path is specified with a non-NULL string, then the path prepended to the filename before writing the entry to file.

Reimplemented from DtReaderWriter.

virtual void DtRwUUID::putSelf ( DtEnvironmentSP  ,
DtEnvValueSP  parent 
) const
virtual

Routines to archive/de-archive from an XML Environment.

Reimplemented from DtReaderWriter.

virtual void DtRwUUID::putData ( DtEnvironmentSP  ,
DtEnvValueSP  value 
) const
virtual

Override to add attributes of actual data.

Reimplemented from DtReaderWriter.

virtual void DtRwUUID::putData ( std::string &  fp,
int  indentLevel 
)
virtual

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

Reimplemented from DtReaderWriter.

virtual DtString DtRwUUID::prettyPrint ( ) const
virtual

Routine to return a human readable form of the reader/writer variable. Not all reader/writer classes implement this feature. Default is to return an empty string.

Reimplemented from DtReaderWriter.

virtual void DtRwUUID::noRwValueSpecified ( )
protectedvirtual

What to do if no reader/writer value is specified when restoring from file.

virtual void DtRwUUID::uuidChanged ( )
protectedvirtual

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

Implements DtUUIDOwner.

Member Data Documentation

DtUUID DtRwUUID::myUUID
mutableprotected
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)