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 Attributes
DtRwTemplatedPair< FirstType, SecondType > Class Template Reference
Inheritance diagram for DtRwTemplatedPair< FirstType, SecondType >:
Inheritance graph
[legend]

Public Member Functions

virtual ~DtRwTemplatedPair ()
 
DtRwTemplatedPair & operator= (const DtRwTemplatedPair &orig)
 
bool operator== (const DtRwTemplatedPair &) const
 
virtual const FirstType & first () const
 
virtual void setFirst (const FirstType &f)
 
virtual const SecondType & second () const
 
virtual void setSecond (const SecondType &s)
 
 DtRwTemplatedPair ()
 
 DtRwTemplatedPair (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL, const DtString &firstName="first", const DtString &secondName="second")
 
 DtRwTemplatedPair (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL, const DtString &firstName="first", const DtString &secondName="second")
 
 DtRwTemplatedPair (const DtRwTemplatedPair &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
 
virtual DtString firstName () const
 
virtual void setFirstName (const DtString &n)
 
virtual DtString secondName () const
 
virtual void setSecondName (const DtString &n)
 
- 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 wasUpdatedSince (DtTime t) const
 
virtual bool changedSinceLastChecked ()
 
virtual bool peekChangedSinceLastChecked () const
 
virtual void putData (std::string &fp, int indentLevel=0)
 
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
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)
 

Protected Attributes

FirstType myFirst
 
SecondType mySecond
 
- 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 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 DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 
- 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

template<typename FirstType, typename SecondType>
DtRwTemplatedPair< FirstType, SecondType >::DtRwTemplatedPair ( )

Constructors.

template<typename FirstType, typename SecondType>
DtRwTemplatedPair< FirstType, SecondType >::DtRwTemplatedPair ( const DtString &  name,
DtReaderWriterRegistry *const  parentRegistry = NULL,
const DtString &  firstName = "first",
const DtString &  secondName = "second" 
)

Constructors.

template<typename FirstType, typename SecondType>
DtRwTemplatedPair< FirstType, SecondType >::DtRwTemplatedPair ( const DtSymbolString &  name,
DtReaderWriterRegistry *const  parentRegistry = NULL,
const DtString &  firstName = "first",
const DtString &  secondName = "second" 
)

Constructors.

template<typename FirstType, typename SecondType>
DtRwTemplatedPair< FirstType, SecondType >::DtRwTemplatedPair ( const DtRwTemplatedPair< FirstType, SecondType > &  orig,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)

Constructors.

template<typename FirstType, typename SecondType>
virtual DtRwTemplatedPair< FirstType, SecondType >::~DtRwTemplatedPair ( )
inlinevirtual

Destructor.

Member Function Documentation

template<typename FirstType, typename SecondType>
DtRwTemplatedPair& DtRwTemplatedPair< FirstType, SecondType >::operator= ( const DtRwTemplatedPair< FirstType, SecondType > &  orig)

Assignment.

template<typename FirstType, typename SecondType>
bool DtRwTemplatedPair< FirstType, SecondType >::operator== ( const DtRwTemplatedPair< FirstType, SecondType > &  ) const

Equality.

template<typename FirstType, typename SecondType>
virtual const FirstType& DtRwTemplatedPair< FirstType, SecondType >::first ( ) const
inlinevirtual

Accessor for first.

References DtRwTemplatedPair< FirstType, SecondType >::myFirst.

template<typename FirstType, typename SecondType>
virtual void DtRwTemplatedPair< FirstType, SecondType >::setFirst ( const FirstType &  f)
virtual

Mutator for first.

template<typename FirstType, typename SecondType>
virtual const SecondType& DtRwTemplatedPair< FirstType, SecondType >::second ( ) const
inlinevirtual

Accessor for second.

References DtRwTemplatedPair< FirstType, SecondType >::mySecond.

template<typename FirstType, typename SecondType>
virtual void DtRwTemplatedPair< FirstType, SecondType >::setSecond ( const SecondType &  s)
virtual

Mutator for second.

template<typename FirstType, typename SecondType>
virtual DtString DtRwTemplatedPair< FirstType, SecondType >::firstName ( ) const
inlinevirtual

The RW name of the first item in this pair.

References DtRwTemplatedPair< FirstType, SecondType >::myFirst.

template<typename FirstType, typename SecondType>
virtual void DtRwTemplatedPair< FirstType, SecondType >::setFirstName ( const DtString &  n)
inlinevirtual

The RW name of the first item in this pair.

References DtRwTemplatedPair< FirstType, SecondType >::myFirst.

template<typename FirstType, typename SecondType>
virtual DtString DtRwTemplatedPair< FirstType, SecondType >::secondName ( ) const
inlinevirtual

The RW name of the second item in this pair.

References DtRwTemplatedPair< FirstType, SecondType >::mySecond.

template<typename FirstType, typename SecondType>
virtual void DtRwTemplatedPair< FirstType, SecondType >::setSecondName ( const DtString &  n)
inlinevirtual

The RW name of the second item in this pair.

References DtRwTemplatedPair< FirstType, SecondType >::mySecond.

Member Data Documentation

template<typename FirstType, typename SecondType>
FirstType DtRwTemplatedPair< FirstType, SecondType >::myFirst
protected

Referenced by DtRwTemplatedPair< FirstType, SecondType >::first(), DtRwTemplatedPair< FirstType, SecondType >::firstName(), and DtRwTemplatedPair< FirstType, SecondType >::setFirstName().

template<typename FirstType, typename SecondType>
SecondType DtRwTemplatedPair< FirstType, SecondType >::mySecond
protected

Referenced by DtRwTemplatedPair< FirstType, SecondType >::second(), DtRwTemplatedPair< FirstType, SecondType >::secondName(), and DtRwTemplatedPair< FirstType, SecondType >::setSecondName().

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)