DtSnapIntoFormationRequest Class Reference

DtSnapIntoFormationRequest is used to set the formation type for an (aggregate) entity. It inherits read/writableness from DtSetDataRequest. The name of the formation is specified in the request. All units, whether aggregate or disaggregated units (i.e. "pseudo aggregates") can have a formation. For pseudo-aggregates, this request causes the subordinate entities to be instantly moved to the formation positions described in the object parameter data-base. The Set request does the same thing as setFormationRequest except that it allows more formation parameters to be specified.

set-data-request-type: DtSnapIntoFormationRequestType

parameters: formation - A character string representing a formation type.
location - The location of the unit center.
heading - the heading of the unit (and the formation).
applyHeading - whether to apply the given heading to the subordinates as well as the overall formation.

Inheritance diagram for DtSnapIntoFormationRequest:

Public Member Functions
	DtSnapIntoFormationRequest ()
	DtSnapIntoFormationRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtSnapIntoFormationRequest (const DtString &writeName, const DtSnapIntoFormationRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSnapIntoFormationRequest &	operator= (const DtSnapIntoFormationRequest &orig)
virtual	~DtSnapIntoFormationRequest ()
virtual const DtSetMessageType &	type () const
virtual DtSetDataRequest *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	stringRep () const
virtual const DtVector &	location () const
virtual void	setLocation (const DtVector &point)
virtual double	heading () const
virtual void	setHeading (double heading)
virtual DtString	formationName () const
virtual void	setFormationName (const DtString &formation)
virtual void	setApplyHeading (bool applyHeading)
virtual bool	applyHeading () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
Public Member Functions inherited from DtSetDataRequest
virtual	~DtSetDataRequest ()
virtual bool	init ()
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual char *	netRep ()
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtSetDataRequest *	creator ()
Static Public Member Functions inherited from DtSetDataRequest
static DtSetDataRequest *	createSetDataRequest (DtlObjPtr mtlStream)
static DtSetDataRequest *	createSetDataRequest (DtSetMessageType requestType)
static void	addSetDataRequestCreatorFcn (const DtSetMessageType &setDataName, DtSetDataRequestCreatorFcn fcn)
static void	setFactory (DtSetDataRequestFactory *factory)
static DtSetDataRequestFactory *	factory ()
static bool	isTypeRegistered (DtSetMessageType setDataType)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Attributes
DtRwVector	myLocation
DtRwReal	myHeading
DtRwString	myFormationName
DtRwBoolean	myApplyHeading
Protected Attributes inherited from DtSetDataRequest
char *	myNetRep
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
bool	myInvalid
bool	myChangedFlag

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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Member Functions inherited from DtSetDataRequest
	DtSetDataRequest ()
	DtSetDataRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtSetDataRequest (const DtString &writeName, const DtSetDataRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSetDataRequest &	operator= (const DtSetDataRequest &orig)
virtual char *	createNetworkBuffer ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtSetDataRequest
static DtSetDataRequestFactory *	myFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtSnapIntoFormationRequest::DtSnapIntoFormationRequest

(

)

default constructor

DtSnapIntoFormationRequest::DtSnapIntoFormationRequest	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

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

DtSnapIntoFormationRequest::DtSnapIntoFormationRequest	(	const DtString &	writeName,
		const DtSnapIntoFormationRequest &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtSnapIntoFormationRequest::~DtSnapIntoFormationRequest ( )

virtual

Member Function Documentation

const DtSnapIntoFormationRequest& DtSnapIntoFormationRequest::operator=

(

const DtSnapIntoFormationRequest &

orig

)

assignment operator

virtual const DtSetMessageType& DtSnapIntoFormationRequest::type ( ) const

virtual

Returns DtSnapIntoFormationRequestType.

Implements DtSetDataRequest.

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

virtual

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSnapIntoFormationRequest::stringRep ( ) const

virtual

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual const DtVector& DtSnapIntoFormationRequest::location ( ) const

virtual

location (in geocentric coordinates) at which aggregate should get into formation

virtual void DtSnapIntoFormationRequest::setLocation ( const DtVector &  point )

virtual

virtual double DtSnapIntoFormationRequest::heading ( ) const

virtual

heading (in radians) at which aggregate should orient formation

virtual void DtSnapIntoFormationRequest::setHeading ( double  heading )

virtual

virtual DtString DtSnapIntoFormationRequest::formationName ( ) const

virtual

virtual void DtSnapIntoFormationRequest::setFormationName ( const DtString &  formation )

virtual

virtual void DtSnapIntoFormationRequest::setApplyHeading ( bool  applyHeading )

virtual

Indicate whether or not to set heading in subordinates.

virtual bool DtSnapIntoFormationRequest::applyHeading ( ) const

virtual

virtual int DtSnapIntoFormationRequest::netRepSize ( ) const

virtual

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

Reimplemented from DtSetDataRequest.

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

virtual

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSnapIntoFormationRequest::setToNet ( )

virtual

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

Reimplemented from DtSetDataRequest.

virtual void DtSnapIntoFormationRequest::getSelf ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths = DtReaderWriter::SearchPaths(), const DtVariableBindingsList &  variableBindings = nullVariableReference()  )

virtual

Overridden to read in the old formation enumeration and convert it to a formation name.

Reimplemented from DtReaderWriter.

static DtSetDataRequest* DtSnapIntoFormationRequest::creator ( )

static

Member Data Documentation

DtRwVector DtSnapIntoFormationRequest::myLocation

protected

DtRwReal DtSnapIntoFormationRequest::myHeading

protected

DtRwString DtSnapIntoFormationRequest::myFormationName

protected

DtRwBoolean DtSnapIntoFormationRequest::myApplyHeading

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrftasks/snapIntoFormationRequest.h