#include <iSubsys.hpp>

Inheritance diagram for sup::syssup::common::ISubsys:

Public Member Functions
virtual bool	IsNotReady () const =0
	Check if subsys is Standby/NotReady. More...

virtual bool	IsReady () const =0
	Check if subsys is Standby/Ready. More...

virtual bool	IsOperational () const =0
	Check if subsys is Operational. More...

virtual void	CheckSubsysFailure () const =0
	Check if subsys is in failure state. More...

virtual bool	IsDisabling () const =0
	Check if subsys is disablig. More...

virtual std::optional< elt::mal::future< void > >	Connect ()=0

virtual void	StartSubscription ()=0

virtual elt::mal::future< std::string >	Init ()=0
	Executes a Init command. More...

virtual elt::mal::future< std::string >	Enable ()=0
	Executes a Enable command. More...

virtual elt::mal::future< std::string >	Disable ()=0
	Executes a Disable command. More...

virtual elt::mal::future< std::string >	Stop ()=0
	Executes a Stop command. More...

virtual elt::mal::future< std::string >	GetState ()=0

virtual elt::mal::future< std::string >	GetStatus ()=0

virtual elt::mal::future< std::string >	GetVersion ()=0

virtual elt::mal::future< std::string >	Reset ()=0
	Executes a Reset command. More...

virtual void	Status (const std::string &payload, std::string &buffer)=0
	Obtain the status of the subsys. More...

virtual void	Ignore (rad::AnyEvent const &last_event)=0
	Executes a Ignore. More...

virtual void	StopIgn (rad::AnyEvent const &last_event)=0
	Executes a StopIgn. More...

virtual void	SubsysReset (rad::AnyEvent const &last_event)=0
	Executes a hardware reset command. More...

virtual void	SubsysInit (rad::AnyEvent const &last_event)=0
	Executes a hardware init command. More...

virtual void	SubsysEnable (rad::AnyEvent const &last_event)=0
	Executes a hardware enable command. More...

virtual void	SubsysDisable (rad::AnyEvent const &last_event)=0
	Executes a hardware disable command. More...

virtual void	Setup (const std::any &payload)=0
	Executes a run time configuration. More...

virtual void	UpdateConfig ()=0
	Update subsystem configuration. More...

virtual std::string	GetName () const =0
	Get subsys name. More...

Detailed Description

Subsys abstract class. This class represents the basic implementation of a subsys class. Most of the subsys share common properties and behavioural aspects. This class is implementing the common behaviour and defining the basic properties, as well as declaring the abstracts methods that need to be implemented by derived classes.

Member Function Documentation

◆ CheckSubsysFailure()

virtual void sup::syssup::common::ISubsys::CheckSubsysFailure ( ) const

pure virtual

Check if subsys is in failure state.

Exceptions

an	exception if an error ocurrs.

Implemented in sup::syssup::common::Subsys.

◆ Connect()

virtual std::optional<elt::mal::future<void> > sup::syssup::common::ISubsys::Connect ( )

pure virtual

◆ Disable()

virtual elt::mal::future<std::string> sup::syssup::common::ISubsys::Disable ( )

pure virtual

Executes a Disable command.

Exceptions

an	exception if an error ocurrs.

◆ Enable()

virtual elt::mal::future<std::string> sup::syssup::common::ISubsys::Enable ( )

pure virtual

Executes a Enable command.

Exceptions

an	exception if an error ocurrs.

◆ GetName()

virtual std::string sup::syssup::common::ISubsys::GetName ( ) const

pure virtual

Get subsys name.

◆ GetState()

virtual elt::mal::future<std::string> sup::syssup::common::ISubsys::GetState ( )

pure virtual

◆ GetStatus()

virtual elt::mal::future<std::string> sup::syssup::common::ISubsys::GetStatus ( )

pure virtual

◆ GetVersion()

virtual elt::mal::future<std::string> sup::syssup::common::ISubsys::GetVersion ( )

pure virtual

◆ Ignore()

virtual void sup::syssup::common::ISubsys::Ignore ( rad::AnyEvent const & last_event )

pure virtual

Executes a Ignore.

Parameters

[in] last_event contains the payload of the Ignore message.

Exceptions

an	exception if an error ocurrs.

Implemented in sup::syssup::common::Subsys.

◆ Init()

virtual elt::mal::future<std::string> sup::syssup::common::ISubsys::Init ( )

pure virtual

Executes a Init command.

Exceptions

an	exception if an error ocurrs.

◆ IsDisabling()

virtual bool sup::syssup::common::ISubsys::IsDisabling ( ) const

pure virtual

Check if subsys is disablig.

Returns: true if subsys is disabling, false otherwise

Implemented in sup::syssup::common::Subsys.

◆ IsNotReady()

virtual bool sup::syssup::common::ISubsys::IsNotReady ( ) const

pure virtual

Check if subsys is Standby/NotReady.

Implemented in sup::syssup::common::Subsys.

◆ IsOperational()

virtual bool sup::syssup::common::ISubsys::IsOperational ( ) const

pure virtual

Check if subsys is Operational.

Returns: true is subsys is Operational, false otherwise

Implemented in sup::syssup::common::Subsys.

◆ IsReady()

virtual bool sup::syssup::common::ISubsys::IsReady ( ) const

pure virtual

Check if subsys is Standby/Ready.

Returns: true is subsys is Standby/Ready, false otherwise

Implemented in sup::syssup::common::Subsys.

◆ Reset()

virtual elt::mal::future<std::string> sup::syssup::common::ISubsys::Reset ( )

pure virtual

Executes a Reset command.

Exceptions

an	exception if an error ocurrs.

◆ Setup()

virtual void sup::syssup::common::ISubsys::Setup ( const std::any & payload )

pure virtual

Executes a run time configuration.

Parameters

[in] payload contains the payload of the setup message.

Exceptions

an	exception if an error ocurrs.

◆ StartSubscription()

virtual void sup::syssup::common::ISubsys::StartSubscription ( )

pure virtual

◆ Status()

virtual void sup::syssup::common::ISubsys::Status	(	const std::string &	payload,
		std::string &	buffer
	)

pure virtual

Obtain the status of the subsys.

Parameters

buffer Buffer where the status will be written

◆ Stop()

virtual elt::mal::future<std::string> sup::syssup::common::ISubsys::Stop ( )

pure virtual

Executes a Stop command.

Exceptions

an	exception if an error ocurrs.

◆ StopIgn()

virtual void sup::syssup::common::ISubsys::StopIgn ( rad::AnyEvent const & last_event )

pure virtual

Executes a StopIgn.

Parameters

[in] last_event contains the payload of the StopIgn message.

Exceptions

an	exception if an error ocurrs.

Implemented in sup::syssup::common::Subsys.

◆ SubsysDisable()

virtual void sup::syssup::common::ISubsys::SubsysDisable ( rad::AnyEvent const & last_event )

pure virtual

Executes a hardware disable command.

Parameters

[in] last_event payload of the hw disable message

Exceptions

an	exception if an error ocurrs.

Implemented in sup::syssup::common::Subsys.

◆ SubsysEnable()

virtual void sup::syssup::common::ISubsys::SubsysEnable ( rad::AnyEvent const & last_event )

pure virtual

Executes a hardware enable command.

Parameters

[in] last_event payload of the hw enable message

Exceptions

an	exception if an error ocurrs.

Implemented in sup::syssup::common::Subsys.

◆ SubsysInit()

virtual void sup::syssup::common::ISubsys::SubsysInit ( rad::AnyEvent const & last_event )

pure virtual

Executes a hardware init command.

Parameters

[in] last_event payload of the hw init message

Exceptions

an	exception if an error ocurrs.

Implemented in sup::syssup::common::Subsys.

◆ SubsysReset()

virtual void sup::syssup::common::ISubsys::SubsysReset ( rad::AnyEvent const & last_event )

pure virtual

Executes a hardware reset command.

Parameters

[in] last_event payload of the hw reset message

Exceptions

an	exception if an error ocurrs.

Implemented in sup::syssup::common::Subsys.

◆ UpdateConfig()

virtual void sup::syssup::common::ISubsys::UpdateConfig ( )

pure virtual

Update subsystem configuration.

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

syssup/common/src/include/ifw/sup/syssup/common/iSubsys.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ CheckSubsysFailure()

◆ Connect()

◆ Disable()

◆ Enable()

◆ GetName()

◆ GetState()

◆ GetStatus()

◆ GetVersion()

◆ Ignore()

◆ Init()

◆ IsDisabling()

◆ IsNotReady()

◆ IsOperational()

◆ IsReady()

◆ Reset()

◆ Setup()

◆ StartSubscription()

◆ Status()

◆ Stop()

◆ StopIgn()

◆ SubsysDisable()

◆ SubsysEnable()

◆ SubsysInit()

◆ SubsysReset()

◆ UpdateConfig()