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_MULTISENSE_REMOTE_HEAD_VPB = 12
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_MULTISENSE_REMOTE_HEAD_STEREO = 13
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_MULTISENSE_REMOTE_HEAD_MONOCAM = 14
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_MULTISENSE_KS21_SILVER = 15
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_MULTISENSE_ST25 = 16
 
static CRL_CONSTEXPR uint32_t HARDWARE_REV_MULTISENSE_KS21i = 17
 
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_NONE = 0
 
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_FLIR_TAU2 = 7
 
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 IMAGER_TYPE_TENUM1280 = 300
 
static CRL_CONSTEXPR uint32_t LIGHTING_TYPE_NONE = 0
 
static CRL_CONSTEXPR uint32_t LIGHTING_TYPE_INTERNAL = 1
 
static CRL_CONSTEXPR uint32_t LIGHTING_TYPE_EXTERNAL = 2
 
static CRL_CONSTEXPR uint32_t LIGHTING_TYPE_PATTERN_PROJECTOR = 3
 
static CRL_CONSTEXPR uint32_t LIGHTING_TYPE_OUTPUT_TRIGGER = 4
 
static CRL_CONSTEXPR uint32_t LIGHTING_TYPE_PATTERN_PROJECTOR_AND_OUTPUT_TRIGGER = 5
 

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(1500);
//
// 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 3245 of file MultiSenseTypes.hh.

Constructor & Destructor Documentation

◆ DeviceInfo()

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

Default constructor.

Definition at line 3342 of file MultiSenseTypes.hh.

Member Data Documentation

◆ buildDate

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

The date the device was manufactured.

Definition at line 3293 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_BCAM

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

Definition at line 3269 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MONO

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

Definition at line 3270 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 3258 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 3261 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MULTISENSE_KS21_SILVER

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MULTISENSE_KS21_SILVER = 15
static

Definition at line 3266 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MULTISENSE_KS21i

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MULTISENSE_KS21i = 17
static

Definition at line 3268 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 3254 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 3262 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MULTISENSE_REMOTE_HEAD_MONOCAM

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MULTISENSE_REMOTE_HEAD_MONOCAM = 14
static

Definition at line 3265 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MULTISENSE_REMOTE_HEAD_STEREO

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MULTISENSE_REMOTE_HEAD_STEREO = 13
static

Definition at line 3264 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MULTISENSE_REMOTE_HEAD_VPB

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MULTISENSE_REMOTE_HEAD_VPB = 12
static

Definition at line 3263 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 3253 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 3256 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 3259 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 3252 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 3260 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 3255 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 3251 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 3257 of file MultiSenseTypes.hh.

◆ HARDWARE_REV_MULTISENSE_ST25

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::HARDWARE_REV_MULTISENSE_ST25 = 16
static

Definition at line 3267 of file MultiSenseTypes.hh.

◆ hardwareRevision

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

The hardware revision of the given sensor.

Definition at line 3297 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 3279 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 3280 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 3274 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 3273 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 3276 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 3275 of file MultiSenseTypes.hh.

◆ IMAGER_TYPE_FLIR_TAU2

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

Definition at line 3277 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 3278 of file MultiSenseTypes.hh.

◆ IMAGER_TYPE_NONE

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

Definition at line 3272 of file MultiSenseTypes.hh.

◆ IMAGER_TYPE_TENUM1280

CRL_CONSTEXPR uint32_t crl::multisense::system::DeviceInfo::IMAGER_TYPE_TENUM1280 = 300
static

Definition at line 3281 of file MultiSenseTypes.hh.

◆ imagerHeight

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

The maximum height of the sensor's imager.

Definition at line 3309 of file MultiSenseTypes.hh.

◆ imagerName

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

The name of the sensor's imager.

Definition at line 3303 of file MultiSenseTypes.hh.

◆ imagerType

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

The type of the sensor's imager.

Definition at line 3305 of file MultiSenseTypes.hh.

◆ imagerWidth

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

The maximum width of the sensor's imager.

Definition at line 3307 of file MultiSenseTypes.hh.

◆ laserName

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

The name of the sensor's laser.

Definition at line 3328 of file MultiSenseTypes.hh.

◆ laserType

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

The type of the sensor's laser.

Definition at line 3330 of file MultiSenseTypes.hh.

◆ lensName

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

The name of the sensor's lens.

Definition at line 3312 of file MultiSenseTypes.hh.

◆ lensType

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

The type of the sensor's lens.

Definition at line 3314 of file MultiSenseTypes.hh.

◆ LIGHTING_TYPE_EXTERNAL

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

Definition at line 3285 of file MultiSenseTypes.hh.

◆ LIGHTING_TYPE_INTERNAL

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

Definition at line 3284 of file MultiSenseTypes.hh.

◆ LIGHTING_TYPE_NONE

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

Definition at line 3283 of file MultiSenseTypes.hh.

◆ LIGHTING_TYPE_OUTPUT_TRIGGER

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

Definition at line 3287 of file MultiSenseTypes.hh.

◆ LIGHTING_TYPE_PATTERN_PROJECTOR

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

Definition at line 3286 of file MultiSenseTypes.hh.

◆ LIGHTING_TYPE_PATTERN_PROJECTOR_AND_OUTPUT_TRIGGER

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

Definition at line 3288 of file MultiSenseTypes.hh.

◆ lightingType

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

The lighting type supported by the sensor.

Definition at line 3323 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 3249 of file MultiSenseTypes.hh.

◆ motorGearReduction

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

The gear reduction for the sensor's laser assembly.

Definition at line 3337 of file MultiSenseTypes.hh.

◆ motorName

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

The name of the sensor's motor.

Definition at line 3333 of file MultiSenseTypes.hh.

◆ motorType

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

The type of the sensor's motor.

Definition at line 3335 of file MultiSenseTypes.hh.

◆ name

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

The name of a given device.

Definition at line 3291 of file MultiSenseTypes.hh.

◆ nominalBaseline

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

The nominal sensor baseline in meters.

Definition at line 3316 of file MultiSenseTypes.hh.

◆ nominalFocalLength

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

The nominal focal length for the lens in meters.

Definition at line 3318 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 3320 of file MultiSenseTypes.hh.

◆ numberOfLights

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

The number of lights supported by the sensor.

Definition at line 3325 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 3300 of file MultiSenseTypes.hh.

◆ serialNumber

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

The serial number of the device.

Definition at line 3295 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:99
crl::multisense::system::DeviceInfo
Class used to store device information specific to a sensor.
Definition: MultiSenseTypes.hh:3245
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:94
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.