optris::DeviceInfo Class Reference

Holds important information about a device. More...

#include <DeviceInfo.h>

Collaboration diagram for optris::DeviceInfo:

Public Member Functions
OTC_SDK_API	DeviceInfo () noexcept
	Constructor.
OTC_SDK_API void	setSerialNumber (unsigned long serialNumber) noexcept
	Sets the serial number of the device.
OTC_SDK_API unsigned long	getSerialNumber () const noexcept
	Returns the serial number of the device.
OTC_SDK_API void	setConnectionInterface (const std::string &connectionInterface) noexcept
	Sets the connection interface of the device.
OTC_SDK_API const std::string &	getConnectionInterface () const noexcept
	Returns the connection interface of the device.
OTC_SDK_API void	setIpAddress (const IpAddress &ipAddress) noexcept
	Sets the IP address.
OTC_SDK_API const IpAddress &	getIpAddress () const noexcept
	Returns the IP address.
OTC_SDK_API void	setPort (const Port &port) noexcept
	Sets the port.
OTC_SDK_API const Port &	getPort () const noexcept
	Returns the port.
OTC_SDK_API DeviceType	getDeviceType () const noexcept
	Return the device type.
OTC_SDK_API void	setRevisions (unsigned short hardware, unsigned short firmware) noexcept
	Sets the hardware and firmware revisions.
OTC_SDK_API unsigned short	getHardwareRevision () const noexcept
	Returns the hardware revision.
OTC_SDK_API unsigned short	getFirmwareRevision () const noexcept
	Returns the firmware revision.
OTC_SDK_API DeviceInfo	clone () const noexcept
	Returns a complete copy of this informatin.
OTC_SDK_API bool	operator== (const DeviceInfo &rhs) const noexcept
	Equals operator.
OTC_SDK_API bool	operator!= (const DeviceInfo &rhs) const noexcept
	Unequals operator.
OTC_SDK_API bool	operator< (const DeviceInfo &rhs) const noexcept
	Less than operator.

Static Public Member Functions
static OTC_SDK_API DeviceType	determineDeviceType (unsigned short hardwareRevision, unsigned short firmwareRevision) noexcept
	Determines the device type based on the provided hardware and firmware revisions.

Detailed Description

Holds important information about a device.

Instances of this class are provided by the EnumerationManager and can be used to establish an connection through an IRImager implementation.

Member Function Documentation

clone()

DeviceInfo optris::DeviceInfo::clone ( ) const

inlinenoexcept

Returns a complete copy of this informatin.

Returns

a complete copy of this information.

determineDeviceType()

static OTC_SDK_API DeviceType optris::DeviceInfo::determineDeviceType ( unsigned short hardwareRevision, unsigned short firmwareRevision )

staticnoexcept

Determines the device type based on the provided hardware and firmware revisions.

Returns

determined device type.

getConnectionInterface()

const std::string & optris::DeviceInfo::getConnectionInterface ( ) const

inlinenoexcept

Returns the connection interface of the device.

This can, for example, be USB or Ethernet.

Returns

connection interface of the device.

getDeviceType()

DeviceType optris::DeviceInfo::getDeviceType ( ) const

inlinenoexcept

Return the device type.

Returns

device type.

getFirmwareRevision()

unsigned short optris::DeviceInfo::getFirmwareRevision ( ) const

inlinenoexcept

Returns the firmware revision.

Returns

firmware revision.

getHardwareRevision()

unsigned short optris::DeviceInfo::getHardwareRevision ( ) const

inlinenoexcept

Returns the hardware revision.

Returns

hardware revision.

getIpAddress()

const IpAddress & optris::DeviceInfo::getIpAddress ( ) const

inlinenoexcept

Returns the IP address.

For Ethernet connections this refers to the IP address of the device.

Returns

IP address.

getPort()

const Port & optris::DeviceInfo::getPort ( ) const

inlinenoexcept

Returns the port.

For Ethernet connections this refers to the port the device will send its data to.

Returns

port.

getSerialNumber()

unsigned long optris::DeviceInfo::getSerialNumber ( ) const

inlinenoexcept

Returns the serial number of the device.

Returns

serial number of the device.

setConnectionInterface()

void optris::DeviceInfo::setConnectionInterface ( const std::string & connectionInterface )

inlinenoexcept

Sets the connection interface of the device.

This can, for example, be USB or Ethernet.

Parameters

[in]

connectionInterface

to set.

setIpAddress()

void optris::DeviceInfo::setIpAddress ( const IpAddress & ipAddress )

inlinenoexcept

Sets the IP address.

For Ethernet connections this refers to the IP address of the device.

Parameters

[in]

ipAddress

address to set.

setPort()

void optris::DeviceInfo::setPort ( const Port & port )

inlinenoexcept

Sets the port.

For Ethernet connections this refers to the port the device will send its data to.

Parameters

[in]

port

to set.

setRevisions()

OTC_SDK_API void optris::DeviceInfo::setRevisions ( unsigned short hardware, unsigned short firmware )

noexcept

Sets the hardware and firmware revisions.

Parameters

[in]	hardware	revision to set.
[in]	firmware	revision to set.

setSerialNumber()

void optris::DeviceInfo::setSerialNumber ( unsigned long serialNumber )

inlinenoexcept

Sets the serial number of the device.

Parameters

[in]

serialNumber

to set.

---

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

• DeviceInfo.h