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

Class containing status information for a particular device. More...

#include <MultiSenseTypes.hh>

Public Member Functions

 StatusMessage ()
 Default constructor for a single StatusMessage object. More...
 

Public Attributes

double uptime
 The system uptime of the MultiSense in seconds. More...
 
bool systemOk
 A boolean flag indicating if the overall system status is good. More...
 
bool laserOk
 A boolean flag indicating if the laser is functioning. More...
 
bool laserMotorOk
 A boolean flag indicating if the laser motor controller is functioning. More...
 
bool camerasOk
 A boolean flag indicating if the imagers are functioning. More...
 
bool imuOk
 A boolean flag indicating if the imu is functioning. More...
 
bool externalLedsOk
 A boolean flag indicating if the external LEDs are OK. More...
 
bool processingPipelineOk
 A boolean indicating if the processing pipeline is ok. More...
 
float powerSupplyTemperature
 The temperature of the internal switching mode power supply. More...
 
float fpgaTemperature
 The temperature of the FPGA. More...
 
float leftImagerTemperature
 The temperature of the left imager. More...
 
float rightImagerTemperature
 The temperature of the right imager. More...
 
float inputVoltage
 The input voltage supplied to the MultiSense. More...
 
float inputCurrent
 The current drawn from the input power supply by the MultiSense. More...
 
float fpgaPower
 The power consumed by the FPGA. More...
 
float logicPower
 The power consumed by the MicroBlaze CPU. More...
 
float imagerPower
 The power consumed by the imager chips. More...
 

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
crl::multisense::Channel* channel;
channel = crl::multisense::Channel::Create("10.66.171.21");
channel->setMtu(7200);
//
// Create a instance of StatusMessage to store the sensor's status
crl::multisense::system::StatusMessage statusMessage;
//
// Query the network configuration from the Channel instance
crl::multisense::Status status = channel->getDeviceStatus(statusMessage);
//
// Check to see if the network configuration query succeeded
if(crl::multisense::Status_Ok != status) {
throw std::runtime_error("Unable to query sensor's status");
}
//
// Use the device status...
//
// Destroy the channel instance
crl::multisense::Channel::Destroy(channel);

Definition at line 2965 of file MultiSenseTypes.hh.

Constructor & Destructor Documentation

◆ StatusMessage()

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

Default constructor for a single StatusMessage object.

Definition at line 3029 of file MultiSenseTypes.hh.

Member Data Documentation

◆ camerasOk

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

A boolean flag indicating if the imagers are functioning.

True corresonds to healthy

Definition at line 2986 of file MultiSenseTypes.hh.

◆ externalLedsOk

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 2994 of file MultiSenseTypes.hh.

◆ fpgaPower

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

The power consumed by the FPGA.

Value is in Watts

Definition at line 3020 of file MultiSenseTypes.hh.

◆ fpgaTemperature

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

The temperature of the FPGA.

Temperature is is Celsius

Definition at line 3004 of file MultiSenseTypes.hh.

◆ imagerPower

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

The power consumed by the imager chips.

Value is in Watts

Definition at line 3026 of file MultiSenseTypes.hh.

◆ imuOk

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

A boolean flag indicating if the imu is functioning.

True corresonds to healthy

Definition at line 2990 of file MultiSenseTypes.hh.

◆ inputCurrent

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

The current drawn from the input power supply by the MultiSense.

Value is in Amperes

Definition at line 3017 of file MultiSenseTypes.hh.

◆ inputVoltage

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

The input voltage supplied to the MultiSense.

Value is in Volts

Definition at line 3013 of file MultiSenseTypes.hh.

◆ laserMotorOk

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

A boolean flag indicating if the laser motor controller is functioning.

True corresonds to healthy

Definition at line 2982 of file MultiSenseTypes.hh.

◆ laserOk

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

A boolean flag indicating if the laser is functioning.

True corresonds to healthy

Definition at line 2978 of file MultiSenseTypes.hh.

◆ leftImagerTemperature

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

The temperature of the left imager.

Temperature is is Celsius

Definition at line 3007 of file MultiSenseTypes.hh.

◆ logicPower

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

The power consumed by the MicroBlaze CPU.

Value is in Watts

Definition at line 3023 of file MultiSenseTypes.hh.

◆ powerSupplyTemperature

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

The temperature of the internal switching mode power supply.

Temperature is is Celsius

Definition at line 3001 of file MultiSenseTypes.hh.

◆ processingPipelineOk

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

A boolean indicating if the processing pipeline is ok.

Definition at line 2997 of file MultiSenseTypes.hh.

◆ rightImagerTemperature

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

The temperature of the right imager.

Temperature is is Celsius

Definition at line 3010 of file MultiSenseTypes.hh.

◆ systemOk

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

A boolean flag indicating if the overall system status is good.

True corresonds to healthy

Definition at line 2974 of file MultiSenseTypes.hh.

◆ uptime

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

The system uptime of the MultiSense in seconds.

True corresonds to healthy

Definition at line 2970 of file MultiSenseTypes.hh.

The documentation for this class was generated from the following file:
crl::multisense::Channel
Class which manages all communications with a MultiSense device.
Definition: MultiSenseChannel.hh:69
crl::multisense::Status_Ok
static CRL_CONSTEXPR Status Status_Ok
Definition: MultiSenseTypes.hh:98
crl::multisense::Channel::getDeviceStatus
virtual Status getDeviceStatus(system::StatusMessage &status)=0
Get the current status of the device.
crl::multisense::system::StatusMessage
Class containing status information for a particular device.
Definition: MultiSenseTypes.hh:2965
crl::multisense::Channel::Destroy
static void Destroy(Channel *instanceP)
Destroy a channel instance that was created using the static member function Channel::Create().
crl::multisense::Status
int32_t Status
General status typdef used as a return value for get/set crl::multisense::Channel methods.
Definition: MultiSenseTypes.hh:93
crl::multisense::Channel::setMtu
virtual Status setMtu(int32_t mtu)=0
Set the current sensor's MTU.
crl::multisense::Channel::Create
static Channel * Create(const std::string &sensorAddress)
Create a Channel instance, used to manage all communications with a sensor.