LEDActuator Class Reference

#include <LEDActuator.h>

Inheritance diagram for LEDActuator:

[legend]Collaboration diagram for LEDActuator:

[legend]List of all members.

---

Detailed Description

Realization of the LED Actuators within the system.

Public Types
enum	State {   ON,   OFF }
enum	ActuatorType {   INJECTOR,   IDLE_AIR_CONTROLLER,   FUEL_PUMP,   INDICATOR,   COIL }
enum	Status {   OK,   FAILED }
Public Member Functions
virtual Status	setState (int state)
	Sets the current state of the actuator.
virtual int	getState ()
	Gets the current state of the actuator.
	LEDActuator (ActuatorType t, char ch)
	Constructor, requires the ActuatorType is passed during initialization.
ActuatorType	getType ()
	Returns the type of Actuator.
char	getChannel ()
	Returns the channel number.
Protected Attributes
const ActuatorType	type
	A constant to hold the actuator type.
const char	channel
	A constant to hold the channel.

---

Member Enumeration Documentation

enum Actuator::ActuatorType [inherited]

Enumerator: INJECTOR  Injector. IDLE_AIR_CONTROLLER  Idle Air Controller. FUEL_PUMP  Fuel Pump. INDICATOR  Indictor (typically LED, etc. ) COIL  COIL.

enum LEDActuator::State

Enumerator: ON  Turned on. OFF  Turned off.

enum Actuator::Status [inherited]

Enumerator: OK  Success. FAILED  A problem occured.

---

Constructor & Destructor Documentation

LEDActuator::LEDActuator (  ActuatorType  t, char  ch )

Constructor, requires the ActuatorType is passed during initialization. Parameters: type  of the actuator ch  channel for the actuator

---

Member Function Documentation

char Actuator::getChannel (   )  [inline, inherited]

Returns the channel number. Returns: Channel

int LEDActuator::getState (   )  [virtual]

Gets the current state of the actuator. Returns: the current state Implements Actuator.

ActuatorType Actuator::getType (   )  [inline, inherited]

Returns the type of Actuator. Returns: ActuatorType

Actuator::Status LEDActuator::setState (  int  state  )  [virtual]

Sets the current state of the actuator. Parameters: state  integer value specifying the state. Should be an emumeration that is extended in the subclass, but it can't be due to a limitation of this language. Returns: Status Implements Actuator.

---

Member Data Documentation

const char Actuator::channel [protected, inherited]

A constant to hold the channel.

const ActuatorType Actuator::type [protected, inherited]

A constant to hold the actuator type.

---

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

• LEDActuator.h
• LEDActuator.cpp

---