carma::antenna::ovro::EnvironmentalMonitor Class Reference

CAN Device class implementation for 10-m sidecab environmental monitor. More...

#include <carma/antenna/ovro/canbus/EnvironmentalMonitor.h>

Inheritance diagram for carma::antenna::ovro::EnvironmentalMonitor:

Public Member Functions
void	enable24vPs (unsigned short supplyNo, bool on)
	Enable or disable one of three 24 Volt power supplies. More...
void	enableCamera (bool on)
	Enable or disable the optical pointing camera. More...
	EnvironmentalMonitor (carma::canbus::nodeType node, carma::canbus::CanOutput &io, carma::monitor::OvroSubsystem &mon)
	Constructor. More...
carma::canbus::MsgBriefMap	getHalfSecMonitors () const
	Retrieve a map of this devices half second monitor points. More...
carma::canbus::MsgBriefMap	getSlowMonitors () const
	Return a map of this devices slow monitor points. More...
void	processMsg (carma::canbus::msgType mid, carma::canbus::DataVector &data, bool sim)
	Process a CAN message addressed to the SecondaryMirror module. More...
carma::canbus::Message	simulateMsg (carma::canbus::msgType mid)
	Produce a simulated CAN message for a given msgType. More...
void	turnSidecabPowerOff ()
	Turn sidecab power off!!! Yes this is a dangerous command and should only be used in an emergency. More...
void	updateFrameData ()
	Update Frame Data. More...
	~EnvironmentalMonitor ()
	Destructor. More...
Public Member Functions inherited from carma::canbus::devices::XacDevice
bool	isOnline ()
	Is Device ONLINE? More...
void	reset ()
	Reset the can module via CORBA using Device::softReset() method. More...
virtual void	setState (deviceStateType state)
	Set the state of the device. More...
void	startChannelOneFastSampling (unsigned short fastItem)
	Start fast sampling on channel one with the requested data item. More...
void	startChannelTwoFastSampling (unsigned short fastItem)
	Start fast sampling on channel two with the requested data item. More...
void	stopChannelOneFastSampling ()
	Stop fast sampling on channel one. More...
void	stopChannelTwoFastSampling ()
	Stop fast sampling on channel two. More...
	XacDevice (carma::canbus::apiType api, carma::canbus::nodeType node, carma::canbus::CanOutput &canOutput)
	Constructor. More...
virtual	~XacDevice ()
	Destructor. More...
Public Member Functions inherited from carma::canbus::Device
carma::canbus::Message	createDummyMsg () const
	Create a dummy CAN message. More...
carma::canbus::Message	createMsgToAllNodes (msgType messageId) const
	Create a CAN message addressed to all nodes of this type. More...
carma::canbus::Message	createMsgToHost (msgType messageId) const
	Create a CAN message addressed from this Device to the host. More...
carma::canbus::Message	createMsgToNode (msgType messageId) const
	Create a CAN message addressed to this device from the host. More...
	Device (apiType api, nodeType node, CanOutput &io)
	Device constructor. More...
apiType	getApi () const
	Return api code of device. More...
char	getApiVersion () const
	Get API Version of this Device. More...
boardType	getBoardType () const
	Return board type id of device. More...
busIdType	getBusId () const
	Return bus Id that node resides on. More...
virtual MsgIdInfoMap	getControls () const
	Return a map of devices controls. More...
keyType	getKey () const
	Create a key unique to this api and node. More...
double	getLastRxTime () const
	Get Last RX Time for device. More...
unsigned int	getNlatePackets () const
	Get number of late packets. More...
nodeType	getNode () const
	Return node location code of device. More...
serialNumberType	getSerialNumber () const
	Return serial number of device. More...
deviceStateType	getState () const
	Status access routine. More...
virtual void	processMsg (msgType messageId, std::vector< byteType > &data, bool sim)=0
	Process a CAN message. More...
void	reset ()
	Perform a software reset of module. More...
void	setBoardType (boardType bt)
	Set board type of device. More...
void	setBusId (busIdType busId)
	Set busId of device. More...
virtual void	setLastRxTime (double rxMjd)
	Set latest rx time. More...
void	setSerialNumber (serialNumberType sn)
	Set serial number of device. More...
void	startChannelOneFastSampling (unsigned short fastItem)
	Start fast sampling the specified data item on channel 1. More...
void	startChannelTwoFastSampling (unsigned short fastItem)
	Start fast sampling the specified data item on channel 2. More...
void	stopChannelOneFastSampling ()
	Stop fast sampling on channel 1 This routine will stop fast sampling on channel 1 regardless of whether this node is fast sampling the channel or not! In other words the request goes out globally. More...
void	stopChannelTwoFastSampling ()
	Stop fast sampling on channel 2 This routine will stop fast sampling on channel 2 regardless of whether this node is fast sampling the channel or not! In other words the request goes out globally. More...
virtual	~Device ()
	Device destructor. More...

Additional Inherited Members
Static Public Member Functions inherited from carma::canbus::Device
static keyType	createKey (apiType api, nodeType node)
Static Public Attributes inherited from carma::canbus::devices::XacDevice
static const carma::canbus::msgType	SYSTEM_MONITOR_PACKET_1 = 0x120
static const carma::canbus::msgType	SYSTEM_MONITOR_PACKET_2 = 0x121
static const carma::canbus::msgType	SYSTEM_MONITOR_PACKET_3 = 0x122
static const carma::canbus::msgType	SYSTEM_MONITOR_PACKET_4 = 0x123
static const carma::canbus::msgType	SYSTEM_MONITOR_PACKET_5 = 0x124
Protected Member Functions inherited from carma::canbus::devices::XacDevice
virtual void	initialize ()
	Initialization hook. More...
void	processSystemMonitorPacket (carma::canbus::msgType mid, carma::canbus::DataVector &data, carma::monitor::Xac &xac)
	Process a system monitor packet. More...
void	processSystemMonitorPacket1 (carma::canbus::DataVector &data, carma::monitor::Xac &xac)
	Process System Monitor Packet 1 This routine processes standard system monitor packet 1 and places the data into the input Xac reference. More...
void	processSystemMonitorPacket2 (carma::canbus::DataVector &data, carma::monitor::Xac &xac)
	Process System Monitor Packet 2. More...
void	processSystemMonitorPacket3 (carma::canbus::DataVector &data, carma::monitor::Xac &xac)
	Process System Monitor Packet 3. More...
void	processSystemMonitorPacket4 (carma::canbus::DataVector &data, carma::monitor::Xac &xac)
	Process System Monitor Packet 4. More...
void	processSystemMonitorPacket5 (carma::canbus::DataVector &data, carma::monitor::Xac &xac)
	Process System Monitor Packet 5. More...
carma::canbus::Message	simSystemMonitorPacket (carma::canbus::msgType mid)
	Simulate system monitor packet. More...
carma::canbus::Message	simSystemMonitorPacket1 ()
	Simulate System Monitor Packet 1. More...
carma::canbus::Message	simSystemMonitorPacket2 ()
	Simulate System Monitor Packet 2. More...
carma::canbus::Message	simSystemMonitorPacket3 ()
	Simulate System Monitor Packet 3. More...
carma::canbus::Message	simSystemMonitorPacket4 ()
	Simulate System Monitor Packet 4. More...
carma::canbus::Message	simSystemMonitorPacket5 ()
	Simulate System Monitor Packet 5. More...
Protected Member Functions inherited from carma::canbus::Device
void	incrementLatePacketCount ()
	Increment the late packet count by 1. More...
bool	isPacketLate (double window=100.0)
	Determine if the last packet sent from this device was late. More...
void	resetLatePacketCount ()
	Reset the late packet count to 0. More...
void	setApiVersion (char api)
	Set API Version. More...
Static Protected Member Functions inherited from carma::canbus::devices::XacDevice
static bool	isSystemMonitorPacket (carma::canbus::msgType)
	Check that input message type is a system monitor packet. More...
Protected Attributes inherited from carma::canbus::Device
const apiType	api_
CanOutput &	io_
	Reference to CanOutput object. More...
const keyType	key_
const nodeType	node_
Static Protected Attributes inherited from carma::canbus::Device
static const msgType	RESET = 0x0000
	Software reset message id. More...
static const msgType	START_CHANNEL_1_FAST_SAMPLING = 0x0004
	Begin channel 1 fast sampling message id. More...
static const msgType	START_CHANNEL_2_FAST_SAMPLING = 0x0005
	Begin channel 2 fast sampling message id. More...
static const msgType	STOP_CHANNEL_1_FAST_SAMPLING = 0x0002
	Stop channel 1 fast sampling message id. More...
static const msgType	STOP_CHANNEL_2_FAST_SAMPLING = 0x0003

Detailed Description

CAN Device class implementation for 10-m sidecab environmental monitor.

Definition at line 30 of file EnvironmentalMonitor.h.

Constructor & Destructor Documentation

carma::antenna::ovro::EnvironmentalMonitor::EnvironmentalMonitor	(	carma::canbus::nodeType	node,
		carma::canbus::CanOutput &	io,
		carma::monitor::OvroSubsystem &	mon
	)

Constructor.

Parameters

node	Location id of this instance (node location id).
io	Reference to CanOutput class.

carma::antenna::ovro::EnvironmentalMonitor::~EnvironmentalMonitor

(

)

Destructor.

Member Function Documentation

void carma::antenna::ovro::EnvironmentalMonitor::enable24vPs	(	unsigned short	supplyNo,
		bool	on
	)

Enable or disable one of three 24 Volt power supplies.

Turns on or off one of the sidecab 24V supplies.

Parameters

supplyNo	0 for all, 1 - 3 for specific power supply.
on	True to enable power supply, false to disable it.

void carma::antenna::ovro::EnvironmentalMonitor::enableCamera

(

bool

on

)

Enable or disable the optical pointing camera.

If instructed to enable the camera, this method will cause the lens cap to be removed and the camera to be switched on. If instructed to disable the camera, the reverse will occur.

Parameters

on	Enable camera if true, disable if false.

carma::canbus::MsgBriefMap carma::antenna::ovro::EnvironmentalMonitor::getHalfSecMonitors ( ) const

virtual

Retrieve a map of this devices half second monitor points.

The monitor points returned from this routine will be simulated if the device is in the OFFLINE state.

Returns

a map of the devices half second monitor points string descriptions keyed by message id.

Implements carma::canbus::Device.

carma::canbus::MsgBriefMap carma::antenna::ovro::EnvironmentalMonitor::getSlowMonitors ( ) const

virtual

Return a map of this devices slow monitor points.

These monitor points will be simulated every 5 seconds if the device is in the OFFLINE state.

Returns

a map of the devices slow (5 sec) monitor points string descriptions keyed by message id.

Reimplemented from carma::canbus::devices::XacDevice.

void carma::antenna::ovro::EnvironmentalMonitor::processMsg	(	carma::canbus::msgType	mid,
		carma::canbus::DataVector &	data,
		bool	sim
	)

Process a CAN message addressed to the SecondaryMirror module.

This routine is responsible for processing all CAN messages addressed to this device.

Parameters

mid	the 10bit message id (carma::canbus::msgType)
data	reference to the byte vector containing the raw data.
sim	Indicates if message is real or simulated.

See Also

carma::canbus::Device::processMsg

carma::canbus::Message carma::antenna::ovro::EnvironmentalMonitor::simulateMsg ( carma::canbus::msgType  mid )

virtual

Produce a simulated CAN message for a given msgType.

This routine creates a Message with simulated data for an input message id. The returned message is automatically placed in the CAN message queue for retrieval and processing by the Master class. It thus can be used to test the processMsg method above.

Parameters

mid	the 10bit message id (carma::canbus::msgType)

Implements carma::canbus::Device.

void carma::antenna::ovro::EnvironmentalMonitor::turnSidecabPowerOff

(

)

Turn sidecab power off!!! Yes this is a dangerous command and should only be used in an emergency.

This shuts off power to the entire sidecab, including the linux host such that no hardware can be monitored or controlled any longer. IT REQUIRES THAT THE POWER BE RESTORED MANUALLY!!! This could mean a long drive for somebody if nobody is at the high site!!!

void carma::antenna::ovro::EnvironmentalMonitor::updateFrameData ( )

virtual

Update Frame Data.

Reimplemented from carma::canbus::Device.

---

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

• carma/antenna/ovro/canbus/EnvironmentalMonitor.h