SeaBreeze
Public Member Functions
seabreeze::DeviceLocatorInterface Class Referenceabstract
Inheritance diagram for seabreeze::DeviceLocatorInterface:
Inheritance graph
Collaboration diagram for seabreeze::DeviceLocatorInterface:
Collaboration graph

Public Member Functions

virtual unsigned long getUniqueLocation () const =0
 
virtual bool equals (DeviceLocatorInterface &that)=0
 
virtual std::string getDescription ()=0
 
virtual BusFamily getBusFamily () const =0
 
virtual DeviceLocatorInterfaceclone () const =0
 

Member Function Documentation

◆ getUniqueLocation()

virtual unsigned long seabreeze::DeviceLocatorInterface::getUniqueLocation ( ) const
pure virtual

Get a unique identifier for this location. This can be any value as long as it is globally unique.

Implemented in seabreeze::RS232DeviceLocator, seabreeze::IPv4SocketDeviceLocator, and seabreeze::USBDeviceLocator.

◆ equals()

virtual bool seabreeze::DeviceLocatorInterface::equals ( DeviceLocatorInterface that)
pure virtual

Determine whether this DeviceLocator refers to the same device as another.

Implemented in seabreeze::RS232DeviceLocator, seabreeze::IPv4SocketDeviceLocator, and seabreeze::USBDeviceLocator.

◆ getDescription()

virtual std::string seabreeze::DeviceLocatorInterface::getDescription ( )
pure virtual

Get a human-readable string that describes the location

Implemented in seabreeze::RS232DeviceLocator, seabreeze::IPv4SocketDeviceLocator, and seabreeze::USBDeviceLocator.

◆ getBusFamily()

virtual BusFamily seabreeze::DeviceLocatorInterface::getBusFamily ( ) const
pure virtual

Get a description of the type of bus that the device is associated with

Implemented in seabreeze::RS232DeviceLocator, seabreeze::IPv4SocketDeviceLocator, and seabreeze::USBDeviceLocator.


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