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

Class used to store device information specific to a sensor. More...

#include <MultiSenseTypes.hh>

Public Member Functions

 DeviceInfo ()
 Default constructor. More...
 

Public Attributes

std::string name
 The name of a given device. More...
 
std::string buildDate
 The date the device was manufactured. More...
 
std::string serialNumber
 The serial number of the device. More...
 
uint32_t hardwareRevision
 The hardware revision of the given sensor. More...
 
std::vector< PcbInfo > pcbs
 The information for all the PCBs in the device. More...
 
std::string imagerName
 The name of the sensor's imager. More...
 
uint32_t imagerType
 The type of the sensor's imager. More...
 
uint32_t imagerWidth
 The maximum width of the sensor's imager. More...
 
uint32_t imagerHeight
 The maximum height of the sensor's imager. More...
 
std::string lensName
 The name of the sensor's lens. More...
 
uint32_t lensType
 The type of the sensor's lens. More...
 
float nominalBaseline
 The nominal sensor baseline in meters. More...
 
float nominalFocalLength
 The nominal focal length for the lens in meters. More...
 
float nominalRelativeAperture
 The nominal relative aperature for the sensor. More...
 
uint32_t lightingType
 The lighting type supported by the sensor. More...
 
uint32_t numberOfLights
 The number of lights supported by the sensor. More...
 
std::string laserName
 The name of the sensor's laser. More...
 
uint32_t laserType
 The type of the sensor's laser. More...
 
std::string motorName
 The name of the sensor's motor. More...
 
uint32_t motorType
 The type of the sensor's motor. More...
 
float motorGearReduction
 The gear reduction for the sensor's laser assembly. More...
 

Static Public Attributes

static CRL_CONSTEXPR uint8_t MAX_PCBS = 8
 The maximum number of PCBs in a device. More...
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_MULTISENSE_SL = 1
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_MULTISENSE_S7 = 2
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_MULTISENSE_S = HARDWARE_REV_MULTISENSE_S7
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_MULTISENSE_M = 3
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_MULTISENSE_S7S = 4
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_MULTISENSE_S21 = 5
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_MULTISENSE_ST21 = 6
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_MULTISENSE_C6S2_S27 = 7
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_MULTISENSE_S30 = 8
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_MULTISENSE_S7AR = 9
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_MULTISENSE_KS21 = 10
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_MULTISENSE_MONOCAM = 11
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_BCAM = 100
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_MONO = 101
 
static CRL_CONSTEXPR uint32_t IMAGER_TYPE_CMV2000_GREY = 1
 
static CRL_CONSTEXPR uint32_t IMAGER_TYPE_CMV2000_COLOR = 2
 
static CRL_CONSTEXPR uint32_t IMAGER_TYPE_CMV4000_GREY = 3
 
static CRL_CONSTEXPR uint32_t IMAGER_TYPE_CMV4000_COLOR = 4
 
static CRL_CONSTEXPR uint32_t IMAGER_TYPE_IMX104_COLOR = 100
 
static CRL_CONSTEXPR uint32_t IMAGER_TYPE_AR0234_GREY = 200
 
static CRL_CONSTEXPR uint32_t IMAGER_TYPE_AR0239_COLOR = 202
 
static CRL_CONSTEXPR uint32_t LIGHTING_TYPE_NONE = 0
 
static CRL_CONSTEXPR uint32_t LIGHTING_TYPE_SL_INTERNAL = 1
 
static CRL_CONSTEXPR uint32_t LIGHTING_TYPE_S21_EXTERNAL = 2
 

Detailed Description

Class used to store device information specific to a sensor.

Example code to query device information from a sensor:

//
// 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 Device info to store the sensors device information
crl::multisense::system::DeviceInfo deviceInfo;
//
// Query the device information from the Channel instance
crl::multisense::Status status = channel->getDeviceInfo(deviceInfo));
//
// Check to see if the device information query succeeded
if(crl::multisense::Status_Ok != status) {
throw std::runtime_error("Unable to query sensor device info");
}
//
// Use the device information...
//
// Destroy the channel instance
crl::multisense::Channel::Destroy(channel);

Setting sensor device info is not publicly supported.

Definition at line 2726 of file MultiSenseTypes.hh.

Constructor & Destructor Documentation

◆ DeviceInfo()

crl::multisense::system::DeviceInfo::DeviceInfo ( )
inline

Default constructor.

Definition at line 2811 of file MultiSenseTypes.hh.

Member Data Documentation

◆ buildDate

std::string crl::multisense::system::DeviceInfo::buildDate

The date the device was manufactured.

Definition at line 2762 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_BCAM

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_BCAM = 100
static

Definition at line 2744 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MONO

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MONO = 101
static

Definition at line 2745 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MULTISENSE_C6S2_S27

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MULTISENSE_C6S2_S27 = 7
static

Definition at line 2739 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MULTISENSE_KS21

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MULTISENSE_KS21 = 10
static

Definition at line 2742 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MULTISENSE_M

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MULTISENSE_M = 3
static

Definition at line 2735 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MULTISENSE_MONOCAM

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MULTISENSE_MONOCAM = 11
static

Definition at line 2743 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MULTISENSE_S

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MULTISENSE_S = HARDWARE_REV_MULTISENSE_S7
static

Definition at line 2734 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MULTISENSE_S21

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MULTISENSE_S21 = 5
static

Definition at line 2737 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MULTISENSE_S30

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MULTISENSE_S30 = 8
static

Definition at line 2740 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MULTISENSE_S7

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MULTISENSE_S7 = 2
static

Definition at line 2733 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MULTISENSE_S7AR

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MULTISENSE_S7AR = 9
static

Definition at line 2741 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MULTISENSE_S7S

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MULTISENSE_S7S = 4
static

Definition at line 2736 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MULTISENSE_SL

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MULTISENSE_SL = 1
static

Definition at line 2732 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MULTISENSE_ST21

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MULTISENSE_ST21 = 6
static

Definition at line 2738 of file MultiSenseTypes.hh.

◆ hardwareRevision

uint32_t crl::multisense::system::DeviceInfo::hardwareRevision

The hardware revision of the given sensor.

Definition at line 2766 of file MultiSenseTypes.hh.

◆ IMAGER_TYPE_AR0234_GREY

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::IMAGER_TYPE_AR0234_GREY = 200
static

Definition at line 2752 of file MultiSenseTypes.hh.

◆ IMAGER_TYPE_AR0239_COLOR

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::IMAGER_TYPE_AR0239_COLOR = 202
static

Definition at line 2753 of file MultiSenseTypes.hh.

◆ IMAGER_TYPE_CMV2000_COLOR

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::IMAGER_TYPE_CMV2000_COLOR = 2
static

Definition at line 2748 of file MultiSenseTypes.hh.

◆ IMAGER_TYPE_CMV2000_GREY

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::IMAGER_TYPE_CMV2000_GREY = 1
static

Definition at line 2747 of file MultiSenseTypes.hh.

◆ IMAGER_TYPE_CMV4000_COLOR

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::IMAGER_TYPE_CMV4000_COLOR = 4
static

Definition at line 2750 of file MultiSenseTypes.hh.

◆ IMAGER_TYPE_CMV4000_GREY

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::IMAGER_TYPE_CMV4000_GREY = 3
static

Definition at line 2749 of file MultiSenseTypes.hh.

◆ IMAGER_TYPE_IMX104_COLOR

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::IMAGER_TYPE_IMX104_COLOR = 100
static

Definition at line 2751 of file MultiSenseTypes.hh.

◆ imagerHeight

uint32_t crl::multisense::system::DeviceInfo::imagerHeight

The maximum height of the sensor's imager.

Definition at line 2778 of file MultiSenseTypes.hh.

◆ imagerName

std::string crl::multisense::system::DeviceInfo::imagerName

The name of the sensor's imager.

Definition at line 2772 of file MultiSenseTypes.hh.

◆ imagerType

uint32_t crl::multisense::system::DeviceInfo::imagerType

The type of the sensor's imager.

Definition at line 2774 of file MultiSenseTypes.hh.

◆ imagerWidth

uint32_t crl::multisense::system::DeviceInfo::imagerWidth

The maximum width of the sensor's imager.

Definition at line 2776 of file MultiSenseTypes.hh.

◆ laserName

std::string crl::multisense::system::DeviceInfo::laserName

The name of the sensor's laser.

Definition at line 2797 of file MultiSenseTypes.hh.

◆ laserType

uint32_t crl::multisense::system::DeviceInfo::laserType

The type of the sensor's laser.

Definition at line 2799 of file MultiSenseTypes.hh.

◆ lensName

std::string crl::multisense::system::DeviceInfo::lensName

The name of the sensor's lens.

Definition at line 2781 of file MultiSenseTypes.hh.

◆ lensType

uint32_t crl::multisense::system::DeviceInfo::lensType

The type of the sensor's lens.

Definition at line 2783 of file MultiSenseTypes.hh.

◆ LIGHTING_TYPE_NONE

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::LIGHTING_TYPE_NONE = 0
static

Definition at line 2755 of file MultiSenseTypes.hh.

◆ LIGHTING_TYPE_S21_EXTERNAL

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::LIGHTING_TYPE_S21_EXTERNAL = 2
static

Definition at line 2757 of file MultiSenseTypes.hh.

◆ LIGHTING_TYPE_SL_INTERNAL

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::LIGHTING_TYPE_SL_INTERNAL = 1
static

Definition at line 2756 of file MultiSenseTypes.hh.

◆ lightingType

uint32_t crl::multisense::system::DeviceInfo::lightingType

The lighting type supported by the sensor.

Definition at line 2792 of file MultiSenseTypes.hh.

◆ MAX_PCBS

CRL_CONSTEXPR uint8_t crl::multisense::system::DeviceInfo::MAX_PCBS = 8
static

The maximum number of PCBs in a device.

Definition at line 2730 of file MultiSenseTypes.hh.

◆ motorGearReduction

float crl::multisense::system::DeviceInfo::motorGearReduction

The gear reduction for the sensor's laser assembly.

Definition at line 2806 of file MultiSenseTypes.hh.

◆ motorName

std::string crl::multisense::system::DeviceInfo::motorName

The name of the sensor's motor.

Definition at line 2802 of file MultiSenseTypes.hh.

◆ motorType

uint32_t crl::multisense::system::DeviceInfo::motorType

The type of the sensor's motor.

Definition at line 2804 of file MultiSenseTypes.hh.

◆ name

std::string crl::multisense::system::DeviceInfo::name

The name of a given device.

Definition at line 2760 of file MultiSenseTypes.hh.

◆ nominalBaseline

float crl::multisense::system::DeviceInfo::nominalBaseline

The nominal sensor baseline in meters.

Definition at line 2785 of file MultiSenseTypes.hh.

◆ nominalFocalLength

float crl::multisense::system::DeviceInfo::nominalFocalLength

The nominal focal length for the lens in meters.

Definition at line 2787 of file MultiSenseTypes.hh.

◆ nominalRelativeAperture

float crl::multisense::system::DeviceInfo::nominalRelativeAperture

The nominal relative aperature for the sensor.

i.e. the f-stop

Definition at line 2789 of file MultiSenseTypes.hh.

◆ numberOfLights

uint32_t crl::multisense::system::DeviceInfo::numberOfLights

The number of lights supported by the sensor.

Definition at line 2794 of file MultiSenseTypes.hh.

◆ pcbs

std::vector<PcbInfo> crl::multisense::system::DeviceInfo::pcbs

The information for all the PCBs in the device.

Definition at line 2769 of file MultiSenseTypes.hh.

◆ serialNumber

std::string crl::multisense::system::DeviceInfo::serialNumber

The serial number of the device.

Definition at line 2764 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::system::DeviceInfo
Class used to store device information specific to a sensor.
Definition: MultiSenseTypes.hh:2726
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::getDeviceInfo
virtual Status getDeviceInfo(system::DeviceInfo &info)=0
Query the current sensor's device information.
crl::multisense::Channel::Create
static Channel * Create(const std::string &sensorAddress)
Create a Channel instance, used to manage all communications with a sensor.