DtCreateObjectCommand Class Reference

DtSimCommand subclass for creating a new VrfObjects. More...

Inheritance diagram for DtCreateObjectCommand:

Public Member Functions
	DtCreateObjectCommand ()
	Default constructor.
	DtCreateObjectCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
	Usual constructor.
	DtCreateObjectCommand (const DtString &writeName, const DtCreateObjectCommand &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
virtual	~DtCreateObjectCommand ()
	destructor
DtCreateObjectCommand &	operator= (const DtCreateObjectCommand &orig)
	assignment operator
virtual const DtSimCommandMessageType &	type () const
virtual DtSimCommand *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual void	clearVertices ()
	Clears out all vertices.
virtual void	addVertex (const DtVector &vertex)
	Adds the specified vertex to the end of the vertex list.
virtual int	numberOfVertices () const
	Returns the number of vertices in the vertex list.
virtual DtVector	vertex (unsigned int index) const
	Returns the vertex at the specified index into the vertex list.
virtual bool	headingSpecified () const
virtual DtString	stringRep () const
	Text representation of this command.
virtual int	netRepSize () const
	Returns the size in bytes of the network representation of the class.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand).
virtual bool	setToNet ()
	Calls netRep() to create the network buffer.
virtual const std::list < DtAdminContent * > &	initialAdminContent () const
	Set any Admin Content messages passed on initialization.
virtual void	setInitialAdminContent (std::list< DtAdminContent * > adminContent)
virtual void	addInitialAdminContent (const DtAdminContent *adminContent)
virtual const std::list < DtSimInterfaceContent * > &	initialInterfaceContent () const
	Set any Interface Content messages passed on initialization.
virtual void	setInitialInterfaceContent (std::list< DtSimInterfaceContent * > adminContent)
virtual void	addInitialInterfaceContent (const DtSimInterfaceContent *adminContent)
virtual void	createAndAddAdminContentFromEncodedBuffer (const DtString &)
	Recreates admin content from the encoded buffer and adds it to the list.
virtual void	encodeAndAddAdminContent (const DtAdminContent *)
	Encodes admin content and adds to admin contents.
virtual void	createAndAddInterfaceContentFromEncodedBuffer (const DtString &)
	Recreates interface content from the encoded buffer and adds it to the list.
virtual void	encodeAndAddInterfaceContent (const DtSimInterfaceContent *)
	Encodes admin content and adds to interface contents.
virtual DtString	objectName () const
	Name of the object to create.
virtual void	setObjectName (const DtString &name)
	Name of the object to create.
virtual DtObjectType	objectType () const
	Type of object to create.
virtual void	setObjectType (const DtObjectType &objectType)
	Type of object to create.
virtual DtForceType	forceType () const
	Force of the object to create.
virtual void	setForceType (const DtForceType &force)
	Force of the object to create.
virtual DtReal	heading () const
	Heading of object to create.
virtual void	setHeading (DtReal heading)
	Heading of object to create.
virtual bool	closedFigure () const
	Indicated whether the object is a closed figure.
virtual void	setClosedFigure (bool closed)
	Indicated whether the object is a closed figure.
virtual bool	projected () const
	Indicated whether the object projected onto the terrain in the Z direction.
virtual void	setProjected (bool value)
	Indicated whether the object projected onto the terrain in the Z direction.
virtual bool	clampedToGround () const
	Indicated whether the object is clamped to terrain Applies only to entities.
virtual void	setClampedToGround (bool value)
	Indicated whether the object is clamped to terrain Applies only to entities.
virtual bool	aggregated () const
	Indicated whether the object is aggregated Is only meaningful with respect to aggregates.
virtual void	setAggregated (bool value)
	Indicated whether the object is aggregated Is only meaningful with respect to aggregates.
Public Member Functions inherited from DtSimCommand
virtual	~DtSimCommand ()
	destructor
virtual bool	init ()
	Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.
virtual DtSimCommand *	clone () const
	Version of clone that preserves the existing name, and assigns a null parent registry.
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual char *	netRep ()
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
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
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 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 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 void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
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 DtSimCommand *	creator ()
	Returns a new instance of this class.
Static Public Member Functions inherited from DtSimCommand
static DtSimCommand *	createSimCommand (DtlObjPtr mtlStream)
	Static functions.
static DtSimCommand *	createSimCommand (const DtSimCommandMessageType &simCommandType)
static void	addSimCommandCreatorFcn (const DtSimCommandMessageType &simCommandName, DtSimCommandCreatorFcn fcn)
	Adds a simCommand creator member function to the simCommand factory.
static void	setFactory (DtSimCommandFactory *factory)
static DtSimCommandFactory *	factory ()
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 void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()

Protected Member Functions
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
virtual char *	decodeBuffer (const DtString &) const
virtual DtString	encodeBuffer (const char *chr, int length) const
Protected Member Functions inherited from DtSimCommand
	DtSimCommand ()
	Constructors are protected because no one should instantiate the base class, just derived versions.
	DtSimCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a command 'put' itself, the write name will preface the command.
	DtSimCommand (const DtString &writeName, const DtSimCommand &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimCommand &	operator= (const DtSimCommand &orig)
	assignment operator; same as copy constructor
virtual char *	createNetworkBuffer ()
virtual bool	isTypeRegistered (const DtSimCommandMessageType &commandType)
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.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
DtRwString	myObjectName
DtRwObjectType	myObjectType
DtRwForceType	myForceType
DtRwTemplatedListPtr< DtRwVector >	myVertices
DtRwReal	myHeading
DtRwBoolean	myClosedFigure
DtRwBoolean	myProjected
DtRwBoolean	myClampedToGround
DtRwBoolean	myAggregated
DtRwStringList	myAdminContents
DtRwStringList	myInterfaceContents
std::list< DtAdminContent * >	myAdditionalAdminContent
	Local only. DtRwStringList keeps the string rep of all the commands.
std::list < DtSimInterfaceContent * >	myAdditionalInterfaceContent
	Local only. DtRwStringList keeps the string rep of all the commands.
Protected Attributes inherited from DtSimCommand
char *	myNetRep
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.

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
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Protected Attributes inherited from DtSimCommand
static DtSimCommandFactory *	myFactory

Detailed Description

DtSimCommand subclass for creating a new VrfObjects.

Used for both single and multi-point objects. Single point objects should specify just one vertex in the vertex list.

Constructor & Destructor Documentation

DtCreateObjectCommand::DtCreateObjectCommand

(

)

Default constructor.

DtCreateObjectCommand::DtCreateObjectCommand	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Usual constructor.

DtCreateObjectCommand::DtCreateObjectCommand	(	const DtString &	writeName,
		const DtCreateObjectCommand &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtCreateObjectCommand::~DtCreateObjectCommand ( )

virtual

destructor

Member Function Documentation

DtCreateObjectCommand& DtCreateObjectCommand::operator=

(

const DtCreateObjectCommand &

orig

)

assignment operator

virtual const DtSimCommandMessageType& DtCreateObjectCommand::type ( ) const

virtual

Returns

DtCreateObjectCommandType.

Implements DtSimCommand.

virtual DtSimCommand* DtCreateObjectCommand::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = 0  ) const

virtual

Returns

A new instance of this class, copied from the original.

Implements DtSimCommand.

virtual DtString DtCreateObjectCommand::objectName ( ) const

virtual

Name of the object to create.

The name is optional. If no name (or a NULL name) is specified, the system will auto-generate a name for the object.

virtual void DtCreateObjectCommand::setObjectName ( const DtString &  name )

virtual

Name of the object to create.

The name is optional. If no name (or a NULL name) is specified, the system will auto-generate a name for the object.

virtual DtObjectType DtCreateObjectCommand::objectType ( ) const

virtual

Type of object to create.

virtual void DtCreateObjectCommand::setObjectType ( const DtObjectType &  objectType )

virtual

Type of object to create.

virtual DtForceType DtCreateObjectCommand::forceType ( ) const

virtual

Force of the object to create.

virtual void DtCreateObjectCommand::setForceType ( const DtForceType &  force )

virtual

Force of the object to create.

virtual void DtCreateObjectCommand::clearVertices ( )

virtual

Clears out all vertices.

virtual void DtCreateObjectCommand::addVertex ( const DtVector &  vertex )

virtual

Adds the specified vertex to the end of the vertex list.

Vertices are specified in geocentric.

virtual int DtCreateObjectCommand::numberOfVertices ( ) const

virtual

Returns the number of vertices in the vertex list.

virtual DtVector DtCreateObjectCommand::vertex ( unsigned int  index ) const

virtual

Returns the vertex at the specified index into the vertex list.

Exceptions

DtException

if outside current vertex range (0 to numberOfVertices - 1) Vertices are specified in geocentric.

virtual DtReal DtCreateObjectCommand::heading ( ) const

virtual

Heading of object to create.

Only applicable to single-point objects. 0 is north, clockwise, in radians.

virtual void DtCreateObjectCommand::setHeading ( DtReal  heading )

virtual

Heading of object to create.

Only applicable to single-point objects. 0 is north, clockwise, in radians.

virtual bool DtCreateObjectCommand::headingSpecified ( ) const

virtual

Returns

True if a heading value has been specified.

virtual bool DtCreateObjectCommand::closedFigure ( ) const

virtual

Indicated whether the object is a closed figure.

Applies only to multi-point objects.

virtual void DtCreateObjectCommand::setClosedFigure ( bool  closed )

virtual

Indicated whether the object is a closed figure.

Applies only to multi-point objects.

virtual bool DtCreateObjectCommand::projected ( ) const

virtual

Indicated whether the object projected onto the terrain in the Z direction.

Applies only to control/overlay objects.

virtual void DtCreateObjectCommand::setProjected ( bool  value )

virtual

Indicated whether the object projected onto the terrain in the Z direction.

Applies only to control/overlay objects.

virtual bool DtCreateObjectCommand::clampedToGround ( ) const

virtual

Indicated whether the object is clamped to terrain Applies only to entities.

virtual void DtCreateObjectCommand::setClampedToGround ( bool  value )

virtual

Indicated whether the object is clamped to terrain Applies only to entities.

virtual bool DtCreateObjectCommand::aggregated ( ) const

virtual

Indicated whether the object is aggregated Is only meaningful with respect to aggregates.

virtual void DtCreateObjectCommand::setAggregated ( bool  value )

virtual

Indicated whether the object is aggregated Is only meaningful with respect to aggregates.

virtual DtString DtCreateObjectCommand::stringRep ( ) const

virtual

Text representation of this command.

Implements DtSimCommand.

virtual int DtCreateObjectCommand::netRepSize ( ) const

virtual

Returns the size in bytes of the network representation of the class.

This is the size in bytes of the DtNetSimSimCommand structure. Derived classes should take into acount the size returned by this class when overriding (they should call down to this class and add the result to their additional size).

Reimplemented from DtSimCommand.

virtual bool DtCreateObjectCommand::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand).

Derived classes should call down to this function first, and then extract their own data starting at the location contentBuffer + DtSimCommand::netRepSize().

Reimplemented from DtSimCommand.

virtual bool DtCreateObjectCommand::setToNet ( )

virtual

Calls netRep() to create the network buffer.

Casts the resulting myNetRep to type DtNetSimSimCommand*, and then sets the mySubsimCommand member in the DtNetSimSimCommand from mySubsimCommand. Derived classes should call down to the base class version of setToNet() at the start of the function (before doing any processing on the network representation) They can then start to fill in their network data, starting at the location myNetRep + DtSimCommand::netRepSize().

Reimplemented from DtSimCommand.

virtual const std::list<DtAdminContent*>& DtCreateObjectCommand::initialAdminContent ( ) const

virtual

Set any Admin Content messages passed on initialization.

virtual void DtCreateObjectCommand::setInitialAdminContent ( std::list< DtAdminContent * >  adminContent )

virtual

virtual void DtCreateObjectCommand::addInitialAdminContent ( const DtAdminContent *  adminContent )

virtual

virtual const std::list<DtSimInterfaceContent*>& DtCreateObjectCommand::initialInterfaceContent ( ) const

virtual

Set any Interface Content messages passed on initialization.

virtual void DtCreateObjectCommand::setInitialInterfaceContent ( std::list< DtSimInterfaceContent * >  adminContent )

virtual

virtual void DtCreateObjectCommand::addInitialInterfaceContent ( const DtSimInterfaceContent *  adminContent )

virtual

virtual void DtCreateObjectCommand::createAndAddAdminContentFromEncodedBuffer ( const DtString &  )

virtual

Recreates admin content from the encoded buffer and adds it to the list.

virtual void DtCreateObjectCommand::encodeAndAddAdminContent ( const DtAdminContent *  )

virtual

Encodes admin content and adds to admin contents.

virtual void DtCreateObjectCommand::createAndAddInterfaceContentFromEncodedBuffer ( const DtString &  )

virtual

Recreates interface content from the encoded buffer and adds it to the list.

virtual void DtCreateObjectCommand::encodeAndAddInterfaceContent ( const DtSimInterfaceContent *  )

virtual

Encodes admin content and adds to interface contents.

static DtSimCommand* DtCreateObjectCommand::creator ( )

static

Returns a new instance of this class.

virtual void DtCreateObjectCommand::getSelf ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

protectedvirtual

virtual char* DtCreateObjectCommand::decodeBuffer ( const DtString &  ) const

protectedvirtual

virtual DtString DtCreateObjectCommand::encodeBuffer ( const char *  chr, int  length  ) const

protectedvirtual

Member Data Documentation

DtRwString DtCreateObjectCommand::myObjectName

protected

DtRwObjectType DtCreateObjectCommand::myObjectType

protected

DtRwForceType DtCreateObjectCommand::myForceType

protected

DtRwTemplatedListPtr<DtRwVector> DtCreateObjectCommand::myVertices

protected

DtRwReal DtCreateObjectCommand::myHeading

protected

DtRwBoolean DtCreateObjectCommand::myClosedFigure

protected

DtRwBoolean DtCreateObjectCommand::myProjected

protected

DtRwBoolean DtCreateObjectCommand::myClampedToGround

protected

DtRwBoolean DtCreateObjectCommand::myAggregated

protected

DtRwStringList DtCreateObjectCommand::myAdminContents

protected

DtRwStringList DtCreateObjectCommand::myInterfaceContents

protected

std::list<DtAdminContent*> DtCreateObjectCommand::myAdditionalAdminContent

protected

Local only. DtRwStringList keeps the string rep of all the commands.

std::list<DtSimInterfaceContent*> DtCreateObjectCommand::myAdditionalInterfaceContent

protected

Local only. DtRwStringList keeps the string rep of all the commands.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfplan/createObjectCommand.h