#include <RelayBoard.h>

Inheritance diagram for CRelayBoard:

Collaboration diagram for CRelayBoard:

Public Member Functions
bool	UpdateRelay (CMOOSMsg &Msg)
bool	Stop ()
bool	Record ()
bool	IsPowered (std::string sRelay)
	CRelayBoard ()
virtual	~CRelayBoard ()
Public Attributes
RELAY_FUNCTION_2_TOGGLE_MAP	m_RelayToggleMap
RELAY_FUNCTION_2_CHECK_MAP	m_RelayCheckMap
INPUT_NAME_2_INT_MAP	m_InputNameMap
std::string	m_sRECORDING
std::string	m_sRECORD
std::string	m_sSTOPPED
std::string	m_sSTOP
std::string	m_sON
std::string	m_sOFF
std::string	m_sCAMERA_POWER
std::string	m_sBOARD_POWER
std::string	m_sVCR_POWER
std::string	m_sLIGHT_POWER
std::string	m_sLIGHT
std::string	m_sDARK
Protected Member Functions
bool	ShowRelayBoardStatus ()
int	CheckAllRelayStates ()
bool	ToggleRelaySwitch (std::string sRelay, std::string sDesiredState)
bool	InitialiseSensor ()
bool	Iterate ()
bool	OnNewMail (MOOSMSG_LIST &NewMail)
bool	OnConnectToServer ()
bool	OnStartUp ()
bool	GetData ()
bool	PublishData ()
bool	SetRelayHi (short val)
bool	SetRelayLo (short val)
int	CheckRelayState (short val)
int	CheckInputState (short val)

Detailed Description

Definition at line 86 of file RelayBoard.h.

Constructor & Destructor Documentation

CRelayBoard::CRelayBoard ( )

Definition at line 44 of file RelayBoard.cpp.

CRelayBoard::~CRelayBoard ( ) [virtual]

Definition at line 79 of file RelayBoard.cpp.

Member Function Documentation

int CRelayBoard::CheckAllRelayStates ( ) [protected]

Returns:: the status of all relays in decimal format

Definition at line 546 of file RelayBoard.cpp.

int CRelayBoard::CheckInputState ( short val ) [protected]

Allows querying of an individual input

Definition at line 306 of file RelayBoard.cpp.

int CRelayBoard::CheckRelayState ( short val ) [protected]

Returns:: either 1 to represent the ON state of the relay or 0 to indicate the relay is OFF -1 indicates error

Definition at line 264 of file RelayBoard.cpp.

bool CRelayBoard::GetData ( ) [protected]

Definition at line 200 of file RelayBoard.cpp.

bool CRelayBoard::InitialiseSensor ( ) [protected, virtual]

called from OnStartUp - overload to execute custom start up code for sensor

Reimplemented from CMOOSInstrument.

Definition at line 193 of file RelayBoard.cpp.

bool CRelayBoard::IsPowered ( std::string sRelay )

Returns:: whether or not a particular relay switch has power

Definition at line 489 of file RelayBoard.cpp.

bool CRelayBoard::Iterate ( ) [protected, virtual]

this is where it all happens..

Reimplemented from CMOOSApp.

Definition at line 89 of file RelayBoard.cpp.

bool CRelayBoard::OnConnectToServer ( ) [protected, virtual]

Called when the class has succesully connected to the server. Overload this function and place use it to register for notification when variables of interest change

Reimplemented from CMOOSApp.

Definition at line 181 of file RelayBoard.cpp.

bool CRelayBoard::OnNewMail ( MOOSMSG_LIST & NewMail ) [protected, virtual]

called when new mail has arrived. Overload this method in a derived class to process new mail. It will be called at approximately 1/CommsTick Hz. In this function you'll most likely interate over the collection of mail message received or call a m_Comms::PeekMail() to look for a specific named message.

Parameters:

NewMail a list of new mail messages

Reimplemented from CMOOSApp.

Definition at line 142 of file RelayBoard.cpp.

bool CRelayBoard::OnStartUp ( ) [protected, virtual]

CMOOSApp overide

Reimplemented from CMOOSInstrument.

Definition at line 101 of file RelayBoard.cpp.

bool CRelayBoard::PublishData ( ) [protected]

Definition at line 174 of file RelayBoard.cpp.

bool CRelayBoard::Record ( )

Starts the video system recording