VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes
DtSetDesignatorRequest Class Reference

DtSetDesignatorRequest is used to set the designator for an entity. More...

Inheritance diagram for DtSetDesignatorRequest:
Inheritance graph
[legend]

Public Member Functions

 DtSetDesignatorRequest ()
 default constructor
 DtSetDesignatorRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 constructor If you have a request 'put' itself, the writeName will preface it.
 DtSetDesignatorRequest (const DtString &writeName, const DtSetDesignatorRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const DtSetDesignatorRequestoperator= (const DtSetDesignatorRequest &orig)
 assignment operator
virtual ~DtSetDesignatorRequest ()
virtual const DtSetMessageTypetype () const
 Returns DtSetDesignatorRequestType.
virtual DtSetDataRequestclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
 Creates a copy of the request.
virtual DtString stringRep () const
 Get a readable string representation of this setDataRequest.
virtual int designator () const
 In meters/second.
virtual void setDesignator (int designator)
virtual int netRepSize () const
 Returns the size of the full network representation padded to an 8-byte boundary.
virtual bool setFromNet (const char *contentBuffer, unsigned contentSize)
 Fills in the task from the network buffer.
virtual bool setToNet ()
 Fills in the network buffer (created by base class simTask) with the task contents.
- Public Member Functions inherited from DtSetDataRequest
virtual ~DtSetDataRequest ()
 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 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 actual 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 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 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 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.

Static Public Member Functions

static DtSetDataRequestcreator ()
- Static Public Member Functions inherited from DtSetDataRequest
static DtSetDataRequestcreateSetDataRequest (DtlObjPtr mtlStream)
 Static functions.
static DtSetDataRequestcreateSetDataRequest (DtSetMessageType requestType)
static void addSetDataRequestCreatorFcn (const DtSetMessageType &setDataName, DtSetDataRequestCreatorFcn fcn)
static void setFactory (DtSetDataRequestFactory *factory)
static DtSetDataRequestFactoryfactory ()
static bool isTypeRegistered (DtSetMessageType setDataType)
- 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.

Protected Attributes

DtRwInt myDesignator
- Protected Attributes inherited from DtSetDataRequest
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
- Protected Member Functions inherited from DtSetDataRequest
 DtSetDataRequest ()
 Constructors are protected because no one should instantiate the base class, just derived versions.
 DtSetDataRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 constructor If you have a request 'put' itself, the write name will preface it.
 DtSetDataRequest (const DtString &writeName, const DtSetDataRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const DtSetDataRequestoperator= (const DtSetDataRequest &orig)
 assignment operator; same as copy costructor.
virtual char * createNetworkBuffer ()
 int setDataType);
- Static Protected Attributes inherited from DtSetDataRequest
static DtSetDataRequestFactorymyFactory

Detailed Description

DtSetDesignatorRequest is used to set the designator for an entity.

The organization controller on the target will lookup it echelon and catagory, and use this number to create it's echelon id.

Constructor & Destructor Documentation

DtSetDesignatorRequest::DtSetDesignatorRequest ( )

default constructor

DtSetDesignatorRequest::DtSetDesignatorRequest ( const DtString writeName,
DtReaderWriterRegistry parentRegistry = 0 
)

constructor If you have a request 'put' itself, the writeName will preface it.

DtSetDesignatorRequest::DtSetDesignatorRequest ( const DtString writeName,
const DtSetDesignatorRequest orig,
DtReaderWriterRegistry parentRegistry = 0 
)

copy constructor

virtual DtSetDesignatorRequest::~DtSetDesignatorRequest ( )
virtual

Member Function Documentation

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

assignment operator

virtual const DtSetMessageType& DtSetDesignatorRequest::type ( ) const
virtual

Returns DtSetDesignatorRequestType.

Implements DtSetDataRequest.

virtual DtSetDataRequest* DtSetDesignatorRequest::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = 0 
) const
virtual

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetDesignatorRequest::stringRep ( ) const
virtual

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual int DtSetDesignatorRequest::designator ( ) const
virtual

In meters/second.

virtual void DtSetDesignatorRequest::setDesignator ( int  designator)
virtual
virtual int DtSetDesignatorRequest::netRepSize ( ) const
virtual

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSetDataRequest.

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

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetDesignatorRequest::setToNet ( )
virtual

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtSetDataRequest.

static DtSetDataRequest* DtSetDesignatorRequest::creator ( )
static

Member Data Documentation

DtRwInt DtSetDesignatorRequest::myDesignator
protected

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)