DtBurstDescriptor Class Reference

Burst descriptors represent Fire and detonate descriptors in DIS and HLA. More...

Collaboration diagram for DtBurstDescriptor:

Public Member Functions
	DtBurstDescriptor ()
	DtBurstDescriptor (const DtNetBurstDescriptor *netBurst)
	operator DtNetBurstDescriptor () const
void	init (const DtEntityType *type, DtWarheadType warhead, DtDetonatorFuze fuze, int quantity, int rate)
void	init (const DtEntityType *type, DtExplosiveMaterial explosiveMaterial, float explosiveForce)
void	init (const DtEntityType *type)
virtual void	setEntityType (const DtEntityType &munition)
	This identifies the munitionType in a munition descriptor (Your Kind should be set to 2) The Expendable type in an expendable descriptor (Your Kind should be set to 8) The Exploding Object Type in an explosion descriptor (All other values)
virtual const DtEntityType &	entityType () const
	DtBurstDescriptor (const DtEntityType &data, DtWarheadType warhead, DtDetonatorFuze fuze, DtU16 quantity, DtU16 rate)
	Constructors for each type of descriptor.
	DtBurstDescriptor (const DtEntityType &data, DtExplosiveMaterial explosiveMaterial, float explosiveForce)
	Constructors for each type of descriptor.
	DtBurstDescriptor (const DtEntityType &data)
	Constructors for each type of descriptor.
virtual void	setWarheadType (const DtWarheadType &warhead)
	The following parameters should only be used in a Munition Descriptor message.
virtual const DtWarheadType &	warheadType () const
	The following parameters should only be used in a Munition Descriptor message.
virtual void	setFuze (DtDetonatorFuze fuze)
	The following parameters should only be used in a Munition Descriptor message.
virtual DtDetonatorFuze	fuze () const
	The following parameters should only be used in a Munition Descriptor message.
virtual void	setQuantity (int quantity)
	The following parameters should only be used in a Munition Descriptor message.
virtual int	quantity () const
	The following parameters should only be used in a Munition Descriptor message.
virtual void	setRate (int rate)
	The following parameters should only be used in a Munition Descriptor message.
virtual int	rate () const
	The following parameters should only be used in a Munition Descriptor message.
virtual void	setExplosiveMaterial (const DtExplosiveMaterial &explosive)
	The following parameters should only be used in a Explosion Descriptor message.
virtual DtExplosiveMaterial	explosiveMaterial () const
	The following parameters should only be used in a Explosion Descriptor message.
virtual void	setExplosiveForce (float force)
	The following parameters should only be used in a Explosion Descriptor message.
virtual float	explosiveForce () const
	The following parameters should only be used in a Explosion Descriptor message.

Public Attributes
DtEntityType	DtMunition
	Public for historical reasons, will be made protected in future versions.
DtWarheadType	DtWarhead
DtDetonatorFuze	DtFuze
int	DtQuantity
int	DtRate

Detailed Description

Burst descriptors represent Fire and detonate descriptors in DIS and HLA.

They could be one of three things: Munition, Explosion, or Expendable, and what they are is determined by the kind of the EntityType defined in this burst descriptor. Note that some accessors are only relevant when using the right kind of descriptor. if you, for example, ask for ExplosiveForce in a Munition descriptor what is returned is an undefined value.

Constructor & Destructor Documentation

DtBurstDescriptor::DtBurstDescriptor

(

)

DtBurstDescriptor::DtBurstDescriptor

(

const DtNetBurstDescriptor *

netBurst

)

DtBurstDescriptor::DtBurstDescriptor	(	const DtEntityType &	data,
		DtWarheadType	warhead,
		DtDetonatorFuze	fuze,
		DtU16	quantity,
		DtU16	rate
	)

Constructors for each type of descriptor.

DtBurstDescriptor::DtBurstDescriptor	(	const DtEntityType &	data,
		DtExplosiveMaterial	explosiveMaterial,
		float	explosiveForce
	)

Constructors for each type of descriptor.

DtBurstDescriptor::DtBurstDescriptor

(

const DtEntityType &

data

)

Constructors for each type of descriptor.

Member Function Documentation

virtual const DtEntityType& DtBurstDescriptor::entityType ( ) const

virtual

virtual float DtBurstDescriptor::explosiveForce ( ) const

virtual

The following parameters should only be used in a Explosion Descriptor message.

virtual DtExplosiveMaterial DtBurstDescriptor::explosiveMaterial ( ) const

virtual

The following parameters should only be used in a Explosion Descriptor message.

virtual DtDetonatorFuze DtBurstDescriptor::fuze ( ) const

virtual

The following parameters should only be used in a Munition Descriptor message.

void DtBurstDescriptor::init	(	const DtEntityType *	type,
		DtWarheadType	warhead,
		DtDetonatorFuze	fuze,
		int	quantity,
		int	rate
	)

void DtBurstDescriptor::init	(	const DtEntityType *	type,
		DtExplosiveMaterial	explosiveMaterial,
		float	explosiveForce
	)

void DtBurstDescriptor::init

(

const DtEntityType *

type

)

DtBurstDescriptor::operator DtNetBurstDescriptor

(

)

const

virtual int DtBurstDescriptor::quantity ( ) const

virtual

The following parameters should only be used in a Munition Descriptor message.

virtual int DtBurstDescriptor::rate ( ) const

virtual

The following parameters should only be used in a Munition Descriptor message.

virtual void DtBurstDescriptor::setEntityType ( const DtEntityType &  munition )

virtual

This identifies the munitionType in a munition descriptor (Your Kind should be set to 2) The Expendable type in an expendable descriptor (Your Kind should be set to 8) The Exploding Object Type in an explosion descriptor (All other values)

virtual void DtBurstDescriptor::setExplosiveForce ( float  force )

virtual

The following parameters should only be used in a Explosion Descriptor message.

virtual void DtBurstDescriptor::setExplosiveMaterial ( const DtExplosiveMaterial &  explosive )

virtual

The following parameters should only be used in a Explosion Descriptor message.

virtual void DtBurstDescriptor::setFuze ( DtDetonatorFuze  fuze )

virtual

The following parameters should only be used in a Munition Descriptor message.

virtual void DtBurstDescriptor::setQuantity ( int  quantity )

virtual

The following parameters should only be used in a Munition Descriptor message.

virtual void DtBurstDescriptor::setRate ( int  rate )

virtual

The following parameters should only be used in a Munition Descriptor message.

virtual void DtBurstDescriptor::setWarheadType ( const DtWarheadType &  warhead )

virtual

The following parameters should only be used in a Munition Descriptor message.

virtual const DtWarheadType& DtBurstDescriptor::warheadType ( ) const

virtual

The following parameters should only be used in a Munition Descriptor message.

Member Data Documentation

DtDetonatorFuze DtBurstDescriptor::DtFuze

DtEntityType DtBurstDescriptor::DtMunition

Public for historical reasons, will be made protected in future versions.

int DtBurstDescriptor::DtQuantity

int DtBurstDescriptor::DtRate

DtWarheadType DtBurstDescriptor::DtWarhead

---

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

• burstDescriptor.h