Kallisto Class Reference

#include <kallisto.hpp>

Inheritance diagram for Kallisto:

Public Member Functions
std::string	getName () const
std::string	getAddress () const
std::string	getManufacturer () const
std::string	getSoftwareVersion () const
std::string	getFirmwareVersion () const
std::string	getHardwareVersion () const
virtual bool	getBeingUsed ()=0
virtual bool	getLinkLoss ()=0
bool	operator== (const Kallisto &other) const
bool	operator!= (const Kallisto &other) const

Protected Member Functions
	Kallisto (std::string name, std::string address)
virtual	~Kallisto ()
	Kallisto (Kallisto const &)=delete
	Kallisto (Kallisto &&)=delete
void	operator= (Kallisto const &)=delete
void	operator= (Kallisto &&)=delete

Protected Attributes
const std::string	m_name
const std::string	m_address
std::string	m_manufacturer
std::string	m_software_version
std::string	m_firmware_version
std::string	m_hardware_version

Detailed Description

Class that manages an Kallisto device.

Constructor & Destructor Documentation

Kallisto() [1/2]

Kallisto ( std::string  name, std::string  address  )

protected

Constructor.

~Kallisto()

virtual ~Kallisto ( )

protectedvirtual

Destructor.

Kallisto() [2/2]

Kallisto ( Kallisto const &  )

protecteddelete

Remove copy and move.

Member Function Documentation

getAddress()

std::string getAddress

(

)

const

Get this Kallisto advertised MAC address.

Returns

This Kallisto address.

getBeingUsed()

virtual bool getBeingUsed ( )

pure virtual

Checks if the Kallisto is under active use.

Returns

true 

if the device is under use (sensor enabled, etc.).

Implemented in KallistoImpl.

getFirmwareVersion()

std::string getFirmwareVersion

(

)

const

Get this Kallisto firmware version.

Returns

This Kallisto firmware version.

getHardwareVersion()

std::string getHardwareVersion

(

)

const

Get this Kallisto hardware version.

Returns

This Kallisto hardware version.

getLinkLoss()

virtual bool getLinkLoss ( )

pure virtual

Checks if this Kallisto device is in Link Loss.

Link loss represents a state where the device should be connected but that connection was lost. The system will actively try to recover the connection.

Returns

true 

if this Kallisto is in Link Loss.

Implemented in KallistoImpl.

getManufacturer()

std::string getManufacturer

(

)

const

Get this Kallisto manufacturer.

Returns

This Kallisto manufacturer.

getName()

std::string getName

(

)

const

Get this Kallisto advertised name.

Returns

This Kallisto name.

getSoftwareVersion()

std::string getSoftwareVersion

(

)

const

Get this Kallisto software version.

Returns

This Kallisto software version.

Field Documentation

m_address

const std::string m_address

protected

m_firmware_version

std::string m_firmware_version

protected

m_hardware_version

std::string m_hardware_version

protected

m_manufacturer

std::string m_manufacturer

protected

m_name

const std::string m_name

protected

m_software_version

std::string m_software_version

protected

---

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

• /home/joao.oliveira/Workspace/local/repo/documentation/sphinx/source/components/kallistolinuxapi/include/hardware/kallisto.hpp