Eaagles::Simulation::OtwModel Class Reference

Inherits Eaagles::Basic::LcObject.

Inheritance diagram for Eaagles::Simulation::OtwModel:

[legend]Collaboration diagram for Eaagles::Simulation::OtwModel:

[legend]List of all members.

Public Types
enum	State {   INACTIVE, ACTIVE, DEAD, OUT_OF_RANGE,   CLEARED }
Public Member Functions
	OtwModel ()
bool	isState (const State tst) const
State	getState () const
void	setState (const State newState)
Player *	getPlayer ()
const Player *	getPlayer () const
const Otm *	getTypeMapper () const
unsigned short	getPlayerID () const
const Basic::LcString *	getFederateName () const
int	getAgeCount () const
int	incAgeCount ()
void	setAgeCount (const int v)
bool	isHotActive () const
void	setHotActive (const bool b)
int	getReqCount () const
int	incReqCount ()
void	setReqCount (const int v)
bool	isChecked () const
bool	isNotChecked () const
void	setCheckedFlag (const bool flg)
virtual void	initialize (Player *const p, const Otm **const otwModelTable=0, const unsigned int numModels=0)
virtual void	clear ()
Protected Member Functions
virtual void	setPlayer (Player *const p)
Private Attributes
Player *	player
State	state
int	ageCount
bool	checked
const Otm *	typeMapper
int	rcount
bool	hotActive
unsigned short	playerID
SPtr< const Basic::LcString >	federateName

---

Detailed Description

General class that associates an active, in-range player with the
                 OTW system's model object or height-of-terrain request.

    Notes:
       1) The 'checked' flag and functions are used by the Otw class when
          rechecking this model with the associated player.

       2) The age counters are used by the OTW unique handlers (derived from
          the Otw class).  

---

Member Enumeration Documentation

enum Eaagles::Simulation::OtwModel::State

Enumerator:

INACTIVE
ACTIVE
DEAD
OUT_OF_RANGE
CLEARED

---

Constructor & Destructor Documentation

Eaagles::Simulation::OtwModel::OtwModel

(

)

---

Member Function Documentation

bool Eaagles::Simulation::OtwModel::isState

(

const State

tst

)

const [inline]

True if the model is this state ( INACTIVE, ACTIVE, etc. }.

State Eaagles::Simulation::OtwModel::getState

(

)

const [inline]

Model's state ( INACTIVE, ACTIVE, etc. }.

void Eaagles::Simulation::OtwModel::setState

(

const State

newState

)

[inline]

Sets the model's state ( INACTIVE, ACTIVE, etc. }.

Player* Eaagles::Simulation::OtwModel::getPlayer

(

)

[inline]

The player object associated with this model.

const Player* Eaagles::Simulation::OtwModel::getPlayer

(

)

const [inline]

The player object associated with this model (const version).

const Otm* Eaagles::Simulation::OtwModel::getTypeMapper

(

)

const [inline]

OTW unique model type mapper.

unsigned short Eaagles::Simulation::OtwModel::getPlayerID

(

)

const [inline]

Player ID for the player associated with this model.

const Basic::LcString* Eaagles::Simulation::OtwModel::getFederateName

(

)

const [inline]

Player's federate name (if networked).

int Eaagles::Simulation::OtwModel::getAgeCount

(

)

const [inline]

Age counter value (number of OTW frames since last OTW update).

int Eaagles::Simulation::OtwModel::incAgeCount

(

)

[inline]

Increments the age counter.

void Eaagles::Simulation::OtwModel::setAgeCount

(

const int

v

)

[inline]

Sets the age counter.

bool Eaagles::Simulation::OtwModel::isHotActive

(

)

const [inline]

True if a Height-Of-Terrain request is active for this model.

void Eaagles::Simulation::OtwModel::setHotActive

(

const bool

b

)

[inline]

Sets the Height-Of-Terrain request active flag for this model.

int Eaagles::Simulation::OtwModel::getReqCount

(

)

const [inline]

HOT request age counter value (number of OTW frames since last HOT request).

int Eaagles::Simulation::OtwModel::incReqCount

(

)

[inline]

Increments the HOT request age counter.

void Eaagles::Simulation::OtwModel::setReqCount

(

const int

v

)

[inline]

Sets the HOT request age counter.

bool Eaagles::Simulation::OtwModel::isChecked

(

)

const [inline]

True if this model has been checked with the associated player object.

bool Eaagles::Simulation::OtwModel::isNotChecked

(

)

const [inline]

True if this model has not been checked with the associated player object.

void Eaagles::Simulation::OtwModel::setCheckedFlag

(

const bool

flg

)

[inline]

Sets the 'checked' flag.

void Eaagles::Simulation::OtwModel::initialize	(	Player *const	p,
		const Otm **const	otwModelTable = 0,
		const unsigned int	numModels = 0
	)			[virtual]

Initializes this model for player, 'p' (we're ACTIVE), and looks up the OTW model type ID in the OTW model table, 'otwModelTable'. If the size of the OTW model table is zero(0), then the model type ID is not set.

void Eaagles::Simulation::OtwModel::clear

(

)

[virtual]

Clear out this model (we're INACTIVE).

void Eaagles::Simulation::OtwModel::setPlayer

(

Player *const

p

)

[protected, virtual]

Sets the player object, p, associated with this model.

---

Member Data Documentation

Player* Eaagles::Simulation::OtwModel::player [private]

This player.

State Eaagles::Simulation::OtwModel::state [private]

Model Active flag.

int Eaagles::Simulation::OtwModel::ageCount [private]

Age counter (how many times have we've been overlooked).

bool Eaagles::Simulation::OtwModel::checked [private]

Model was checked.

const Otm* Eaagles::Simulation::OtwModel::typeMapper [private]

OTW unique model type mapper.

int Eaagles::Simulation::OtwModel::rcount [private]

HOT request counter (how many times have we asked).

bool Eaagles::Simulation::OtwModel::hotActive [private]

HOT entry is active.

unsigned short Eaagles::Simulation::OtwModel::playerID [private]

Player IDin this order --.

Model IDs -- Comparisons

SPtr<const Basic::LcString> Eaagles::Simulation::OtwModel::federateName [private]

Federate name.

---