DtUnderFireDeterminationComponentDescriptor; descriptor for the DtUnderFireDeterminationSensor component. More...

Inheritance diagram for DtUnderFireDeterminationComponentDescriptor:

Public Member Functions
	DtUnderFireDeterminationComponentDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtUnderFireDeterminationComponentDescriptor (const DtUnderFireDeterminationComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor.
DtUnderFireDeterminationComponentDescriptor &	operator= (const DtUnderFireDeterminationComponentDescriptor &orig)
	assignment. See note above.
virtual	~DtUnderFireDeterminationComponentDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const

virtual DtTime	underFireTime () const
	Accessor/mutator for myUnderFireTime.
virtual void	setUnderFireTime (DtTime underFireTime)
	Accessor/mutator for myUnderFireTime.

virtual DtReal	underFireDistance () const
	Accessor/mutator for myUnderFireDistance.
virtual void	setUnderFireDistance (DtReal underFireDistance)
	Accessor/mutator for myUnderFireDistance.

virtual bool	underFireFromFriendly () const
	Accessor/mutator for myUnderFireFromFriendly.
virtual void	setUnderFireFromFriendly (bool underFireFromFriendly)
	Accessor/mutator for myUnderFireFromFriendly.
Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Member Functions
	DtUnderFireDeterminationComponentDescriptor ()
	default constructor; not implemented
Protected Attributes
Parameters
These parameters are available for setting in the OPD files.
DtRwTime	myUnderFireTime
	Parameter Name: under-fire-time Parameter Description: The time after which an entity is no longer considered to be under fire.
DtRwReal	myUnderFireDistance
	Parameter Name: under-fire-distance Parameter Description: The distance from a detonation at which an entity is considered to be under fire.
DtRwBoolean	myUnderFireFromFriendly
	Parameter Name: under-fire-from-friendly Parameter Description: Flag indicating whether or not friendly fire should affect the under fire condition.

Detailed Description

DtUnderFireDeterminationComponentDescriptor; descriptor for the DtUnderFireDeterminationSensor component.

This class is used to specify the parameters for the DtUnderFireDeterminationSensor component.

Constructor & Destructor Documentation

DtUnderFireDeterminationComponentDescriptor::DtUnderFireDeterminationComponentDescriptor	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

constructor

DtUnderFireDeterminationComponentDescriptor::DtUnderFireDeterminationComponentDescriptor	(	const DtUnderFireDeterminationComponentDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

copy constructor.

virtual DtUnderFireDeterminationComponentDescriptor::~DtUnderFireDeterminationComponentDescriptor ( ) [virtual]

destructor

DtUnderFireDeterminationComponentDescriptor::DtUnderFireDeterminationComponentDescriptor ( ) [protected]

default constructor; not implemented

Member Function Documentation

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

assignment. See note above.

virtual DtString DtUnderFireDeterminationComponentDescriptor::type ( ) const [virtual]

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns:: DtUnderFireDeterminationComponentDescriptorType

Reimplemented from DtComponentDescriptor.

virtual DtComponentDescriptor* DtUnderFireDeterminationComponentDescriptor::clone ( DtReaderWriterRegistry * parentRegistry = NULL ) const [virtual]

Reimplemented from DtComponentDescriptor.

virtual DtTime DtUnderFireDeterminationComponentDescriptor::underFireTime ( ) const [virtual]

Accessor/mutator for myUnderFireTime.

virtual void DtUnderFireDeterminationComponentDescriptor::setUnderFireTime ( DtTime underFireTime ) [virtual]

Accessor/mutator for myUnderFireTime.

virtual DtReal DtUnderFireDeterminationComponentDescriptor::underFireDistance ( ) const [virtual]

Accessor/mutator for myUnderFireDistance.

virtual void DtUnderFireDeterminationComponentDescriptor::setUnderFireDistance ( DtReal underFireDistance ) [virtual]

Accessor/mutator for myUnderFireDistance.

virtual bool DtUnderFireDeterminationComponentDescriptor::underFireFromFriendly ( ) const [virtual]

Accessor/mutator for myUnderFireFromFriendly.

virtual void DtUnderFireDeterminationComponentDescriptor::setUnderFireFromFriendly ( bool underFireFromFriendly ) [virtual]

Accessor/mutator for myUnderFireFromFriendly.

static DtComponentDescriptor* DtUnderFireDeterminationComponentDescriptor::creator ( ) [static]

Returns:: Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtComponentDescriptor.