Eaagles::Simulation::Station Class Reference

Inherits Eaagles::Basic::LcComponent.

Inherited by Eaagles::Fox::Station.

Inheritance diagram for Eaagles::Simulation::Station:

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

[legend]List of all members.

Public Member Functions
	Station ()
Simulation *	getSimulation ()
const Simulation *	getSimulation () const
Player *	getOwnship ()
const Player *	getOwnship () const
const Basic::LcString *	getOwnshipName () const
virtual Basic::LcPairStream *	getPlayers ()
virtual const Basic::LcPairStream *	getPlayers () const
Basic::LcPairStream *	getOutTheWindowList ()
const Basic::LcPairStream *	getOutTheWindowList () const
Basic::LcPairStream *	getNetworks ()
const Basic::LcPairStream *	getNetworks () const
unsigned int	getFastForwardRate () const
virtual bool	setFastForwardRate (const unsigned int r)
virtual bool	setOwnshipByName (const char *const newOS)
virtual bool	setOwnshipPlayer (Player *const newOS)
virtual bool	setOutTheWindow (Otw *const p)
virtual bool	setOutTheWindow (Basic::LcPairStream *const list)
virtual bool	setSlotNetworks (Basic::LcPairStream *const list)
virtual bool	setSlotRealTimePri (const Basic::LcNumber *const num)
virtual bool	setSlotRealTimeRate (const Basic::LcNumber *const num)
virtual bool	setSlotNetworkRate (const Basic::LcNumber *const num)
virtual bool	setSlotNetworkPri (const Basic::LcNumber *const num)
virtual bool	setSlotStartupResetTime (const Basic::LcTime *const num)
virtual bool	setSlotOwnshipName (const Basic::LcString *const soobj)
virtual bool	setSlotFastForwardRate (const Basic::LcNumber *const num)
virtual void	updateTC (const LCreal dt=0.0f)
virtual void	updateData (const LCreal dt=0.0f)
virtual void	reset ()
int	getRealTimeRate () const
LCreal	getRealTimePriority () const
bool	doWeHaveTheRtThread () const
virtual void	createRealTimeProcess ()
int	getNetworkRate () const
LCreal	getNetworkPriority () const
bool	doWeHaveTheNetThread () const
virtual void	createNetworkProcess ()
virtual bool	setSimulation (Simulation *const p)
Protected Member Functions
void	setHaveRtThread (const bool flg)
void	setHaveNetThread (const bool flg)
virtual void	inputDevices (const LCreal dt)
virtual void	outputDevices (const LCreal dt)
virtual bool	shutdownNotification ()
Private Attributes
Simulation *	sim
SPtr< Basic::LcPairStream >	otw
SPtr< Basic::LcPairStream >	networks
Player *	ownship
const Basic::LcString *	ownshipName
unsigned int	rtRate
LCreal	rtPri
unsigned int	netRate
LCreal	netPri
bool	haveRtThread
bool	haveNetThread
unsigned int	fastForwardRate
LCreal	startupResetTimer
const Basic::LcTime *	startupResetTimer0

---

Detailed Description

		 Applications's top level container class with support for the
                  simulation model, controls & displays, network interfacess
                  and the out-the-window visual systems.  Also, contains default
                  support for the time-critical and network threads.

    Notes:
       1) The ownship player is the primary focus of our controls, displays, OTW, etc.
       2) When the ownship player is changed, a ON_OWNSHIP_DISCONNECT event is sent
          to the previous ownship player and then a ON_OWNSHIP_CONNECT event is sent
          to the new ownship player.

    Form name: Station
    Slots --
         simulation         <Simulation>          Simulation model

         networks           <Basic::LcPairStream>  List of Network models

         otw                <Basic::LcPairStream> List of Out-The-Window (OTW) visual systems 
         otw                <Otw>                 Single Out-The-Window (OTW) visual system

         ownship            <Basic::LcString>     Player name of our ownship (primary) player

         rtRate             <Basic::LcNumber>     Time-critical thread rate (Hz) (Basic::LcNumber, default: 50hz)
         rtPriority         <Basic::LcNumber>     Time-critical thread priority (zero(0) is low, one(1) is high) (default: 1 )

         netRate            <Basic::LcNumber>     Network thread rate (Hz)  (Basic::LcNumber, default: 5 hz)
         netPriority        <Basic::LcNumber>     Network thread priority (zero(0) is low, one(1) is high) (default: 1 )

         startupResetTime   <Basic::LcTime>       Startup (initial) RESET pulse timer value (default: 0 seconds)

        fastForwardRate     <Basic::LcNumber>     Fast forward rate (i.e., number of times updateTC() is called per frame) 

---

Constructor & Destructor Documentation

Eaagles::Simulation::Station::Station

(

)

Reimplemented in Eaagles::Fox::Station.

---

Member Function Documentation

Simulation* Eaagles::Simulation::Station::getSimulation

(

)

[inline]

Returns the simulation.

const Simulation* Eaagles::Simulation::Station::getSimulation

(

)

const [inline]

Returns the simulation (const version).

Player* Eaagles::Simulation::Station::getOwnship

(

)

[inline]

Returns the ownship (primary) player.

const Player* Eaagles::Simulation::Station::getOwnship

(

)

const [inline]

Returns the ownship (primary) player (const version).

const Basic::LcString* Eaagles::Simulation::Station::getOwnshipName

(

)

const [inline]

Returns the ownship's name.

Basic::LcPairStream * Eaagles::Simulation::Station::getPlayers

(

)

[virtual]

Returns the player list.

const Basic::LcPairStream * Eaagles::Simulation::Station::getPlayers

(

)

const [virtual]

Returns the player list (const version).

Basic::LcPairStream* Eaagles::Simulation::Station::getOutTheWindowList

(

)

[inline]

Returns the list of OTW systems.

const Basic::LcPairStream* Eaagles::Simulation::Station::getOutTheWindowList

(

)

const [inline]

Returns the list of OTW systems (const version).

Basic::LcPairStream* Eaagles::Simulation::Station::getNetworks

(

)

[inline]

Returns the list of interoperability network handlers (DIS, HLA).

List of interoperability network handlers (DIS, HLA) (Distributed events only)

const Basic::LcPairStream* Eaagles::Simulation::Station::getNetworks

(

)

const [inline]

Returns the list of interoperability network handlers (DIS, HLA) (const version).

unsigned int Eaagles::Simulation::Station::getFastForwardRate

(

)

const [inline]

Returns the fast forward rate.

Fast forward rates (i.e., number of times Station::tcFrame() is called per frame)

bool Eaagles::Simulation::Station::setFastForwardRate

(

const unsigned int

r

)

[virtual]

Sets the fast forward rate.

bool Eaagles::Simulation::Station::setOwnshipByName

(

const char *const

newOS

)

[virtual]

Selects the ownship player by name.

Ownship selection

bool Eaagles::Simulation::Station::setOwnshipPlayer

(

Player *const

newOS

)

[virtual]

Sets the ownship player.

bool Eaagles::Simulation::Station::setOutTheWindow

(

Otw *const

p

)

[virtual]

Sets a single OTW visual subsystem.

Slot functions

bool Eaagles::Simulation::Station::setOutTheWindow

(

Basic::LcPairStream *const

list

)

[virtual]

Sets a list of OTW visual subsystem.

bool Eaagles::Simulation::Station::setSlotNetworks

(

Basic::LcPairStream *const

list

)

[virtual]

Sets a list of networks.

bool Eaagles::Simulation::Station::setSlotRealTimePri

(

const Basic::LcNumber *const

num

)

[virtual]

Sets the real-time thread priority.

bool Eaagles::Simulation::Station::setSlotRealTimeRate

(

const Basic::LcNumber *const

num

)

[virtual]

Sets the real-time thread update rate.

bool Eaagles::Simulation::Station::setSlotNetworkRate

(

const Basic::LcNumber *const

num

)

[virtual]

Sets the network thread update rate.

bool Eaagles::Simulation::Station::setSlotNetworkPri

(

const Basic::LcNumber *const

num

)

[virtual]

Sets the network thread update rate.

bool Eaagles::Simulation::Station::setSlotStartupResetTime

(

const Basic::LcTime *const

num

)

[virtual]

Sets the startup RESET timer.

bool Eaagles::Simulation::Station::setSlotOwnshipName

(

const Basic::LcString *const

soobj

)

[virtual]

Sets ownship player's name.

bool Eaagles::Simulation::Station::setSlotFastForwardRate

(

const Basic::LcNumber *const

num

)

[virtual]

Sets the fast forward rate.

void Eaagles::Simulation::Station::updateTC

(

const LCreal

dt = 0.0f

)

[virtual]

Basic::LcComponent Interface.

Reimplemented from Eaagles::Basic::LcComponent.

Reimplemented in Eaagles::Fox::Station.

void Eaagles::Simulation::Station::updateData

(

const LCreal

dt = 0.0f

)

[virtual]

Updates the non-time-critical (background) section of the component, where 'dt' is the delta time in seconds between calls. Derived classes will provided updateData() routines, as needed.

Reimplemented from Eaagles::Basic::LcComponent.

Reimplemented in Eaagles::Fox::Station.

void Eaagles::Simulation::Station::reset

(

)

[virtual]

Reinitialize this component to its state at the beginning of the simulation.

Reimplemented from Eaagles::Basic::LcComponent.

int Eaagles::Simulation::Station::getRealTimeRate

(

)

const [inline]

Returns the desired R/T update rate (rz).

Creates a thread that will call 'updateTC()' at 'getRealTimeRate()' Hz (Real/Time applications only)

LCreal Eaagles::Simulation::Station::getRealTimePriority

(

)

const [inline]

Returns the desired R/T priority [ 0(lowest) ... 1(highest) ].

bool Eaagles::Simulation::Station::doWeHaveTheRtThread

(

)

const [inline]

Returns true if we have a R/T thread.

void Eaagles::Simulation::Station::createRealTimeProcess

(

)

[virtual]

Creates a default R/T thread.

int Eaagles::Simulation::Station::getNetworkRate

(

)

const [inline]

Returns the desired network update rate (rz).

Creates a thread to manage the interoperability networks at 'getNetworkRate()' Hz (Distributed events only)

LCreal Eaagles::Simulation::Station::getNetworkPriority

(

)

const [inline]

Returns the desired network priority [ 0(lowest) ... 1(highest) ].

bool Eaagles::Simulation::Station::doWeHaveTheNetThread

(

)

const [inline]

Returns true if we have a network thread.

void Eaagles::Simulation::Station::createNetworkProcess

(

)

[virtual]

Creates a default network thread.

bool Eaagles::Simulation::Station::setSimulation

(

Simulation *const

p

)

[virtual]

Sets a pointer to our simulation subsystem.

void Eaagles::Simulation::Station::setHaveRtThread

(

const bool

flg

)

[inline, protected]

void Eaagles::Simulation::Station::setHaveNetThread

(

const bool

flg

)

[inline, protected]

void Eaagles::Simulation::Station::inputDevices

(

const LCreal

dt

)

[protected, virtual]

Called by Station::updateTC() to manager I/O.

void Eaagles::Simulation::Station::outputDevices

(

const LCreal

dt

)

[protected, virtual]

bool Eaagles::Simulation::Station::shutdownNotification

(

)

[protected, virtual]

Basic::LcComponent protected interface.

Reimplemented from Eaagles::Basic::LcComponent.

---

Member Data Documentation

Simulation* Eaagles::Simulation::Station::sim [private]

Simulation model.

SPtr<Basic::LcPairStream> Eaagles::Simulation::Station::otw [private]

List of Out-The-Window visual system interfaces.

SPtr<Basic::LcPairStream> Eaagles::Simulation::Station::networks [private]

List of networks.

Player* Eaagles::Simulation::Station::ownship [private]

Ownship (primary) player.

const Basic::LcString* Eaagles::Simulation::Station::ownshipName [private]

Name of our ownship player.

unsigned int Eaagles::Simulation::Station::rtRate [private]

Real-Time thread Rate (hz).

LCreal Eaagles::Simulation::Station::rtPri [private]

Priority of the Real-time thread (0->lowest, 1->highest).

unsigned int Eaagles::Simulation::Station::netRate [private]

Network thread Rate (hz).

LCreal Eaagles::Simulation::Station::netPri [private]

Priority of the Network thread (0->lowest, 1->highest).

bool Eaagles::Simulation::Station::haveRtThread [private]

Have a R/T (Time-Critical) thread.

bool Eaagles::Simulation::Station::haveNetThread [private]

Have a network thread.

unsigned int Eaagles::Simulation::Station::fastForwardRate [private]

Fast forward rate.

LCreal Eaagles::Simulation::Station::startupResetTimer [private]

Startup RESET timer (sends a RESET_EVENT after timeout).

const Basic::LcTime* Eaagles::Simulation::Station::startupResetTimer0 [private]

Init value of the startup RESET timer.

---