Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Private Attributes | List of all members
canopen::Layer Class Referenceabstract

#include <layer.h>

Inheritance diagram for canopen::Layer:
Inheritance graph
[legend]

Public Types

enum  LayerState {
  Off, Init, Shutdown, Error,
  Halt, Recover, Ready
}
 

Public Member Functions

void diag (LayerReport &report)
 
LayerState getLayerState ()
 
void halt (LayerStatus &status)
 
void init (LayerStatus &status)
 
 Layer (const std::string &n)
 
void read (LayerStatus &status)
 
void recover (LayerStatus &status)
 
void shutdown (LayerStatus &status)
 
void write (LayerStatus &status)
 
virtual ~Layer ()
 

Public Attributes

const std::string name
 

Protected Member Functions

virtual void handleDiag (LayerReport &report)=0
 
virtual void handleHalt (LayerStatus &status)=0
 
virtual void handleInit (LayerStatus &status)=0
 
virtual void handleRead (LayerStatus &status, const LayerState &current_state)=0
 
virtual void handleRecover (LayerStatus &status)=0
 
virtual void handleShutdown (LayerStatus &status)=0
 
virtual void handleWrite (LayerStatus &status, const LayerState &current_state)=0
 

Private Attributes

std::atomic< LayerStatestate
 

Detailed Description

Definition at line 63 of file layer.h.

Member Enumeration Documentation

◆ LayerState

Enumerator
Off 
Init 
Shutdown 
Error 
Halt 
Recover 
Ready 

Definition at line 65 of file layer.h.

Constructor & Destructor Documentation

◆ Layer()

canopen::Layer::Layer ( const std::string &  n)
inline

Definition at line 127 of file layer.h.

◆ ~Layer()

virtual canopen::Layer::~Layer ( )
inlinevirtual

Definition at line 129 of file layer.h.

Member Function Documentation

◆ diag()

void canopen::Layer::diag ( LayerReport report)
inline

Definition at line 83 of file layer.h.

◆ getLayerState()

LayerState canopen::Layer::getLayerState ( )
inline

Definition at line 125 of file layer.h.

◆ halt()

void canopen::Layer::halt ( LayerStatus status)
inline

Definition at line 103 of file layer.h.

◆ handleDiag()

virtual void canopen::Layer::handleDiag ( LayerReport report)
protectedpure virtual

◆ handleHalt()

virtual void canopen::Layer::handleHalt ( LayerStatus status)
protectedpure virtual

◆ handleInit()

virtual void canopen::Layer::handleInit ( LayerStatus status)
protectedpure virtual

◆ handleRead()

virtual void canopen::Layer::handleRead ( LayerStatus status,
const LayerState current_state 
)
protectedpure virtual

◆ handleRecover()

virtual void canopen::Layer::handleRecover ( LayerStatus status)
protectedpure virtual

◆ handleShutdown()

virtual void canopen::Layer::handleShutdown ( LayerStatus status)
protectedpure virtual

◆ handleWrite()

virtual void canopen::Layer::handleWrite ( LayerStatus status,
const LayerState current_state 
)
protectedpure virtual

◆ init()

void canopen::Layer::init ( LayerStatus status)
inline

Definition at line 86 of file layer.h.

◆ read()

void canopen::Layer::read ( LayerStatus status)
inline

Definition at line 77 of file layer.h.

◆ recover()

void canopen::Layer::recover ( LayerStatus status)
inline

Definition at line 110 of file layer.h.

◆ shutdown()

void canopen::Layer::shutdown ( LayerStatus status)
inline

Definition at line 96 of file layer.h.

◆ write()

void canopen::Layer::write ( LayerStatus status)
inline

Definition at line 80 of file layer.h.

Member Data Documentation

◆ name

const std::string canopen::Layer::name

Definition at line 75 of file layer.h.

◆ state

std::atomic<LayerState> canopen::Layer::state
private

Definition at line 144 of file layer.h.


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


canopen_master
Author(s): Mathias L├╝dtke
autogenerated on Tue May 4 2021 02:50:21