DtIndirectArtilleryComponent Class Reference

End User Description: This actuator is used on indirect artillery objects, typically ellipses, which are set to create a number of artillery detonations above the terrain at a specified time in the scenario. More...

Inheritance diagram for DtIndirectArtilleryComponent:

List of all members.

Public Member Functions
virtual	~DtIndirectArtilleryComponent (void)
	destructor
virtual bool	init ()
	Overridden to cache a pointer to the entity's radio in this class.
virtual bool	createPSR ()
	Creates myProcessState data member, and adds it to our process state repository manager.
virtual DtString	type () const
	return DtIndirectArtilleryActuatorType
virtual void	tick ()
	Calculate new kinematic state.
Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject *object, DtSimManager *simManager, DtComponentDescriptor *compDescriptor, DtReaderWriterRegistry *parentRegistry)
	Creator function to be registered with the DtSimComponentFactory -- see main.cxx.
static void	requestIndirectArtilleryInformationCallback (const DtVrfObjectMessage *msg, void *usr)
Protected Member Functions
	DtIndirectArtilleryComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	Constructor hiddent to force use of create.
	DtIndirectArtilleryComponent (const DtIndirectArtilleryComponent &orig)
	Copy constructor hiddent to force use of create.
virtual DtIndirectArtilleryComponent const &	operator= (const DtIndirectArtilleryComponent &rhs)
	assignment operator
virtual void	setCoords (DtTime t)
	Performs set up information at start of simulation. Called by the first execution of tick.
virtual void	setEllipseData (const DtIfIndirectArtilleryData &data)
virtual void	processModifyCallback (const DtIfIndirectArtilleryData &data)
virtual void	processRequestIndirectArtilleryInformation (const DtVrfObjectMessage *msg)
virtual void	sendCurrentState ()
	Send message containing current state of the object.
virtual bool	isDataDifferent (const DtIfIndirectArtilleryData &data) const
	Returns true if the data being set is different than what is stored.
Static Protected Member Functions
static void	modifyCallBack (DtSimMessage *msg, void *usr)
Private Attributes
bool	myDataInitialized
	Flag to indicate if sumlation has started.
bool	myDataModified
	Flag to indicate if data has been modified.
std::vector< DtVector >	myVertices
	Copy of vertices stored in the ellipse.
DtIndirectArtilleryPSR *	myProcessState
	Container for state data associated with this component.
std::vector< double >	myBurstTimes
	The exact times of the bursts. Equal to startTime + N * period + DtRand() * spreadTime.
DtVector	myCenter
	The center of the ellipse.
DtVector	myMajor
	The major axis of the ellipse, actually just the first axis.
DtVector	myMinor
	The minor axis of the ellipse, acctually the orthoganal axis.

---

Detailed Description

End User Description: This actuator is used on indirect artillery objects, typically ellipses, which are set to create a number of artillery detonations above the terrain at a specified time in the scenario.

Uses Descriptor Type: DtActuatorComponentDescriptor

---

Constructor & Destructor Documentation

DtIndirectArtilleryComponent::DtIndirectArtilleryComponent	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		[protected]

Constructor hiddent to force use of create.

DtIndirectArtilleryComponent::DtIndirectArtilleryComponent

(

const DtIndirectArtilleryComponent &

orig

)

[protected]

Copy constructor hiddent to force use of create.

virtual DtIndirectArtilleryComponent::~DtIndirectArtilleryComponent

(

void

)

[virtual]

destructor

---

Member Function Documentation

virtual DtIndirectArtilleryComponent const& DtIndirectArtilleryComponent::operator=

(

const DtIndirectArtilleryComponent &

rhs

)

[protected, virtual]

assignment operator

virtual bool DtIndirectArtilleryComponent::init

(

)

[virtual]

Overridden to cache a pointer to the entity's radio in this class.

Reimplemented from DtActuatorComponent.

virtual bool DtIndirectArtilleryComponent::createPSR

(

)

[virtual]

Creates myProcessState data member, and adds it to our process state repository manager.

Passes in the name and type specified in the component descriptor (if they exist) to the DtVrfProcessStateRepository::createRepository factory method. If name and/or type is not specified, uses the appropriate default strings defined in procSRTypes.h.

virtual DtString DtIndirectArtilleryComponent::type

(

)

const [virtual]

return DtIndirectArtilleryActuatorType

Reimplemented from DtSimComponent.

virtual void DtIndirectArtilleryComponent::tick

(

)

[virtual]

Calculate new kinematic state.

Reimplemented from DtSimComponent.

static DtSimComponent* DtIndirectArtilleryComponent::creator	(	const DtString &	name,
		DtVrfObject *	object,
		DtSimManager *	simManager,
		DtComponentDescriptor *	compDescriptor,
		DtReaderWriterRegistry *	parentRegistry
	)		[static]

Creator function to be registered with the DtSimComponentFactory -- see main.cxx.

static void DtIndirectArtilleryComponent::requestIndirectArtilleryInformationCallback	(	const DtVrfObjectMessage *	msg,
		void *	usr
	)		[static]

virtual void DtIndirectArtilleryComponent::setCoords

(

DtTime

t

)

[protected, virtual]

Performs set up information at start of simulation. Called by the first execution of tick.

virtual void DtIndirectArtilleryComponent::setEllipseData

(

const DtIfIndirectArtilleryData &

data

)

[protected, virtual]

static void DtIndirectArtilleryComponent::modifyCallBack	(	DtSimMessage *	msg,
		void *	usr
	)		[static, protected]

virtual void DtIndirectArtilleryComponent::processModifyCallback

(

const DtIfIndirectArtilleryData &

data

)

[protected, virtual]

virtual void DtIndirectArtilleryComponent::processRequestIndirectArtilleryInformation

(

const DtVrfObjectMessage *

msg

)

[protected, virtual]

virtual void DtIndirectArtilleryComponent::sendCurrentState

(

)

[protected, virtual]

Send message containing current state of the object.

virtual bool DtIndirectArtilleryComponent::isDataDifferent

(

const DtIfIndirectArtilleryData &

data

)

const [protected, virtual]

Returns true if the data being set is different than what is stored.

Used by processModifyCallback to see if data need to be resent

---

Member Data Documentation

bool DtIndirectArtilleryComponent::myDataInitialized [private]

Flag to indicate if sumlation has started.

bool DtIndirectArtilleryComponent::myDataModified [private]

Flag to indicate if data has been modified.

std::vector<DtVector> DtIndirectArtilleryComponent::myVertices [private]

Copy of vertices stored in the ellipse.

We use these to test whether we need to recompute our basis vectors

DtIndirectArtilleryPSR* DtIndirectArtilleryComponent::myProcessState [private]

Container for state data associated with this component.

This state is saved and restored as part of a scenario (or checkpoint).

std::vector<double> DtIndirectArtilleryComponent::myBurstTimes [private]

The exact times of the bursts. Equal to startTime + N * period + DtRand() * spreadTime.

DtVector DtIndirectArtilleryComponent::myCenter [private]

The center of the ellipse.

DtVector DtIndirectArtilleryComponent::myMajor [private]

The major axis of the ellipse, actually just the first axis.

DtVector DtIndirectArtilleryComponent::myMinor [private]

The minor axis of the ellipse, acctually the orthoganal axis.

---

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

• include/vrfmodel/indirectArtilleryActuator.h