DtSetDataRequest Class Reference

DtSetDataRequest is an abstract base class from which real setDataRequests can derive. More...

Inherits DtReaderWriter.

Inherited by BHAVE::DtSetBhaveMovementMode, BHAVE::DtSetScript, BHAVE::DtSetViewTarget, DtClearTask, DtDiGuySetAppearanceRequest, DtFireNowRequest, DtSetAggregateState, DtSetAltitudeRequest, DtSetAppearanceRequest, DtSetArmedRequest, DtSetAutoLaunchEnabledRequest, DtSetCapabilityRequest, DtSetChannelRequest, DtSetCollisionAvoidTypes, DtSetConcealedRequest, DtSetConvoyFollowTarget, DtSetDesignatorRequest, DtSetDestroyRequest, DtSetDetonate, DtSetEmitterRequest, DtSetEngagementRulesRequest, DtSetForceRequest, DtSetFormationRequest, DtSetFormationTypeRequest, DtSetHeadingRequest, DtSetIffRequest, DtSetJoyDeviceSwitchRequest, DtSetLaseAutonomousRequest, DtSetLaserCodeRequest, DtSetLifeFormPostureRequest, DtSetLifeFormWeaponStateRequest, DtSetLoadEntityRequest, DtSetLocationRequest, DtSetMovementStrategyRequest, DtSetNotifyLevel, DtSetRadarMode, DtSetReorganizeRequest, DtSetResourceRequest, DtSetRestoreRequest, DtSetScanSectorRequest, DtSetSpeedRequest, DtSetSpotReportingRequest, DtSetStayInLaneRequest, DtSetSurrenderRequest, DtSetSwitchSystem, DtSetSyncLaserCode, DtSetTargetRequest, DtSetTaskedBySuperiorRequest, DtSetUnloadEntityRequest, DtSetWarheadInfo, DtSnapIntoFormationRequest, and vrfAddSetExample::DtSetSpeedAndHeadingRequest.

List of all members.

Public Member Functions
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 int	type () const =0
	What kind of setDataRequest am I? (from setDtaTypes.h).
virtual DtSetDataRequest *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const =0
	Make a copy of this request.
virtual DtString	stringRep () const =0
	Get a readable string representation of this setDataRequest.
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 ()
Serialization Methods
These three methods must be overridden for any setRequest subclass that is going to be sent over the network and need to package their own data elements.
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Sets the contents of this set request based on the network buffer.
virtual bool	setToNet ()
	Sets netRep buffer to the contents of this set request.
Static Public Member Functions
static DtSetDataRequest *	createSetDataRequest (DtlObjPtr mtlStream)
	Static functions.
static DtSetDataRequest *	createSetDataRequest (int requestType)
static void	addSetDataRequestCreatorFcn (const DtString &setDataName, int setDataType, DtSetDataRequestCreatorFcn fcn)
static void	setFactory (DtSetDataRequestFactory *factory)
static DtSetDataRequestFactory *	factory ()
static bool	getSetDataNameFromSetDataType (int setDataType, DtString &setDataName)
static bool	getSetDataTypeFromSetDataName (const DtString &setDataName, int &setDataType)
Protected Member Functions
	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 DtSetDataRequest &	operator= (const DtSetDataRequest &orig)
	assignment operator; same as copy costructor.
virtual char *	createNetworkBuffer ()
	int setDataType);
Protected Attributes
char *	myNetRep
Static Protected Attributes
static DtSetDataRequestFactory *	myFactory

---

Detailed Description

DtSetDataRequest is an abstract base class from which real setDataRequests can derive.

It manages the read/write capability; derived classes need only use and register read/writatble data types for derived information.

The DtSetDataRequest class is derived from DtReaderWriter, from which it inherits the ability to read and write itself to a file. This capability is essential to being able to save and restore Set Data Request statements in a plan.

Examples

• Speed and Heading Request

---

Constructor & Destructor Documentation

DtSetDataRequest::DtSetDataRequest

(

)

[protected]

Constructors are protected because no one should instantiate the base class, just derived versions.

default constructor

DtSetDataRequest::DtSetDataRequest	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		[protected]

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

DtSetDataRequest::DtSetDataRequest	(	const DtString &	writeName,
		const DtSetDataRequest &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		[protected]

copy constructor

virtual DtSetDataRequest::~DtSetDataRequest

(

)

[virtual]

destructor

---

Member Function Documentation

const DtSetDataRequest& DtSetDataRequest::operator=

(

const DtSetDataRequest &

orig

)

[protected]

assignment operator; same as copy costructor.

virtual bool DtSetDataRequest::init

(

)

[virtual]

Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.

Reimplemented in DtSetNotifyLevel.

virtual int DtSetDataRequest::type

(

)

const [pure virtual]

What kind of setDataRequest am I? (from setDtaTypes.h).

Returns a string representing the kind of data request. Derived classes must implement this function to return a unique type. See setDtaTypes.h for a list of the Set Data Request types used in VR-Forces.

Implemented in DtSetScanSectorRequest, DtSetWarheadInfo, DtSetResourceRequest, DtSetEngagementRulesRequest, DtSetAltitudeRequest, DtSetLocationRequest, DtSetIffRequest, DtSnapIntoFormationRequest, DtSetHeadingRequest, DtSetLoadEntityRequest, vrfAddSetExample::DtSetSpeedAndHeadingRequest, DtClearTask, DtSetAppearanceRequest, DtSetCapabilityRequest, DtSetEmitterRequest, DtSetSpeedRequest, DtSetChannelRequest, DtSetFormationRequest, DtSetLifeFormPostureRequest, DtSetLifeFormWeaponStateRequest, DtSetSpotReportingRequest, DtFireNowRequest, DtSetForceRequest, DtSetFormationTypeRequest, DtSetLaseAutonomousRequest, DtSetStayInLaneRequest, DtSetConcealedRequest, DtSetDesignatorRequest, DtSetLaserCodeRequest, DtSetRestoreRequest, DtSetTaskedBySuperiorRequest, DtSetUnloadEntityRequest, DtSetDestroyRequest, DtSetCollisionAvoidTypes, DtSetSurrenderRequest, DtSetDetonate, DtSetJoyDeviceSwitchRequest, DtSetTargetRequest, DtSetArmedRequest, DtSetAutoLaunchEnabledRequest, DtSetReorganizeRequest, DtSetMovementStrategyRequest, DtSetNotifyLevel, DtSetAggregateState, DtSetConvoyFollowTarget, DtSetSwitchSystem, BHAVE::DtSetBhaveMovementMode, DtSetSyncLaserCode, DtSetRadarMode, BHAVE::DtSetScript, BHAVE::DtSetViewTarget, and DtDiGuySetAppearanceRequest.

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

Make a copy of this request.

Returns a pointer to a newly created copy of this data request. Derived classes must override this function to create and return an instance of the derived type.

Implemented in DtSetIffRequest, DtSetScanSectorRequest, DtSetCollisionAvoidTypes, DtSetWarheadInfo, DtSetResourceRequest, DtSetEmitterRequest, DtSetEngagementRulesRequest, DtSetAltitudeRequest, DtSetLocationRequest, DtSetLoadEntityRequest, DtSnapIntoFormationRequest, DtSetHeadingRequest, vrfAddSetExample::DtSetSpeedAndHeadingRequest, DtClearTask, DtSetAppearanceRequest, DtSetCapabilityRequest, DtSetSpeedRequest, DtSetChannelRequest, DtSetFormationRequest, DtSetLifeFormPostureRequest, DtSetLifeFormWeaponStateRequest, DtSetSpotReportingRequest, DtFireNowRequest, DtSetForceRequest, DtSetFormationTypeRequest, DtSetLaseAutonomousRequest, DtSetStayInLaneRequest, DtSetConcealedRequest, DtSetUnloadEntityRequest, DtSetDesignatorRequest, DtSetLaserCodeRequest, DtSetRestoreRequest, DtSetDestroyRequest, DtSetTaskedBySuperiorRequest, DtSetNotifyLevel, DtSetSurrenderRequest, DtSetDetonate, DtSetJoyDeviceSwitchRequest, DtSetTargetRequest, DtSetArmedRequest, DtSetAutoLaunchEnabledRequest, DtSetReorganizeRequest, DtSetMovementStrategyRequest, DtSetAggregateState, DtSetConvoyFollowTarget, DtSetSwitchSystem, BHAVE::DtSetBhaveMovementMode, DtSetSyncLaserCode, DtSetRadarMode, BHAVE::DtSetScript, BHAVE::DtSetViewTarget, and DtDiGuySetAppearanceRequest.

Referenced by BHAVE::BHAVE3DGui::DtCreateItemData::DtCreateItemData(), and BHAVE::BHAVE3DGui::DtCreateItemData::operator=().

virtual DtString DtSetDataRequest::stringRep

(

)

const [pure virtual]

Get a readable string representation of this setDataRequest.

Returns a human readable string representation of the Set Data Request. Derived classes must implement this function. The string should include the identity of the Set Data Request, along with any parameters. The format of the string is up to you. The plan viewer and editor use the string representation to display the type of task and its parameters.

Implemented in DtSetIffRequest, DtSetScanSectorRequest, DtSetCollisionAvoidTypes, DtSetWarheadInfo, DtSetResourceRequest, DtSetEmitterRequest, DtSetEngagementRulesRequest, DtSetAltitudeRequest, DtSetLocationRequest, DtSetLoadEntityRequest, DtSnapIntoFormationRequest, DtSetHeadingRequest, vrfAddSetExample::DtSetSpeedAndHeadingRequest, DtClearTask, DtSetAppearanceRequest, DtSetCapabilityRequest, DtSetSpeedRequest, DtSetChannelRequest, DtSetFormationRequest, DtSetLifeFormPostureRequest, DtSetLifeFormWeaponStateRequest, DtSetSpotReportingRequest, DtFireNowRequest, DtSetForceRequest, DtSetFormationTypeRequest, DtSetLaseAutonomousRequest, DtSetStayInLaneRequest, DtSetUnloadEntityRequest, DtSetConcealedRequest, DtSetDesignatorRequest, DtSetLaserCodeRequest, DtSetRestoreRequest, DtSetDestroyRequest, DtSetTaskedBySuperiorRequest, DtSetNotifyLevel, DtSetSurrenderRequest, DtSetDetonate, DtSetJoyDeviceSwitchRequest, DtSetTargetRequest, DtSetArmedRequest, DtSetAutoLaunchEnabledRequest, DtSetReorganizeRequest, DtSetMovementStrategyRequest, DtSetAggregateState, DtSetConvoyFollowTarget, DtSetSwitchSystem, BHAVE::DtSetBhaveMovementMode, DtSetSyncLaserCode, DtSetRadarMode, BHAVE::DtSetScript, BHAVE::DtSetViewTarget, and DtDiGuySetAppearanceRequest.

virtual void DtSetDataRequest::putData	(	FILE *	fp,
		int	indentLevel = 0
	)		[virtual]

putData writes our type, which is provided by the virtual type accessor of the deriving class.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtSetDataRequest::getData	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[virtual]

getData is just used to get us past the type in the data stream, since it's not actual stored.

virtual char* DtSetDataRequest::netRep

(

)

[virtual]

virtual int DtSetDataRequest::netRepSize

(

)

const [virtual]

Returns:

Size necessary for a network representation of this set request. Base class returns 0.

Reimplemented in DtSetIffRequest, DtSetWarheadInfo, DtSetScanSectorRequest, DtSnapIntoFormationRequest, DtSetSpotReportingRequest, DtSetResourceRequest, DtSetCollisionAvoidTypes, DtSetEngagementRulesRequest, DtSetLoadEntityRequest, DtSetLocationRequest, vrfAddSetExample::DtSetSpeedAndHeadingRequest, DtSetAltitudeRequest, DtSetFormationRequest, DtSetEmitterRequest, DtSetLifeFormPostureRequest, DtSetLifeFormWeaponStateRequest, DtClearTask, DtSetDetonate, DtSetHeadingRequest, DtSetSpeedRequest, DtSetStayInLaneRequest, DtSetAppearanceRequest, DtSetCapabilityRequest, DtSetFormationTypeRequest, DtFireNowRequest, DtSetChannelRequest, DtSetLaseAutonomousRequest, DtSetForceRequest, DtSetSwitchSystem, DtSetConcealedRequest, DtSetDesignatorRequest, DtSetLaserCodeRequest, DtSetConvoyFollowTarget, DtSetUnloadEntityRequest, DtSetTargetRequest, DtSetRestoreRequest, DtSetSurrenderRequest, DtSetDestroyRequest, DtSetTaskedBySuperiorRequest, DtSetJoyDeviceSwitchRequest, DtSetMovementStrategyRequest, DtSetNotifyLevel, DtSetArmedRequest, DtSetAutoLaunchEnabledRequest, DtSetAggregateState, DtSetRadarMode, DtSetReorganizeRequest, DtSetSyncLaserCode, BHAVE::DtSetBhaveMovementMode, BHAVE::DtSetScript, BHAVE::DtSetViewTarget, and DtDiGuySetAppearanceRequest.

virtual bool DtSetDataRequest::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)		[virtual]

Sets the contents of this set request based on the network buffer.

Base class does nothing and returns true.

Reimplemented in DtSetIffRequest, DtSetWarheadInfo, DtSetScanSectorRequest, DtSnapIntoFormationRequest, DtSetSpotReportingRequest, DtSetResourceRequest, DtSetCollisionAvoidTypes, DtSetLoadEntityRequest, DtSetEngagementRulesRequest, DtSetLocationRequest, vrfAddSetExample::DtSetSpeedAndHeadingRequest, DtSetAltitudeRequest, DtSetFormationRequest, DtSetEmitterRequest, DtSetLifeFormPostureRequest, DtSetLifeFormWeaponStateRequest, DtClearTask, DtSetDetonate, DtSetHeadingRequest, DtSetSpeedRequest, DtSetStayInLaneRequest, DtSetAppearanceRequest, DtSetCapabilityRequest, DtSetFormationTypeRequest, DtFireNowRequest, DtSetChannelRequest, DtSetLaseAutonomousRequest, DtSetForceRequest, DtSetSwitchSystem, DtSetConcealedRequest, DtSetDesignatorRequest, DtSetLaserCodeRequest, DtSetUnloadEntityRequest, DtSetConvoyFollowTarget, DtSetTargetRequest, DtSetRestoreRequest, DtSetSurrenderRequest, DtSetDestroyRequest, DtSetTaskedBySuperiorRequest, DtSetJoyDeviceSwitchRequest, DtSetMovementStrategyRequest, DtSetNotifyLevel, DtSetArmedRequest, DtSetAutoLaunchEnabledRequest, DtSetAggregateState, DtSetRadarMode, DtSetReorganizeRequest, DtSetSyncLaserCode, BHAVE::DtSetBhaveMovementMode, BHAVE::DtSetScript, BHAVE::DtSetViewTarget, and DtDiGuySetAppearanceRequest.

virtual bool DtSetDataRequest::setToNet

(

)

[virtual]

Sets netRep buffer to the contents of this set request.

Base class does nothing and returns true.

Reimplemented in DtSetIffRequest, DtSetWarheadInfo, DtSetScanSectorRequest, DtSnapIntoFormationRequest, DtSetSpotReportingRequest, DtSetLoadEntityRequest, DtSetResourceRequest, DtSetCollisionAvoidTypes, DtSetEngagementRulesRequest, DtSetLocationRequest, vrfAddSetExample::DtSetSpeedAndHeadingRequest, DtSetAltitudeRequest, DtSetFormationRequest, DtSetEmitterRequest, DtSetLifeFormPostureRequest, DtSetLifeFormWeaponStateRequest, DtClearTask, DtSetDetonate, DtSetHeadingRequest, DtSetSpeedRequest, DtSetStayInLaneRequest, DtSetAppearanceRequest, DtSetCapabilityRequest, DtSetFormationTypeRequest, DtFireNowRequest, DtSetChannelRequest, DtSetLaseAutonomousRequest, DtSetForceRequest, DtSetSwitchSystem, DtSetConcealedRequest, DtSetDesignatorRequest, DtSetLaserCodeRequest, DtSetUnloadEntityRequest, DtSetConvoyFollowTarget, DtSetTargetRequest, DtSetRestoreRequest, DtSetSurrenderRequest, DtSetDestroyRequest, DtSetTaskedBySuperiorRequest, DtSetJoyDeviceSwitchRequest, DtSetMovementStrategyRequest, DtSetArmedRequest, DtSetAutoLaunchEnabledRequest, DtSetNotifyLevel, DtSetAggregateState, DtSetRadarMode, DtSetReorganizeRequest, DtSetSyncLaserCode, BHAVE::DtSetBhaveMovementMode, BHAVE::DtSetScript, BHAVE::DtSetViewTarget, and DtDiGuySetAppearanceRequest.

static DtSetDataRequest* DtSetDataRequest::createSetDataRequest

(

DtlObjPtr

mtlStream

)

[static]

Static functions.

static DtSetDataRequest* DtSetDataRequest::createSetDataRequest

(

int

requestType

)

[static]

static void DtSetDataRequest::addSetDataRequestCreatorFcn	(	const DtString &	setDataName,
		int	setDataType,
		DtSetDataRequestCreatorFcn	fcn
	)		[static]

static void DtSetDataRequest::setFactory

(

DtSetDataRequestFactory *

factory

)

[static]

static DtSetDataRequestFactory* DtSetDataRequest::factory

(

)

[static]

Returns:

A pointer to the static DtReaderWriterFactory. This factory can create instances of DtReaderWriter subclasses that have been registered with it.

Reimplemented from DtReaderWriter.

static bool DtSetDataRequest::getSetDataNameFromSetDataType	(	int	setDataType,
		DtString &	setDataName
	)		[static]

static bool DtSetDataRequest::getSetDataTypeFromSetDataName	(	const DtString &	setDataName,
		int &	setDataType
	)		[static]

virtual char* DtSetDataRequest::createNetworkBuffer

(

)

[protected, virtual]

int setDataType);

---

Member Data Documentation

char* DtSetDataRequest::myNetRep [protected]

DtSetDataRequestFactory* DtSetDataRequest::myFactory [static, protected]

---

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

• include/vrftasks/setDataReq.h