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 | Protected Member Functions | Protected Attributes | Private Member Functions
DtRwPropertiesFixedArray Class Reference

Acts as a fixed array for properties. This is essentially the same as a DtRwPropertiesList, except that the number of entries is fixed and the size is not encoded on the network.

The fixed array is defined in reader/writer as (in this example the array has 4 entries):

(DtRwFixedArray NameOfProperty 4
(DtRwStruct ArrayItem
(DtRwReal Param1)
(DtRwInt Param2)
)
("First" (100.0 20)) ("Second" (200.0 40)) ("Third" (300.0 60)) ("Fourth" (400.0 80))
)
For a single variable (not a structure) a fixed array (with 5 entries) would look like:
(DtRwFixedArray NameOfProperty 5 DtRwReal 1.0 2.1 3.2 4.3 5.4)

As a subclass of DtRwProperties, DtRwPropertiesFixedArray supports an STL-like iterator for iterating over its items. Please also see DtRwPropertiesList for further convenience functions.

Inheritance diagram for DtRwPropertiesFixedArray:
Inheritance graph
[legend]

Public Member Functions

virtual void setFixedSize (unsigned s)
 
virtual void setFixedSize (unsigned s, const DtPropertyInterface *prototype)
 
virtual const charreaderWriterType () const override
 
virtual const charxmlType () const override
 
virtual charencode (char *) const override
 
virtual const chardecode (const char *) override
 
virtual void getSize (int &size) const override
 
virtual bool isSimilarProperty (const DtPropertyInterface *rhs, bool strict=true) const override
 
bool operator== (const DtRwPropertiesFixedArray &) const
 
Constructors
 DtRwPropertiesFixedArray (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertiesFixedArray (const DtString &name, const DtString &keyType, const DtPropertyInterface *prototype, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertiesFixedArray (const DtString &name, const DtRwPropertiesFixedArray &orig, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtRwPropertiesFixedArray () override
 
- Public Member Functions inherited from DtRwPropertiesList
virtual int hlaAlignment () const override
 
virtual bool isValidProperty (const DtPropertyInterface *) const override
 
virtual int count () const override
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) override
 
virtual void writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) override
 
virtual void writeData (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) override
 
virtual void setPrototype (const DtPropertyInterface *)
 
virtual const DtPropertyInterfaceprototype () const
 
DtRwPropertiesListoperator= (const DtRwPropertiesList &)
 
bool operator== (const DtRwPropertiesList &) const
 
virtual bool matchPrototype (const DtReaderWriter *) const
 
 DtRwPropertiesList (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertiesList (const DtString &name, const DtPropertyInterface *prototype, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwPropertiesList (const DtString &name, const DtRwPropertiesList &orig, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtRwPropertiesList () override
 
- Public Member Functions inherited from DtRwProperties
DtRwPropertiesoperator= (const DtRwProperties &orig)
 
virtual ~DtRwProperties () override
 
virtual unsigned size () const
 
virtual bool addProperty (DtPropertyInterface *) override
 
virtual bool addPropertyAtIndex (DtPropertyInterface *, unsigned index)
 
virtual void copy (const DtPropertyInterface &rhs) override
 
virtual DtPropertyInterfacecreateProperty (DtlObjPtr args, DtReaderWriterRegistry *parentRegistry)
 
virtual void copyVariables (const DtRwVariableBindings &other) override
 
virtual bool isReadonly () const
 
virtual int requiredPadding (const char *buf, const DtPropertyInterface *field) const
 
virtual const charpropertyType () const override
 
virtual DtString stringRep (const DtString &root="") const override
 
virtual bool merge (const DtPropertyInterface &target, MergeFlags, const DtMergePath &path=DtMergePath(), const std::set< DtString > &ignore=std::set< DtString >()) override
 
virtual DtRwProperties createFromPercentages (const DtRwProperties &percentages, const DtRwProperties &baseValues, const DtString &base="Base-")
 
virtual bool findRootAndVariable (const DtString &varName, DtReaderWriter *&root, DtReaderWriter *&variable) const
 
virtual DtSymbolString propertyName () const override
 
virtual void setPropertyName (const DtString &propertyName) override
 
virtual bool isUpdateNeeded (DtTime t) const override
 
virtual bool hasReceivedUpdateSince (DtTime t) const override
 
virtual DtTime updateClockTime () const override
 
virtual void clearVariables () override
 
virtual void reset () override
 
virtual void invalidateCache ()
 
virtual void invalidateCacheForProperty (const DtString &propName)
 
virtual bool setWritePrototypeHeader (bool)
 
virtual bool writePrototypeHeader () const
 
virtual void setKeepPublishingSettings (bool keep) override
 
virtual bool keepPublishingSettings () const override
 
 DtRwProperties (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwProperties (const DtString &name, const DtRwProperties &orig, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwProperties (const DtRwProperties &orig, DtReaderWriterRegistry *parentRegistry=0)
 
virtual const_iterator begin () const
 
virtual iterator begin ()
 
virtual const_iterator end () const
 
virtual iterator end ()
 
virtual const DtPropertyInterfacefindPropertyInterface (const DtString &propertyName) const override
 
virtual DtPropertyInterfacefindPropertyInterface (const DtString &propertyName) override
 
virtual bool removeProperty (const DtString &propertyName) override
 
virtual bool removeProperty (const DtPropertyInterface *property) override
 
virtual const DtReaderWriterfindPropertyRw (const DtString &propName) const
 
virtual DtReaderWriterfindPropertyRw (const DtString &propName)
 
virtual DtReaderWriterreaderWriter () override
 
virtual const DtReaderWriterreaderWriter () const override
 
virtual DtPropertyInterfaceproperty () override
 
virtual const DtPropertyInterfaceproperty () const override
 
virtual bool isPublished () const override
 
virtual void setIsPublished (bool isPub) override
 
virtual unsigned disRecordType () const override
 
virtual void setDisRecordType (unsigned recType) override
 
virtual void removeVariable (DtReaderWriter *) override
 
virtual void removeVariable (const DtReaderWriter *) override
 
- Public Member Functions inherited from DtRwVariableBindings
 DtRwVariableBindings (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwVariableBindings (const DtString &name, const DtRwVariableBindings &orig, DtReaderWriterRegistry *parentRegistry=0, bool copyVariables=true)
 
 DtRwVariableBindings (const DtRwVariableBindings &orig, DtReaderWriterRegistry *parentRegistry=0, bool copyVariables=true)
 
DtRwVariableBindingsoperator= (const DtRwVariableBindings &orig)
 
virtual ~DtRwVariableBindings () override
 
template<typename RW_Type >
const RW_Type * findAndCastVariableBinding (const DtString &variableName) const
 
virtual DtReaderWriteraddVariableBinding (const DtSymbolString &name, const char *type)
 
virtual void addVariable (DtReaderWriter *)
 
virtual int getSize () const
 
bool operator== (const DtRwVariableBindings &) const
 
bool operator!= (const DtRwVariableBindings &) const
 
virtual DtString prettyPrint () const override
 
virtual void setVariableSubstitutions (const std::map< DtString, DtString > &)
 
virtual const std::map
< DtString, DtString > & 
variableSubstitutions () const
 
virtual void merge (const DtRwVariableBindings &)
 
virtual const DtReaderWriterfindVariableBinding (const DtString &rwTypeString, const DtString &variableName, const std::map< DtString, DtString > &variableSubstitutions=std::map< DtString, DtString >()) const
 
virtual DtReaderWriterfindVariableBinding (const DtString &rwTypeString, const DtString &variableName, const std::map< DtString, DtString > &variableSubstitutions=std::map< DtString, DtString >())
 
virtual const DtReaderWriterfindVariableBinding (const DtString &variableName, const std::map< DtString, DtString > &variableSubstitutions=std::map< DtString, DtString >()) const
 
virtual DtReaderWriterfindVariableBinding (const DtString &variableName, const std::map< DtString, DtString > &variableSubstitutions=std::map< DtString, DtString >())
 
- 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 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 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 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 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 getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 
- Public Member Functions inherited from DtPropertyInterface
virtual ~DtPropertyInterface ()
 
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)
 
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)
 
template<typename SpecificPropType >
SpecificPropType * addNewProperty (const DtString &propertyName)
 
int getSize () const
 

Static Public Member Functions

static const chartheXmlType ()
 
- Static Public Member Functions inherited from DtRwPropertiesList
static const chartheXmlType ()
 
- Static Public Member Functions inherited from DtRwProperties
static
DtReaderWriterPropertyFactory
propertyFactory ()
 
static void cleanupPropertyFactory ()
 
static const DtRwPropertiesemptyProperties ()
 
static bool rollUpInteger (const DtReaderWriter *source, DtReaderWriter *destination, const DtMergePath &path)
 
static bool rollUpReal (const DtReaderWriter *source, DtReaderWriter *destination, const DtMergePath &path)
 
static bool rollUpString (const DtReaderWriter *source, DtReaderWriter *destination, const DtMergePath &path)
 
static bool rollUpBoolean (const DtReaderWriter *source, DtReaderWriter *destination, const DtMergePath &path)
 
- Static Public Member Functions inherited from DtRwVariableBindings
static DtRwVariableBindingscreateBinding (const std::list< DtReaderWriter::DtVariableNameType > &)
 
- 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)
 

Protected Member Functions

virtual DtPropertyInterfacecreatePrototype (DtlObjPtr args) override
 
virtual DtlObjPtr variablesStart (DtlObjPtr args) const override
 
virtual int hlaAlignment (const DtPropertyInterface *field) const override
 
virtual DtPropertyInterfaceclonePrototype (DtReaderWriterRegistry *parent=0) override
 
- Protected Member Functions inherited from DtRwPropertiesList
virtual void writePrototype (const DtReaderWriter *, std::string &fp, int indentLevel, bool writeHeader=true) const
 
virtual void bindToRwAsVariable (const DtReaderWriter *rw) override
 
virtual void createListEntry (DtPropertyInterface *iFace, DtlObjPtr variableItem, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual const chardecode (DtPropertyInterface *, const char *) override
 
virtual DtlObjPtr getData (DtlObjPtr variableList, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
 
virtual void getData (const DtEnvironmentSP env, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) override
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const override
 
virtual void assignPrototypeToChildren ()
 
virtual void setPrototypeIntoTarget (const DtPropertyInterface *prototype, DtReaderWriter *target)
 
virtual void postWriteItem (std::string &fp, DtReaderWriter *rw, int indentLevel)
 
virtual void preWriteItem (std::string &fp, DtReaderWriter *rw, int indentLevel)
 
virtual bool matchPrototype (const DtReaderWriter *prototype, const DtReaderWriter *match) const
 
virtual void cloneAndAddProperty (const DtReaderWriter &rw) override
 
- Protected Member Functions inherited from DtRwProperties
virtual void filterIgnoredProperties (DtReaderWriter *rw, const std::set< DtString > &ignore)
 
virtual void getInterface (DtPropertyInterface *pFace, DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
virtual void putData (std::string &, int indentLevel=0) override
 
virtual void getSize (const DtPropertyInterface *, int &size) const
 
virtual charencode (const DtPropertyInterface *, char *buf) const
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) override
 
virtual bool traverseAndModifyPercentage (DtRwProperties &results, const DtRwProperties &baseValues, const DtReaderWriter *percentage, const DtString &base) const
 
virtual void writePrototypeHeader (std::string &fp, const DtReaderWriter *rw, int indentLevel) const
 
virtual void writePropertyData (DtReaderWriter *rw, std::string &fp, int indentLevel, bool writeUnspecified, const DtFilename &path)
 
virtual void writePublishInformation (std::string &fp, int indentLevel) override
 
virtual void getSortedProperties (const DtRwVariableBindings &varBindings, std::vector< const DtReaderWriter * > &propertyList) const
 
virtual void getSortedProperties (DtRwVariableBindings &varBindings, std::vector< DtReaderWriter * > &propertyList)
 
virtual bool isDebugEnabled () const override
 
virtual void setDebugEnabled (bool en) override
 
- Protected Member Functions inherited from DtRwVariableBindings
virtual const DtReaderWriterinternalFindVariableBinding (const DtString &rwTypeString, const DtString &variableName, const std::map< DtString, DtString > &variableSubstitutions=std::map< DtString, DtString >()) const
 
virtual bool keywordMatches (const DtSymbolString &lhs, const DtString &rhs, const std::map< DtString, DtString > &variableSubstitutions) const
 

Protected Attributes

unsigned myNextPropertyIndex
 
- Protected Attributes inherited from DtRwPropertiesList
DtPropertyInterfacemyPrototype
 
DtRwPropertyInt myCount
 
- Protected Attributes inherited from DtRwProperties
std::multimap< DtString,
DtReaderWriter * > 
myRwPropertyCache
 
tbb::spin_mutex * myCacheMutex
 
DtClock myClock
 
DtTime myLastTimeSizeChanged
 
int mySizeAtLastCheck
 
unsigned myDisRecordType
 
bool myIsPublished
 
bool myWritePrototypeHeader
 
bool myDebugEnabled
 
bool myKeepPublishingSettingsOnCopy
 
DtPropertyInterfacemyPreviousParentProp
 
DtString myPreviousParentPropFullName
 
- Protected Attributes inherited from DtRwVariableBindings
std::map< DtString, DtStringmyVariableSubstitutions
 
- 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
 

Private Member Functions

 DtRwPropertiesFixedArray ()
 
virtual bool addItem (DtPropertyInterface *item) override
 
virtual DtPropertyInterfaceaddItem () override
 
virtual void erase (DtPropertyInterface *item) override
 
virtual void erase (iterator pos) override
 

Additional Inherited Members

- Public Types inherited from DtRwProperties
typedef DtPropertiesIterator iterator
 
typedef DtPropertiesConstIterator const_iterator
 
- 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
}
 
- Static Protected Attributes inherited from DtRwProperties
static
DtReaderWriterPropertyFactory
thePropertyFactory
 
- 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

DtRwPropertiesFixedArray::DtRwPropertiesFixedArray ( )
private

Not implemented.

DtRwPropertiesFixedArray::DtRwPropertiesFixedArray ( const DtString name,
DtReaderWriterRegistry parentRegistry = 0 
)
DtRwPropertiesFixedArray::DtRwPropertiesFixedArray ( const DtString name,
const DtString keyType,
const DtPropertyInterface prototype,
DtReaderWriterRegistry parentRegistry = 0 
)
DtRwPropertiesFixedArray::DtRwPropertiesFixedArray ( const DtString name,
const DtRwPropertiesFixedArray orig,
DtReaderWriterRegistry parentRegistry = 0 
)
virtual DtRwPropertiesFixedArray::~DtRwPropertiesFixedArray ( )
overridevirtual

Member Function Documentation

virtual void DtRwPropertiesFixedArray::setFixedSize ( unsigned  s)
virtual

Sets the fixed size of the array, creating or deleting items as necessary using the prototype item of the list.

virtual void DtRwPropertiesFixedArray::setFixedSize ( unsigned  s,
const DtPropertyInterface prototype 
)
virtual

Sets the fixed size of the array, creating or deleting items as necessary using the specified prototype item.

virtual const char* DtRwPropertiesFixedArray::readerWriterType ( ) const
overridevirtual

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

static const char* DtRwPropertiesFixedArray::theXmlType ( )
static

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

virtual const char* DtRwPropertiesFixedArray::xmlType ( ) const
inlineoverridevirtual

Reimplemented from DtRwPropertiesList.

References DtRwPropertiesList::theXmlType().

virtual char* DtRwPropertiesFixedArray::encode ( char ) const
overridevirtual

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

virtual const char* DtRwPropertiesFixedArray::decode ( const char )
overridevirtual

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

Reimplemented from DtRwPropertiesList.

virtual void DtRwPropertiesFixedArray::getSize ( int size) const
overridevirtual

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

Reimplemented from DtRwPropertiesList.

virtual bool DtRwPropertiesFixedArray::isSimilarProperty ( const DtPropertyInterface rhs,
bool  strict = true 
) const
overridevirtual

Returns true prototype is the same.

Reimplemented from DtRwPropertiesList.

bool DtRwPropertiesFixedArray::operator== ( const DtRwPropertiesFixedArray ) const
virtual DtPropertyInterface* DtRwPropertiesFixedArray::createPrototype ( DtlObjPtr  args)
overrideprotectedvirtual

Get the fixed size before processing the rest of the items.

Reimplemented from DtRwPropertiesList.

virtual DtlObjPtr DtRwPropertiesFixedArray::variablesStart ( DtlObjPtr  args) const
overrideprotectedvirtual

Reimplemented from DtRwPropertiesList.

virtual int DtRwPropertiesFixedArray::hlaAlignment ( const DtPropertyInterface field) const
overrideprotectedvirtual

Reimplemented from DtRwProperties.

virtual DtPropertyInterface* DtRwPropertiesFixedArray::clonePrototype ( DtReaderWriterRegistry parent = 0)
overrideprotectedvirtual

For most property lists, this function returns a clone of the prototype that belongs to the list. Because fixed arrays always have a fixed size, this simply returns the next unused item in the list, if there is one. This should not be used except in reading saved values from a file.

Reimplemented from DtRwPropertiesList.

virtual bool DtRwPropertiesFixedArray::addItem ( DtPropertyInterface item)
inlineoverrideprivatevirtual

Items cannot be added to a fixed array.

Reimplemented from DtRwPropertiesList.

virtual DtPropertyInterface* DtRwPropertiesFixedArray::addItem ( )
inlineoverrideprivatevirtual

Items cannot be added to a fixed array.

Reimplemented from DtRwPropertiesList.

virtual void DtRwPropertiesFixedArray::erase ( DtPropertyInterface item)
inlineoverrideprivatevirtual

Items cannot be removed from a fixed array.

Reimplemented from DtRwPropertiesList.

virtual void DtRwPropertiesFixedArray::erase ( iterator  pos)
inlineoverrideprivatevirtual

Items cannot be removed from a fixed array.

Reimplemented from DtRwPropertiesList.

Member Data Documentation

unsigned DtRwPropertiesFixedArray::myNextPropertyIndex
protected

The index to the next item to be loaded during reading.


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

Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)