Galaxis Codebase  1.0.0
Team Galaxis software stack for the Carolo Cup 2023 - ROS2 based software
ICommunication Class Referenceabstract

#include <ICommunication.h>

Inheritance diagram for ICommunication:

Public Member Functions

virtual ~ICommunication ()
 
virtual void VInitialize ()
 
virtual void VConnect ()=0
 
virtual void VDisconnect ()=0
 
virtual size_t VSendData (void *, const size_t)=0
 
virtual size_t VReceiveData (void *, const size_t)=0
 
bool IsConnected () const
 

Protected Attributes

bool m_connected
 

Detailed Description

Definition at line 5 of file ICommunication.h.

Constructor & Destructor Documentation

◆ ~ICommunication()

virtual ICommunication::~ICommunication ( )
inlinevirtual

Definition at line 15 of file ICommunication.h.

15 {}

Member Function Documentation

◆ IsConnected()

bool ICommunication::IsConnected ( ) const
inline

Definition at line 52 of file ICommunication.h.

52  {
53  return m_connected;
54  }

References m_connected.

◆ VConnect()

virtual void ICommunication::VConnect ( )
pure virtual

Implemented in UART.

◆ VDisconnect()

virtual void ICommunication::VDisconnect ( )
pure virtual

Implemented in UART.

◆ VInitialize()

virtual void ICommunication::VInitialize ( )
inlinevirtual

Definition at line 22 of file ICommunication.h.

22 {};

◆ VReceiveData()

virtual size_t ICommunication::VReceiveData ( void *  ,
const  size_t 
)
pure virtual

Implemented in UART.

◆ VSendData()

virtual size_t ICommunication::VSendData ( void *  ,
const  size_t 
)
pure virtual

Implemented in UART.

Member Data Documentation

◆ m_connected

bool ICommunication::m_connected
protected

Definition at line 7 of file ICommunication.h.

Referenced by IsConnected(), UART::VConnect(), and UART::VDisconnect().


The documentation for this class was generated from the following file:
ICommunication::m_connected
bool m_connected
Definition: ICommunication.h:7