Public Member Functions | Public Attributes | List of all members
crl::multisense::system::StatusMessage Class Reference

#include <MultiSenseTypes.hh>

Public Member Functions

 StatusMessage ()
 

Public Attributes

bool camerasOk
 
bool externalLedsOk
 
float fpgaPower
 
float fpgaTemperature
 
float imagerPower
 
bool imuOk
 
float inputCurrent
 
float inputVoltage
 
bool laserMotorOk
 
bool laserOk
 
float leftImagerTemperature
 
float logicPower
 
float powerSupplyTemperature
 
bool processingPipelineOk
 
float rightImagerTemperature
 
bool systemOk
 
double uptime
 

Detailed Description

Class containing status information for a particular device. This should be queried in a loop timed at 1Hz

Example code to query a single sensor's status:

//
// Instantiate a channel connecting to a sensor at the factory default
// IP address
channel = crl::multisense::Channel::Create("10.66.171.21");
channel->setMtu(7200);
//
// Create a instance of StatusMessage to store the sensor's status
//
// Query the network configuration from the Channel instance
crl::multisense::Status status = channel->getDeviceStatus(statusMessage);
//
// Check to see if the network configuration query succeeded
throw std::runtime_error("Unable to query sensor's status");
}
//
// Use the device status...
//
// Destroy the channel instance

Definition at line 2404 of file MultiSenseTypes.hh.

Constructor & Destructor Documentation

crl::multisense::system::StatusMessage::StatusMessage ( )
inline

Default constructor for a single StatusMessage object

Definition at line 2468 of file MultiSenseTypes.hh.

Member Data Documentation

bool crl::multisense::system::StatusMessage::camerasOk

A boolean flag indicating if the imagers are functioning. True corresonds to healthy

Definition at line 2425 of file MultiSenseTypes.hh.

bool crl::multisense::system::StatusMessage::externalLedsOk

A boolean flag indicating if the external LEDs are OK. This flag will only be true if external LEDs are present

Definition at line 2433 of file MultiSenseTypes.hh.

float crl::multisense::system::StatusMessage::fpgaPower

The power consumed by the FPGA. Value is in Watts

Definition at line 2459 of file MultiSenseTypes.hh.

float crl::multisense::system::StatusMessage::fpgaTemperature

The temperature of the FPGA. Temperature is is Celsius

Definition at line 2443 of file MultiSenseTypes.hh.

float crl::multisense::system::StatusMessage::imagerPower

The power consumed by the imager chips. Value is in Watts

Definition at line 2465 of file MultiSenseTypes.hh.

bool crl::multisense::system::StatusMessage::imuOk

A boolean flag indicating if the imu is functioning. True corresonds to healthy

Definition at line 2429 of file MultiSenseTypes.hh.

float crl::multisense::system::StatusMessage::inputCurrent

The current drawn from the input power supply by the MultiSense. Value is in Amperes

Definition at line 2456 of file MultiSenseTypes.hh.

float crl::multisense::system::StatusMessage::inputVoltage

The input voltage supplied to the MultiSense. Value is in Volts

Definition at line 2452 of file MultiSenseTypes.hh.

bool crl::multisense::system::StatusMessage::laserMotorOk

A boolean flag indicating if the laser motor controller is functioning. True corresonds to healthy

Definition at line 2421 of file MultiSenseTypes.hh.

bool crl::multisense::system::StatusMessage::laserOk

A boolean flag indicating if the laser is functioning. True corresonds to healthy

Definition at line 2417 of file MultiSenseTypes.hh.

float crl::multisense::system::StatusMessage::leftImagerTemperature

The temperature of the left imager. Temperature is is Celsius

Definition at line 2446 of file MultiSenseTypes.hh.

float crl::multisense::system::StatusMessage::logicPower

The power consumed by the MicroBlaze CPU. Value is in Watts

Definition at line 2462 of file MultiSenseTypes.hh.

float crl::multisense::system::StatusMessage::powerSupplyTemperature

The temperature of the internal switching mode power supply. Temperature is is Celsius

Definition at line 2440 of file MultiSenseTypes.hh.

bool crl::multisense::system::StatusMessage::processingPipelineOk

A boolean indicating if the processing pipeline is ok

Definition at line 2436 of file MultiSenseTypes.hh.

float crl::multisense::system::StatusMessage::rightImagerTemperature

The temperature of the right imager. Temperature is is Celsius

Definition at line 2449 of file MultiSenseTypes.hh.

bool crl::multisense::system::StatusMessage::systemOk

A boolean flag indicating if the overall system status is good. True corresonds to healthy

Definition at line 2413 of file MultiSenseTypes.hh.

double crl::multisense::system::StatusMessage::uptime

The system uptime of the MultiSense in seconds. True corresonds to healthy

Definition at line 2409 of file MultiSenseTypes.hh.


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


multisense_lib
Author(s):
autogenerated on Sat Apr 6 2019 02:16:47