DtFormationType Class Reference

Readable, Writable DtAggregateFormationType. More...

Inheritance diagram for DtFormationType:

Public Member Functions
	DtFormationType ()
	default constructor
	DtFormationType (int type)
	type only constructor
	DtFormationType (DtString &type)
	type only constructor
	DtFormationType (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	real constructor
	DtFormationType (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtFormationType (const DtSymbolString &name, int type, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtFormationType (const DtString &name, int type, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtFormationType (const DtFormationType &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
	copy constructor
const DtFormationType &	operator= (const DtFormationType &orig)
	assign to DtFormationType
virtual	~DtFormationType ()
virtual	operator const DtAggregateFormation () const
	additional operator overrides
DtAggregateFormation	operator= (DtAggregateFormation orig)
	assign from DtAggregateFormation enumeration
virtual int	operator== (DtAggregateFormation rhs) const
virtual int	operator!= (DtAggregateFormation rhs) const
virtual int	value () const
virtual void	setValue (int value)
virtual DtString	string () const
	get string representation
virtual void	putData (FILE *fp, int indentLevel=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 int	getValueFromString (DtString value)
	Returns the formation type if a valid formation string is given, otherwise returns -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.

Static Public Member Functions
static const DtString &	columnFormationString ()
static const DtString &	lineFormationString ()
static const DtString &	veeFormationString ()
static const DtString &	wedgeFormationString ()
static const DtString &	assemblyFormationString ()
static const DtString &	otherFormationString ()
static const DtString &	userFormationString ()
static int	userFormationTypeOffset ()
	Starting value for the index into the user defined formations.
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
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
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
int	myValue
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
static const DtString	DtColumnFormationString
	These are the string representations of the formation types that are shown in the interface and stored in the epd.
static const DtString	DtLineFormationString
static const DtString	DtVeeFormationString
static const DtString	DtWedgeFormationString
static const DtString	DtAssemblyFormationString
static const DtString	DtOtherFormationString
static const DtString	DtUserFormationString
static const int	UserFormationTypeOffset
	Starting value for the index into the user defined formations.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

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

Detailed Description

Readable, Writable DtAggregateFormationType.

Constructor & Destructor Documentation

DtFormationType::DtFormationType

(

)

default constructor

DtFormationType::DtFormationType

(

int

type

)

type only constructor

DtFormationType::DtFormationType

(

DtString &

type

)

type only constructor

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

real constructor

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

DtFormationType::DtFormationType	(	const DtSymbolString &	name,
		int	type,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

DtFormationType::DtFormationType	(	const DtString &	name,
		int	type,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

DtFormationType::DtFormationType	(	const DtFormationType &	orig,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

copy constructor

virtual DtFormationType::~DtFormationType ( )

virtual

Member Function Documentation

const DtFormationType& DtFormationType::operator=

(

const DtFormationType &

orig

)

assign to DtFormationType

virtual DtFormationType::operator const DtAggregateFormation ( ) const

virtual

additional operator overrides

conversion to DtAggregateFormation operator

DtAggregateFormation DtFormationType::operator=

(

DtAggregateFormation

orig

)

assign from DtAggregateFormation enumeration

virtual int DtFormationType::operator== ( DtAggregateFormation  rhs ) const

virtual

virtual int DtFormationType::operator!= ( DtAggregateFormation  rhs ) const

virtual

virtual int DtFormationType::value ( ) const

virtual

virtual void DtFormationType::setValue ( int  value )

virtual

virtual DtString DtFormationType::string ( ) const

virtual

get string representation

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

virtual

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

Reimplemented from DtReaderWriter.

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

virtual

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

Reimplemented from DtReaderWriter.

virtual int DtFormationType::getValueFromString ( DtString  value )

virtual

Returns the formation type if a valid formation string is given, otherwise returns -1.

virtual const char* DtFormationType::readerWriterType ( ) const

protectedvirtual

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.

static const DtString& DtFormationType::columnFormationString ( )

static

static const DtString& DtFormationType::lineFormationString ( )

static

static const DtString& DtFormationType::veeFormationString ( )

static

static const DtString& DtFormationType::wedgeFormationString ( )

static

static const DtString& DtFormationType::assemblyFormationString ( )

static

static const DtString& DtFormationType::otherFormationString ( )

static

static const DtString& DtFormationType::userFormationString ( )

static

static int DtFormationType::userFormationTypeOffset ( )

static

Starting value for the index into the user defined formations.

Member Data Documentation

int DtFormationType::myValue

protected

const DtString DtFormationType::DtColumnFormationString

staticprotected

These are the string representations of the formation types that are shown in the interface and stored in the epd.

const DtString DtFormationType::DtLineFormationString

staticprotected

const DtString DtFormationType::DtVeeFormationString

staticprotected

const DtString DtFormationType::DtWedgeFormationString

staticprotected

const DtString DtFormationType::DtAssemblyFormationString

staticprotected

const DtString DtFormationType::DtOtherFormationString

staticprotected

const DtString DtFormationType::DtUserFormationString

staticprotected

const int DtFormationType::UserFormationTypeOffset

staticprotected

Starting value for the index into the user defined formations.

---

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

• include/vrfutil/formType.h