VR-Forces 5.0.2 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
DtRwPatchIdentifier Class Reference

Readable/writable form of DtPatchIdentifier.

Inheritance diagram for DtRwPatchIdentifier:
Inheritance graph
[legend]

Public Member Functions

 DtRwPatchIdentifier (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPatchIdentifier (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPatchIdentifier (const DtPatchIdentifier &id, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPatchIdentifier (const DtRwPatchIdentifier &orig, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtRwPatchIdentifier ()
 
const DtRwPatchIdentifieroperator= (const DtRwPatchIdentifier &orig)
 
const DtRwPatchIdentifieroperator= (const DtPatchIdentifier &orig)
 
virtual DtRwPatchIdentifierclone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
 
virtual DtString prettyPrint () const
 
virtual const charreaderWriterType () const
 
virtual const charxmlType () const
 
virtual bool operator== (const DtRwPatchIdentifier &orig) const
 
virtual bool operator!= (const DtRwPatchIdentifier &orig) const
 
virtual bool operator== (const DtPatchIdentifier &orig) const
 
virtual bool operator!= (const DtPatchIdentifier &orig) const
 
virtual void putData (std::string &fp, int indentLevel=0)
 
virtual void putData (DtEnvironmentSP env, DtEnvValueSP value) const
 
virtual void getData (const DtEnvironmentSP env, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
- 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 &)
 
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)
 

Static Public Member Functions

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)
 

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 )()
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 
- 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

DtRwPatchIdentifier::DtRwPatchIdentifier ( const DtString name = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)

Default CTOR.

DtRwPatchIdentifier::DtRwPatchIdentifier ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = 0 
)

Alternate default CTOR.

DtRwPatchIdentifier::DtRwPatchIdentifier ( const DtPatchIdentifier &  id,
const DtString name = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)

Real CTOR.

DtRwPatchIdentifier::DtRwPatchIdentifier ( const DtRwPatchIdentifier orig,
DtReaderWriterRegistry parentRegistry = 0 
)

Copy CTOR.

virtual DtRwPatchIdentifier::~DtRwPatchIdentifier ( )
virtual

DTOR.

Member Function Documentation

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

Assignment Operator (DtRwPatchIdentifier).

const DtRwPatchIdentifier& DtRwPatchIdentifier::operator= ( const DtPatchIdentifier &  orig)

Assignment Operator (DtPatchIdentifier).

virtual bool DtRwPatchIdentifier::operator== ( const DtRwPatchIdentifier orig) const
virtual

Equality operators (DtRwPatchIdentifier).

virtual bool DtRwPatchIdentifier::operator!= ( const DtRwPatchIdentifier orig) const
virtual

Equality operators (DtRwPatchIdentifier).

virtual bool DtRwPatchIdentifier::operator== ( const DtPatchIdentifier &  orig) const
virtual

Equality operators (DtPatchIdentifier).

virtual bool DtRwPatchIdentifier::operator!= ( const DtPatchIdentifier &  orig) const
virtual

Equality operators (DtPatchIdentifier).

virtual DtRwPatchIdentifier* DtRwPatchIdentifier::clone ( const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
) const
virtual

Clone method.

virtual void DtRwPatchIdentifier::putData ( std::string &  fp,
int  indentLevel = 0 
)
virtual

Read/write methods.

Reimplemented from DtReaderWriter.

virtual void DtRwPatchIdentifier::putData ( DtEnvironmentSP  env,
DtEnvValueSP  value 
) const
virtual

Read/write methods.

Reimplemented from DtReaderWriter.

virtual void DtRwPatchIdentifier::getData ( const DtEnvironmentSP  env,
const DtEnvValueSP  value,
const DtReaderWriter::SearchPaths searchPaths,
const DtVariableBindingsList bindings 
)
virtual

Read/write methods.

Reimplemented from DtReaderWriter.

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

Read/write methods.

Reimplemented from DtReaderWriter.

virtual DtString DtRwPatchIdentifier::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 const char* DtRwPatchIdentifier::readerWriterType ( ) const
virtual

The type corresponding to this reader writer.

Reimplemented from DtReaderWriter.

static const char* DtRwPatchIdentifier::theXmlType ( )
static

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

virtual const char* DtRwPatchIdentifier::xmlType ( ) const
inlinevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().


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

Document ID: Generated on Sun Dec 4 20:22:03 EST 2022 from SVN revision 249613
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)