roo_transceivers
API Documentation for roo_transceivers
Loading...
Searching...
No Matches
roo_transceivers::DeviceLocator Class Reference

Identifies a transceiver device by schema and device id. More...

#include <id.h>

Public Member Functions

 DeviceLocator ()
 
 DeviceLocator (roo::string_view schema, roo::string_view device_id)
 
const DeviceSchemaschema () const
 Returns the device schema.
 
const DeviceIddevice_id () const
 Returns the device id.
 
bool isDefined () const
 Returns true if schema or device id is set.
 
void write_cstr (char *buf) const
 Writes a null-terminated string representation into buf.
 
std::string toString () const
 Returns a string representation.
 

Detailed Description

Identifies a transceiver device by schema and device id.

Definition at line 21 of file id.h.

Constructor & Destructor Documentation

◆ DeviceLocator() [1/2]

roo_transceivers::DeviceLocator::DeviceLocator ( )

Definition at line 5 of file id.cpp.

◆ DeviceLocator() [2/2]

roo_transceivers::DeviceLocator::DeviceLocator ( roo::string_view  schema,
roo::string_view  device_id 
)

Definition at line 7 of file id.cpp.

Member Function Documentation

◆ device_id()

◆ isDefined()

bool roo_transceivers::DeviceLocator::isDefined ( ) const
inline

Returns true if schema or device id is set.

Definition at line 33 of file id.h.

References device_id().

Referenced by roo_transceivers::SensorLocator::isDefined(), and roo_transceivers::ActuatorLocator::isDefined().

◆ schema()

◆ toString()

std::string roo_transceivers::DeviceLocator::toString ( ) const

Returns a string representation.

Definition at line 20 of file id.cpp.

References write_cstr().

◆ write_cstr()

void roo_transceivers::DeviceLocator::write_cstr ( char *  buf) const

Writes a null-terminated string representation into buf.

Definition at line 11 of file id.cpp.

Referenced by toString(), roo_transceivers::SensorLocator::write_cstr(), and roo_transceivers::ActuatorLocator::write_cstr().


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