VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions
DtRwEntityType Class Reference

File: rwEntType.h. More...

Inheritance diagram for DtRwEntityType:
Inheritance graph
[legend]

Public Member Functions

 DtRwEntityType (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
 default constructor
 DtRwEntityType (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 DtRwEntityType (const DtEntityType &entityType, const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 real constructor
 DtRwEntityType (const DtEntityType &entityType, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 DtRwEntityType (const DtString &name, const char *p, DtReaderWriterRegistry *const parentRegistry=NULL)
 other constructors to mimic DtEntityType
 DtRwEntityType (const DtSymbolString &name, const char *p, DtReaderWriterRegistry *const parentRegistry=NULL)
 DtRwEntityType (const DtString &name, int kind, int domain, int country, int category, int subCategory, int specific, int extra, DtReaderWriterRegistry *const parentRegistry=NULL)
 DtRwEntityType (const DtSymbolString &name, int kind, int domain, int country, int category, int subCategory, int specific, int extra, DtReaderWriterRegistry *const parentRegistry=NULL)
 DtRwEntityType (const DtRwEntityType &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
DtRwEntityTypeoperator= (const DtRwEntityType &orig)
 assignment: assigns value only
DtEntityType & operator= (const DtEntityType &orig)
 assign from a DtEntityType
virtual ~DtRwEntityType ()
virtual bool operator< (const DtEntityType &type) const
 <= returns 1 if object is prior to specified argument when in
virtual void putData (FILE *fp, int indentlLevel=0)
 Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.
virtual const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
virtual DtString prettyPrint () const
 Routine to return a human readable form of this variable.
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream.
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object.
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object.
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
virtual bool variableIsBound () const
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false.
virtual void setName (const DtString &)
 Set the name of the object.
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children.
virtual std::list
< DtVariableNameType
unboundVariables () const
bool invalid () const
virtual bool hasChild (const DtReaderWriter *p) const
 Returns true if this variable has a child p in it's chain.
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void setIsVariableReference (bool value)
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
 The variable name, if this object is a variable reference.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

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::pair
< DtSymbolString, DtString
DtVariableNameType
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (FILE *fp, int indentLevel)
static const
DtVariableBindingsList
nullVariableReference ()
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename & appPath ()
 Gets the current working directory.
static DtReaderWriterFactoryfactory ()
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object.
bool myInvalid
 Set to true if there is a problem reading this item.
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
static DtGetSelfCallbackInfo thePostGetSelfCallback
static DtPutSelfCallbackInfo thePrePutSelfCallback
static const DtVariableBindingsList theEmptyVariableBindingsList
static DtReaderWriterFactory theFactory

Detailed Description

File: rwEntType.h.

Class: DtRwEntityType

Description:

Constructor & Destructor Documentation

DtRwEntityType::DtRwEntityType ( const DtString name = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = NULL 
)

default constructor

DtRwEntityType::DtRwEntityType ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
)
DtRwEntityType::DtRwEntityType ( const DtEntityType &  entityType,
const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
)

real constructor

DtRwEntityType::DtRwEntityType ( const DtEntityType &  entityType,
const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
)
DtRwEntityType::DtRwEntityType ( const DtString name,
const char *  p,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)

other constructors to mimic DtEntityType

DtRwEntityType::DtRwEntityType ( const DtSymbolString name,
const char *  p,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
DtRwEntityType::DtRwEntityType ( const DtString name,
int  kind,
int  domain,
int  country,
int  category,
int  subCategory,
int  specific,
int  extra,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
DtRwEntityType::DtRwEntityType ( const DtSymbolString name,
int  kind,
int  domain,
int  country,
int  category,
int  subCategory,
int  specific,
int  extra,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
DtRwEntityType::DtRwEntityType ( const DtRwEntityType orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor

virtual DtRwEntityType::~DtRwEntityType ( )
virtual

Member Function Documentation

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

assignment: assigns value only

DtEntityType& DtRwEntityType::operator= ( const DtEntityType &  orig)

assign from a DtEntityType

virtual bool DtRwEntityType::operator< ( const DtEntityType &  type) const
virtual

<= returns 1 if object is prior to specified argument when in

sorted order; returns 0 otherwise. Sorting is on multiple keys – kind, domain, country, category, subcategory, specific, and extra, in that order.

virtual void DtRwEntityType::putData ( FILE *  fp,
int  indentLevel = 0 
)
virtual

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

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtRwEntityType::getData ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
)
virtual

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

Reimplemented from DtReaderWriter.

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

virtual DtString DtRwEntityType::prettyPrint ( ) const
virtual

Routine to return a human readable form of this variable.

Reimplemented from DtReaderWriter.


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

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)