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 | Static Public Member Functions
DtRwPropertySizedString Class Reference
Inheritance diagram for DtRwPropertySizedString:
Inheritance graph
[legend]

Public Member Functions

 DtRwPropertySizedString (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertySizedString (const DtString &name, const DtString &value, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertySizedString (const DtString &name, const DtRwPropertySizedString &orig, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertySizedString (const DtRwPropertySizedString &orig, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtRwPropertySizedString ()
 
virtual char * encode (char *) const
 
virtual const char * decode (const char *)
 
virtual void getSize (int &size) const
 
virtual int hlaAlignment () const
 
const char * readerWriterType () const
 
virtual const char * xmlType () const
 
- Public Member Functions inherited from DtRwPropertyString
 DtRwPropertyString (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertyString (const DtString &name, const DtString &value, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertyString (const DtString &name, const DtRwPropertyString &orig, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertyString (const DtRwPropertyString &orig, DtReaderWriterRegistry *parentRegistry=0)
 
DtRwPropertyString & operator= (const DtRwPropertyString &orig)
 
virtual ~DtRwPropertyString ()
 
- Public Member Functions inherited from DtRwProperty< DtRwString >
 DtRwProperty (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwProperty (const DtString &name, const DtRwProperty &orig, DtReaderWriterRegistry *parentRegistry=0)
 
DtRwProperty & operator= (const DtRwProperty &orig)
 
virtual ~DtRwProperty ()
 
virtual void copy (const DtPropertyInterface &rhs)
 
virtual DtString stringRep (const DtString &root="") const
 
virtual const char * propertyType () const
 
virtual DtSymbolString propertyName () const
 
virtual void setPropertyName (const DtString &propertyName)
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=DtReaderWriter::nullVariableReference())
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual bool merge (const DtPropertyInterface &target, MergeFlags, const DtMergePath &path=DtMergePath(), const std::set< DtString > &ignore=std::set< DtString >())
 
virtual void recordUpdateTime () const
 
virtual bool isUpdateNeeded (DtTime t) const
 
virtual bool hasReceivedUpdateSince (DtTime t) const
 
virtual DtTime updateClockTime () const
 
virtual void reset ()
 
virtual void setKeepPublishingSettings (bool keep)
 
virtual bool keepPublishingSettings () const
 
virtual DtReaderWriter * readerWriter ()
 
virtual const DtReaderWriter * readerWriter () const
 
virtual DtPropertyInterface * property ()
 
virtual const DtPropertyInterface * property () const
 
virtual bool isPublished () const
 
virtual void setIsPublished (bool isPub)
 
virtual unsigned disRecordType () const
 
virtual void setDisRecordType (unsigned recType)
 
virtual bool isDebugEnabled () const
 
virtual void setDebugEnabled (bool en)
 
- Public Member Functions inherited from DtRwString
 DtRwString ()
 
 DtRwString (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwString (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwString (const DtString &name, const char *fromChars, DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwString (const DtSymbolString &name, const char *fromChars, DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwString (const DtString &name, const DtString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwString (const DtSymbolString &name, const DtString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwString (const DtString &name, const DtRwString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwString (const DtSymbolString &name, const DtRwString &fromString, DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwString (const DtRwString &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
 
DtRwString & operator= (const DtRwString &orig)
 
DtRwString & operator= (const char *orig)
 
DtRwString & operator= (const DtString &orig)
 
DtRwString & operator= (const DtSymbolString &orig)
 
virtual ~DtRwString ()
 
virtual void putData (std::string &fp, int indentLevel=0)
 
virtual DtString unsubstitutedString () const
 
virtual void setUnsubstitutedString (const DtString &)
 
virtual bool containsVariableSubstitutions () const
 
virtual DtString prettyPrint () const
 
virtual int alignment () const
 
bool operator== (const DtRwString &) const
 
bool operator== (const DtString &) const
 
bool operator!= (const DtString &rhs) const
 
bool operator!= (const DtRwString &rhs) const
 
bool operator== (const char *) const
 
bool operator!= (const char *rhs) const
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
- 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) const
 
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 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 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 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 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 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)
 
- Public Member Functions inherited from DtPropertyInterface
virtual ~DtPropertyInterface ()
 
virtual bool isSimilarProperty (const DtPropertyInterface *rhs, bool strict=true) const
 
virtual bool isPublishedArg (DtlObjPtr arg, unsigned &disVarRecType)
 
virtual void copyPublishingSettings (const DtPropertyInterface &prop)
 
virtual void processPublicationArgs (DtlObjPtr arg)
 
virtual void processPublicationArg (DtlObjPtr arg)
 
template<typename ValueType >
boost::optional< ValueType > propertyValue () const
 
template<typename ValueType >
bool setPropertyValue (ValueType val)
 
virtual const DtPropertyInterface * findPropertyInterface (const DtString &propertyName) const
 
virtual DtPropertyInterface * findPropertyInterface (const DtString &propertyName)
 
template<typename SpecificPropType >
const SpecificPropType * findProperty (const DtString &propertyName) const
 
template<typename SpecificPropType >
SpecificPropType * findProperty (const DtString &propertyName)
 
template<typename ValueType >
boost::optional< ValueType > findPropertyValue (const DtString &propertyName) const
 
template<typename ValueType >
bool findAndSetPropertyValue (const DtString &propertyName, ValueType val)
 
virtual bool addProperty (DtPropertyInterface *property)
 
template<typename SpecificPropType >
SpecificPropType * addNewProperty (const DtString &propertyName)
 
virtual bool removeProperty (const DtString &propertyName)
 
virtual bool removeProperty (const DtPropertyInterface *property)
 
int getSize () const
 

Static Public Member Functions

static const char * theXmlType ()
 
- Static Public Member Functions inherited from DtRwString
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)
 

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 )()
 
- Public Types inherited from DtPropertyInterface
enum  MergeFlags {
  Replace = 0x00000001, MinimalSimilarityCheck = 0x00000002, RollUp = 0x00000004, AddMissing = 0x00000008,
  KeepPublishedSettings = 0x00000010
}
 
- Protected Member Functions inherited from DtRwString
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 
- Protected Attributes inherited from DtRwProperty< DtRwString >
DtClock myClock
 
DtTime myUpdateTime
 
unsigned myDisRecordType
 
bool myIsPublished
 
bool myKeepPublishingSettingsOnCopy
 
bool myDebugEnabled
 
- Protected Attributes inherited from DtRwString
DtString myUnsubstitutedString
 
- 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
 
- 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

DtRwPropertySizedString::DtRwPropertySizedString ( const DtString &  name,
DtReaderWriterRegistry *  parentRegistry = 0 
)
DtRwPropertySizedString::DtRwPropertySizedString ( const DtString &  name,
const DtString &  value,
DtReaderWriterRegistry *  parentRegistry = 0 
)
DtRwPropertySizedString::DtRwPropertySizedString ( const DtString &  name,
const DtRwPropertySizedString &  orig,
DtReaderWriterRegistry *  parentRegistry = 0 
)
DtRwPropertySizedString::DtRwPropertySizedString ( const DtRwPropertySizedString &  orig,
DtReaderWriterRegistry *  parentRegistry = 0 
)
virtual DtRwPropertySizedString::~DtRwPropertySizedString ( )
virtual

Member Function Documentation

virtual char* DtRwPropertySizedString::encode ( char *  ) const
virtual

Encodes the property into the supplied buffer. Does not align the property. Buffer must already be aligned correctly based on the hlaAlignment() value of this property.

Reimplemented from DtRwProperty< DtRwString >.

virtual const char* DtRwPropertySizedString::decode ( const char *  )
virtual

Decodes the property from the specified buffer. Assumes buffer is the start of the property and preceding padding has been skipped.

Reimplemented from DtRwProperty< DtRwString >.

virtual void DtRwPropertySizedString::getSize ( int &  size) const
virtual

Adds the network size of this item in bytes. This does not include any upfront padding for alignment.

Reimplemented from DtRwProperty< DtRwString >.

virtual int DtRwPropertySizedString::hlaAlignment ( ) const
virtual

Returns alignment necessary to encode this item in HLA.

Reimplemented from DtRwProperty< DtRwString >.

const char* DtRwPropertySizedString::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 DtRwString.

static const char* DtRwPropertySizedString::theXmlType ( )
static
virtual const char* DtRwPropertySizedString::xmlType ( ) const
inlinevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtRwString.

References DtRwString::theXmlType().

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)