Eaagles::Simulation::System Class Reference

Inherits Eaagles::Basic::LcComponent.

Inherited by Eaagles::Simulation::Datalink, Eaagles::Simulation::Gimbal, Eaagles::Simulation::IrSystem, Eaagles::Simulation::Navigation, Eaagles::Simulation::OnboardComputer, Eaagles::Simulation::Pilot, and Eaagles::Simulation::TrackManager.

Inheritance diagram for Eaagles::Simulation::System:

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

[legend]List of all members.


Public Types
enum	{ PWR_OFF, PWR_STBY, PWR_ON, PWR_LAST }
Public Member Functions
	System ()
virtual unsigned int	getPowerSwitch () const
virtual bool	setPowerSwitch (const unsigned int p)
virtual Player *	getOwnship ()
virtual const Player *	getOwnship () const
virtual Simulation *	getSimulation ()
virtual const Simulation *	getSimulation () const
virtual bool	killedNotification (Player *const killedBy=0)
virtual void	updateTC (const LCreal dt=0.0)
virtual bool	event (const int event, Basic::LcObject *const obj=0)
virtual void	reset ()
Protected Member Functions
virtual bool	setOwnship (Player *const p)
virtual void	dynamics (const LCreal dt)
virtual void	transmit (const LCreal dt)
virtual void	receive (const LCreal dt)
virtual void	process (const LCreal dt)
Private Attributes
Player *	ownship
unsigned int	pwrSw

Detailed Description

        Base classes for all simulation systems (excluding players)
                 that can be attached to a player.

    Events:
       KILL_EVENT        ()       Process a (we were just) killed events

    Power switch enums --
       a) Current switch enums are PWR_OFF, PWR_STBY and PWR_ON.
       b) PWR_LAST is use by derived systems to expand the power switch list
                enum {
                   PWR_NEW1 = BaseClass::PWR_LAST,
                   PWR_NEW2,
                   PWR_LAST
                };

    Phase Callbacks -- The following virtual member functions are to be overriden by
     derived systems, as needed.  Each function is called one per frame during the
     coresponding phase.

         virtual void dynamics(const LCreal dt);    // Phase 0
         virtual void transmit(const LCreal dt);    // Phase 1
         virtual void receive(const LCreal dt);     // Phase 2
         virtual void process(const LCreal dt);     // Phase 3
    /pre>

Member Enumeration Documentation

anonymous enum

Power switch enumerations (can be expaned by derived classes).

Enumerator:

PWR_OFF
PWR_STBY
PWR_ON	On, Normal, Operate, etc.
PWR_LAST	Hook for subclasses to expand.

Constructor & Destructor Documentation

Eaagles::Simulation::System::System ( )

Member Function Documentation

unsigned int Eaagles::Simulation::System::getPowerSwitch ( ) const [virtual]

Returns the system's master power switch setting (see power enumeration).

bool Eaagles::Simulation::System::setPowerSwitch ( const unsigned int p ) [virtual]

Sets the system's master power switch setting (see power enumeration).

Player * Eaagles::Simulation::System::getOwnship ( ) [virtual]

Returns a pointer to our ownship player, or zero if we're not attached to one.

const Player * Eaagles::Simulation::System::getOwnship ( ) const [virtual]

Returns a pointer to our ownship player (const version).

Simulation * Eaagles::Simulation::System::getSimulation ( ) [virtual]

Returns a pointer to the Simulation model, or zero if we're not attached to one.

const Simulation * Eaagles::Simulation::System::getSimulation ( ) const [virtual]

Returns a pointer to the Simulation model (const version).

bool Eaagles::Simulation::System::killedNotification ( Player *const killedBy = 0 ) [virtual]

Event handler(s) Killed (KILL_EVENT) event handler

Reimplemented in Eaagles::Simulation::TrackManager.

void Eaagles::Simulation::System::updateTC ( const LCreal dt = 0.0 ) [virtual]

Basic::LcComponent interface.

Reimplemented from Eaagles::Basic::LcComponent.

virtual bool Eaagles::Simulation::System::event	(	const int	event,
		Basic::LcObject *const	obj = `0`
	)			`[virtual]`

Sends the 'event' message with optional argument 'obj'. Returns true if the 'event' has been received and used. Derived classes will provided event() handlers, as needed. Event() can be called from an updateTC() routines, therefore,the event message must be processed quickly (i.e., no waits)

Reimplemented from Eaagles::Basic::LcComponent.

Reimplemented in Eaagles::Simulation::Datalink, and Eaagles::Simulation::Gimbal.

void Eaagles::Simulation::System::reset ( ) [virtual]

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

Reimplemented from Eaagles::Basic::LcComponent.

Reimplemented in Eaagles::Simulation::Autopilot, Eaagles::Simulation::Datalink, Eaagles::Simulation::Gimbal, Eaagles::Simulation::Navigation, Eaagles::Simulation::OnboardComputer, and Eaagles::Simulation::TrackManager.

bool Eaagles::Simulation::System::setOwnship ( Player *const p ) [protected, virtual]

Set the player that we're attached to.

void Eaagles::Simulation::System::dynamics ( const LCreal dt ) [protected, virtual]

Callbacks by phase -- to be used by the derived classes, as needed Phase 0

Reimplemented in Eaagles::Simulation::Datalink, and Eaagles::Simulation::Gimbal.

void Eaagles::Simulation::System::transmit ( const LCreal dt ) [protected, virtual]