DtRwObjectType Class Reference

class DtRwObjectType: More...

Inheritance diagram for DtRwObjectType:

Public Member Functions
	DtRwObjectType (const DtSymbolString &rwSymbolString, DtReaderWriterRegistry *const parentRegistry=NULL)
	real constructors - Set up to perform reader/writer operations correctly.
	DtRwObjectType (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwObjectType (const DtSymbolString &name, int superType, int kind, int domain, int country, int category, int subCategory, int specific, int extra, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwObjectType (const DtString &name, int superType, int kind, int domain, int country, int category, int subCategory, int specific, int extra, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwObjectType (const DtString &name, int superType, const DtEntityType &entityType, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwObjectType (const DtSymbolString &name, int superType, const DtEntityType &entityType, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwObjectType (const DtObjectType &objectType, const DtSymbolString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwObjectType (const DtObjectType &objectType, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwObjectType ()
	destructor
	DtRwObjectType (const DtRwObjectType &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtRwObjectType (const DtRwObjectType &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
DtRwObjectType &	operator= (const DtRwObjectType &orig)
	assignment operator: assigns value only
DtObjectType &	operator= (const DtObjectType &type)
	assignment from a DtObjectType.
virtual void	putData (FILE *fp, int indentlLevel=0)
	Overridden to write and read the new field (as local data) from/to file.
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.
Public Member Functions inherited from DtObjectType
	DtObjectType ()
	DtObjectType (int superType, int kind, int domain, int country, int category, int subCategory, int specific, int extra)
	DtObjectType (int superType, const DtEntityType &entityType)
virtual	~DtObjectType ()
	DtObjectType (const DtObjectType &orig)
virtual void	setSuperType (int type)
virtual int	superType () const
virtual const char *	string (char sep= ':') const
virtual int	operator< (const DtObjectType &type) const
virtual bool	matchPattern (const DtObjectType &pat) const
virtual int	match (const DtObjectType &type) const
virtual int	operator== (const DtObjectType &type) const
virtual int	operator!= (const DtObjectType &type) const
int &	operator[] (int)
const int	operator[] (int) const
bool	hasWildCard () const
	Returns true if any element is -1.
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 DtReaderWriter &	operator= (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 aliasContainer &	aliases () 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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	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 DtObjectType
static const DtObjectType &	nullType ()
static const DtObjectType &	anyType ()
static const DtObjectType &	individualType ()
static const DtObjectType &	aggregateType ()
static const DtObjectType &	pseudoAggregateType ()
static const DtObjectType &	individualLifeformType ()
static const DtObjectType &	individualPlatformType ()
static const DtObjectType &	individualCulturalFeatureType ()
static const DtObjectType &	individualMunitionType ()
static const DtObjectType &	textType ()
static const DtObjectType &	markerType ()
static const DtObjectType &	controlPointType ()
static const DtObjectType &	routeType ()
static const DtObjectType &	controlAreaType ()
static const DtObjectType &	obstacleType ()
static const DtObjectType &	disaggregationAreaType ()
static const DtObjectType &	phaseLineType ()
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 DtReaderWriterFactory *	factory ()
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 DtObjectType
int	mySuperType
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

class DtRwObjectType:

Instances of DtRwObjectType are readable/writeable DtObjectTypes.

Constructor & Destructor Documentation

DtRwObjectType::DtRwObjectType	(	const DtSymbolString &	rwSymbolString,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

real constructors - Set up to perform reader/writer operations correctly.

DtRwObjectType::DtRwObjectType	(	const DtString &	name = DtString::nullString(),
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

DtRwObjectType::DtRwObjectType	(	const DtSymbolString &	name,
		int	superType,
		int	kind,
		int	domain,
		int	country,
		int	category,
		int	subCategory,
		int	specific,
		int	extra,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

DtRwObjectType::DtRwObjectType	(	const DtString &	name,
		int	superType,
		int	kind,
		int	domain,
		int	country,
		int	category,
		int	subCategory,
		int	specific,
		int	extra,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

DtRwObjectType::DtRwObjectType	(	const DtString &	name,
		int	superType,
		const DtEntityType &	entityType,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

DtRwObjectType::DtRwObjectType	(	const DtSymbolString &	name,
		int	superType,
		const DtEntityType &	entityType,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

DtRwObjectType::DtRwObjectType	(	const DtObjectType &	objectType,
		const DtSymbolString &	name = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtRwObjectType::DtRwObjectType	(	const DtObjectType &	objectType,
		const DtString &	name = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtRwObjectType::~DtRwObjectType ( )

virtual

destructor

DtRwObjectType::DtRwObjectType	(	const DtRwObjectType &	orig,
		const DtString &	name = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

DtRwObjectType::DtRwObjectType	(	const DtRwObjectType &	orig,
		const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Member Function Documentation

DtRwObjectType& DtRwObjectType::operator=

(

const DtRwObjectType &

orig

)

assignment operator: assigns value only

DtObjectType& DtRwObjectType::operator=

(

const DtObjectType &

type

)

assignment from a DtObjectType.

Reimplemented from DtObjectType.

virtual void DtRwObjectType::putData ( FILE *  fp, int  indentlLevel = 0  )

virtual

Overridden to write and read the new field (as local data) from/to file.

Format for the type is as follows: ("name" <super type>=""> (<kind> <domn> <cntry> <cat> <subcat> <spec> <ext>)) If an older entity type is detected, loads in the entity type specific fields automatically.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtRwObjectType::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* DtRwObjectType::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.

---

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

• include/vrfutil/rwObjType.h