swarmio::transport::BasicNode Class Reference

A simple Node with a UUID. More...

#include <BasicNode.h>

Inheritance diagram for swarmio::transport::BasicNode:

Public Member Functions
	BasicNode (const std::string &uuid, const std::string &name, const std::string &deviceClass)
	Construct a new BasicNode object. More...
virtual const std::string &	GetDeviceClass () const override
	Get the class of the underlying device. More...
virtual const std::string &	GetName () const override
	Returns the (possibly non-unique) name of the node. More...
virtual const std::string &	GetUUID () const override
	Get the unique identifier of the node. More...
Public Member Functions inherited from swarmio::Node
virtual std::string	GetDescription () const =0
	Get a user-readable description of the node. More...
virtual bool	IsOnline () const =0
	Checks whether the Node is reachable. More...
virtual	~Node ()
	Destroy the Node object. More...

Private Attributes
std::string	_deviceClass
	Device class. More...
std::string	_name
	The name of the node. More...
std::string	_uuid
	The unique identifier of the node. More...

Detailed Description

A simple Node with a UUID.

Definition at line 11 of file BasicNode.h.

Constructor & Destructor Documentation

swarmio::transport::BasicNode::BasicNode ( const std::string &  uuid, const std::string &  name, const std::string &  deviceClass  )

inline

Construct a new BasicNode object.

Parameters

uuid	Unique identifier
name	Discoverable name
deviceClass	Device class

Definition at line 42 of file BasicNode.h.

Member Function Documentation

virtual const std::string& swarmio::transport::BasicNode::GetDeviceClass ( ) const

inlineoverridevirtual

Get the class of the underlying device.

Returns

const std::string&

Implements swarmio::Node.

Definition at line 70 of file BasicNode.h.

virtual const std::string& swarmio::transport::BasicNode::GetName ( ) const

inlineoverridevirtual

Returns the (possibly non-unique) name of the node.

Returns

const std::string&

Implements swarmio::Node.

Definition at line 60 of file BasicNode.h.

virtual const std::string& swarmio::transport::BasicNode::GetUUID ( ) const

inlineoverridevirtual

Get the unique identifier of the node.

Returns

const std::string&

Implements swarmio::Node.

Definition at line 50 of file BasicNode.h.

Member Data Documentation

std::string swarmio::transport::BasicNode::_deviceClass

private

Device class.

Definition at line 31 of file BasicNode.h.

std::string swarmio::transport::BasicNode::_name

private

The name of the node.

Definition at line 25 of file BasicNode.h.

std::string swarmio::transport::BasicNode::_uuid

private

The unique identifier of the node.

Definition at line 19 of file BasicNode.h.

---

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

• BasicNode.h