Public Member Functions | Private Attributes | List of all members
rcdiscover::DeviceInfo Class Reference

#include <deviceinfo.h>

Public Member Functions

void clear ()
 Clears all information. More...
 
 DeviceInfo (std::string iface_name)
 
const std::string & getDeviceVersion () const
 Returns the device version. More...
 
uint32_t getGateway () const
 Returns the current IP address of the devices gateway. More...
 
const std::string & getIfaceName () const
 Returns the name of the interface on which this device was found. More...
 
uint32_t getIP () const
 Returns the current IP address of the device. More...
 
uint64_t getMAC () const
 Returns 6 bytes with the MAC address of the device. More...
 
int getMajorVersion () const
 Return major version of device. More...
 
const std::string & getManufacturerInfo () const
 Returns manufacturer specific information. More...
 
const std::string & getManufacturerName () const
 Returns the manufacturer name. More...
 
int getMinorVersion () const
 Return minor version of device. More...
 
const std::string & getModelName () const
 Returns the model name. More...
 
const std::string & getSerialNumber () const
 Returns the serial number. More...
 
uint32_t getSubnetMask () const
 Returns the current subnet mask of the device. More...
 
const std::string & getUserName () const
 Returns the user name. More...
 
bool isValid () const
 Checks if the object contains useful information. More...
 
bool operator< (const DeviceInfo &info) const
 First compares the MAC address, then the interface name. More...
 
void set (const uint8_t *raw, size_t len)
 Extracts the RAW GigE Vision information according to the given DISCOVERY_ACK package. More...
 

Private Attributes

std::string device_version
 
uint32_t gateway
 
std::string iface_name
 
uint32_t ip
 
uint64_t mac
 
int major
 
std::string manufacturer_info
 
std::string manufacturer_name
 
int minor
 
std::string model_name
 
std::string serial_number
 
uint32_t subnet
 
std::string user_name
 

Detailed Description

Definition at line 46 of file deviceinfo.h.

Constructor & Destructor Documentation

rcdiscover::DeviceInfo::DeviceInfo ( std::string  iface_name)
explicit

Definition at line 73 of file deviceinfo.cc.

Member Function Documentation

void rcdiscover::DeviceInfo::clear ( )

Clears all information.

Definition at line 125 of file deviceinfo.cc.

const std::string& rcdiscover::DeviceInfo::getDeviceVersion ( ) const
inline

Returns the device version.

Returns
Device version.

Definition at line 144 of file deviceinfo.h.

uint32_t rcdiscover::DeviceInfo::getGateway ( ) const
inline

Returns the current IP address of the devices gateway.

Returns
4 bytes with an IPv4 address.

Definition at line 120 of file deviceinfo.h.

const std::string& rcdiscover::DeviceInfo::getIfaceName ( ) const
inline

Returns the name of the interface on which this device was found.

Definition at line 180 of file deviceinfo.h.

uint32_t rcdiscover::DeviceInfo::getIP ( ) const
inline

Returns the current IP address of the device.

Returns
4 bytes with an IPv4 address.

Definition at line 104 of file deviceinfo.h.

uint64_t rcdiscover::DeviceInfo::getMAC ( ) const
inline

Returns 6 bytes with the MAC address of the device.

Returns
Pointer to 6 bytes with the MAC address.

Definition at line 96 of file deviceinfo.h.

int rcdiscover::DeviceInfo::getMajorVersion ( ) const
inline

Return major version of device.

Returns
Major version.

Definition at line 80 of file deviceinfo.h.

const std::string& rcdiscover::DeviceInfo::getManufacturerInfo ( ) const
inline

Returns manufacturer specific information.

Returns
Manufacturer info.

Definition at line 152 of file deviceinfo.h.

const std::string& rcdiscover::DeviceInfo::getManufacturerName ( ) const
inline

Returns the manufacturer name.

Returns
Manufacturer name.

Definition at line 128 of file deviceinfo.h.

int rcdiscover::DeviceInfo::getMinorVersion ( ) const
inline

Return minor version of device.

Returns
Minor version.

Definition at line 88 of file deviceinfo.h.

const std::string& rcdiscover::DeviceInfo::getModelName ( ) const
inline

Returns the model name.

Returns
Model name.

Definition at line 136 of file deviceinfo.h.

const std::string& rcdiscover::DeviceInfo::getSerialNumber ( ) const
inline

Returns the serial number.

Returns
Serial number.

Definition at line 160 of file deviceinfo.h.

uint32_t rcdiscover::DeviceInfo::getSubnetMask ( ) const
inline

Returns the current subnet mask of the device.

Returns
4 bytes with an IPv4 subnet mask.

Definition at line 112 of file deviceinfo.h.

const std::string& rcdiscover::DeviceInfo::getUserName ( ) const
inline

Returns the user name.

Returns
User name.

Definition at line 168 of file deviceinfo.h.

bool rcdiscover::DeviceInfo::isValid ( ) const
inline

Checks if the object contains useful information.

Definition at line 72 of file deviceinfo.h.

bool rcdiscover::DeviceInfo::operator< ( const DeviceInfo info) const
inline

First compares the MAC address, then the interface name.

Definition at line 174 of file deviceinfo.h.

void rcdiscover::DeviceInfo::set ( const uint8_t *  raw,
size_t  len 
)

Extracts the RAW GigE Vision information according to the given DISCOVERY_ACK package.

Parameters
rawPointer to raw message body, excluding header.
lenLength of body as specified in the header.

Definition at line 79 of file deviceinfo.cc.

Member Data Documentation

std::string rcdiscover::DeviceInfo::device_version
private

Definition at line 196 of file deviceinfo.h.

uint32_t rcdiscover::DeviceInfo::gateway
private

Definition at line 192 of file deviceinfo.h.

std::string rcdiscover::DeviceInfo::iface_name
private

Definition at line 184 of file deviceinfo.h.

uint32_t rcdiscover::DeviceInfo::ip
private

Definition at line 190 of file deviceinfo.h.

uint64_t rcdiscover::DeviceInfo::mac
private

Definition at line 189 of file deviceinfo.h.

int rcdiscover::DeviceInfo::major
private

Definition at line 186 of file deviceinfo.h.

std::string rcdiscover::DeviceInfo::manufacturer_info
private

Definition at line 197 of file deviceinfo.h.

std::string rcdiscover::DeviceInfo::manufacturer_name
private

Definition at line 194 of file deviceinfo.h.

int rcdiscover::DeviceInfo::minor
private

Definition at line 187 of file deviceinfo.h.

std::string rcdiscover::DeviceInfo::model_name
private

Definition at line 195 of file deviceinfo.h.

std::string rcdiscover::DeviceInfo::serial_number
private

Definition at line 198 of file deviceinfo.h.

uint32_t rcdiscover::DeviceInfo::subnet
private

Definition at line 191 of file deviceinfo.h.

std::string rcdiscover::DeviceInfo::user_name
private

Definition at line 199 of file deviceinfo.h.


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


rcdiscover
Author(s): Heiko Hirschmueller , Raphael Schaller
autogenerated on Sun Apr 18 2021 02:16:32