DAQ Driver
DeviceStatus Class Reference

The DeviceStatus class can be used to retrieve the status of the Voyager such as temperature or battery charge level. More...

#include <Driver/DriverComponents/DeviceStatus.h>

Inheritance diagram for DeviceStatus:
Collaboration diagram for DeviceStatus:

Public Member Functions

 DeviceStatus (pMessageProcessor messageProcessor)
 
DeviceStatusStructure remoteDeviceStatus () const
 remoteDeviceStatus Retrieves the current remote device status More...
 
void sendStatus (const DeviceStatusStructure status)
 sendStatus Sends device status to other remote device More...
 
std::shared_ptr< std::function< void()> > addremoteDeviceStatusUpdated (const std::function< void()> &newBufferCallback)
 
bool removeRemoteDeviceStatusUpdated (std::shared_ptr< std::function< void(void)>> callback)
 
virtual void reset () override
 reset Resets the components More...
 
- Public Member Functions inherited from AbstractDriverComponent
 AbstractDriverComponent (pMessageProcessor messageProcessor)
 

Protected Member Functions

void handleDeviceStatusRecieved (const google::protobuf::Message &message)
 

Private Attributes

DeviceStatusStructure m_remoteDeviceStatus
 
CallbackHandler m_remoteDeviceStatusUpdatedCallbackHandler
 

Additional Inherited Members

- Protected Attributes inherited from AbstractDriverComponent
pMessageProcessor m_messageProcessor
 

Detailed Description

The DeviceStatus class can be used to retrieve the status of the Voyager such as temperature or battery charge level.

Definition at line 17 of file DeviceStatus.h.

Constructor & Destructor Documentation

◆ DeviceStatus()

DeviceStatus::DeviceStatus ( pMessageProcessor  messageProcessor)

Definition at line 3 of file DeviceStatus.cpp.

Member Function Documentation

◆ addremoteDeviceStatusUpdated()

std::shared_ptr< std::function< void()> > DeviceStatus::addremoteDeviceStatusUpdated ( const std::function< void()> &  newBufferCallback)

Definition at line 16 of file DeviceStatus.cpp.

◆ handleDeviceStatusRecieved()

void DeviceStatus::handleDeviceStatusRecieved ( const google::protobuf::Message &  message)
protected

Definition at line 29 of file DeviceStatus.cpp.

◆ remoteDeviceStatus()

DeviceStatusStructure DeviceStatus::remoteDeviceStatus ( ) const

remoteDeviceStatus Retrieves the current remote device status

Returns
current remote device status

Definition at line 8 of file DeviceStatus.cpp.

◆ removeRemoteDeviceStatusUpdated()

bool DeviceStatus::removeRemoteDeviceStatusUpdated ( std::shared_ptr< std::function< void(void)>>  callback)

Definition at line 20 of file DeviceStatus.cpp.

◆ reset()

void DeviceStatus::reset ( )
overridevirtual

reset Resets the components

Implements AbstractDriverComponent.

Definition at line 24 of file DeviceStatus.cpp.

◆ sendStatus()

void DeviceStatus::sendStatus ( const DeviceStatusStructure  status)

sendStatus Sends device status to other remote device

Parameters
statusstatus to send

Definition at line 12 of file DeviceStatus.cpp.

Member Data Documentation

◆ m_remoteDeviceStatus

DeviceStatusStructure DeviceStatus::m_remoteDeviceStatus
private

Definition at line 55 of file DeviceStatus.h.

◆ m_remoteDeviceStatusUpdatedCallbackHandler

CallbackHandler DeviceStatus::m_remoteDeviceStatusUpdatedCallbackHandler
private

Definition at line 56 of file DeviceStatus.h.