imt::base::dff::runtime::ExecutableIfc Class Reference

Interface of an executable which is called by the runtime once an event has to be processed. More...

#include <Imt.Base.Dff.Runtime/inc/Imt.Base.Dff.Runtime/ExecutableIfc.h>

Inheritance diagram for imt::base::dff::runtime::ExecutableIfc:

Public Member Functions
	ExecutableIfc (ExecutableIfc const &)=delete
	ExecutableIfc (ExecutableIfc &&)=delete
ExecutableIfc &	operator= (ExecutableIfc const &) &=delete
ExecutableIfc &	operator= (ExecutableIfc &&) &=delete
virtual	~ExecutableIfc ()=default
	Destructor.
virtual void	execute (uint16_t const protocolID, ::imt::base::core::serialization::Deserializer &buffer)=0
	One-Shot function which is called once a message is ready to be processed.
virtual ExecutableConfiguration const &	getExecutableConfiguration () const =0
	Get the executable configuration.
virtual RuntimePriority	getPriority () const =0
	Get a priority.

Protected Member Functions
	ExecutableIfc () noexcept=default
	Default constructor.

Detailed Description

Interface of an executable which is called by the runtime once an event has to be processed.

Note

The executable has to be registered in RuntimeCore::create in order to receive events.

This interface can be used to keep ownership of an executable and delete it at the end of its lifetime. Executables shall not be copied or moved.

Definition at line 56 of file ExecutableIfc.h.

Constructor & Destructor Documentation

ExecutableIfc() [1/3]

imt::base::dff::runtime::ExecutableIfc::ExecutableIfc ( ExecutableIfc const &  )

delete

ExecutableIfc() [2/3]

imt::base::dff::runtime::ExecutableIfc::ExecutableIfc ( ExecutableIfc &&  )

delete

~ExecutableIfc()

virtual imt::base::dff::runtime::ExecutableIfc::~ExecutableIfc ( )

virtualdefault

Destructor.

ExecutableIfc() [3/3]

imt::base::dff::runtime::ExecutableIfc::ExecutableIfc ( )

protecteddefaultnoexcept

Default constructor.

Member Function Documentation

execute()

virtual void imt::base::dff::runtime::ExecutableIfc::execute ( uint16_t const  protocolID, ::imt::base::core::serialization::Deserializer &  buffer  )

pure virtual

One-Shot function which is called once a message is ready to be processed.

Behavior: Process the message (run to completion) and return to the runtime.

Example implementation:

switch (protocolID) {
    case ::imt::ProtocolIdentifier::TIMER: {
        RuntimeTimerEvent timerEventArgs(buffer);
        handleTimer(timerEventArgs);
        break;
    }
    case ::imt::ProtocolIdentifier::BUTTON_STATE: {
        ButtonStateProtocol message(buffer);
        handleButtonState(message);
        break;
    }
    default:
        // Ignore all other protocols
        ASSERT_DEBUG1(false, "Unknown protocol in ActivePart.");
        break;
}

Parameters

protocolID	Identifier of the protocol.
buffer	Deserializer for deserialization of the event data.

Implemented in imt::base::dff::activeparts::test::TestLoggerAP.

getExecutableConfiguration()

virtual ExecutableConfiguration const & imt::base::dff::runtime::ExecutableIfc::getExecutableConfiguration ( ) const

pure virtual

Get the executable configuration.

Returns

ExecutableConfiguration

Implemented in imt::base::dff::activeparts::ActivePartAbs.

getPriority()

virtual RuntimePriority imt::base::dff::runtime::ExecutableIfc::getPriority ( ) const

pure virtual

Get a priority.

Returns

RuntimePriority

Implemented in imt::base::dff::activeparts::ActivePartAbs.

operator=() [1/2]

ExecutableIfc & imt::base::dff::runtime::ExecutableIfc::operator= ( ExecutableIfc &&  ) &

delete

operator=() [2/2]

ExecutableIfc & imt::base::dff::runtime::ExecutableIfc::operator= ( ExecutableIfc const &  ) &

delete

---

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

• C:/src/imt/Imt.Base-cpp/Imt.Base/Imt.Base.Dff.Runtime/inc/Imt.Base.Dff.Runtime/ExecutableIfc.h