Abstract base class for an ActivePart. More...

#include <Imt.Base.Dff.ActiveParts/inc/Imt.Base.Dff.ActiveParts/ActivePartAbs.h>

Inheritance diagram for imt::base::dff::activeparts::ActivePartAbs:

Public Member Functions
	ActivePartAbs (::imt::base::dff::runtime::RuntimePriority const priority, ::imt::base::dff::runtime::ExecutableConfiguration const configuration=::imt::base::dff::runtime::ExecutableConfiguration())
	Constructor.

::imt::base::dff::runtime::ExecutableConfiguration const &	getExecutableConfiguration () const final

::imt::base::dff::runtime::RuntimePriority	getPriority () const final

void	initialize ()
	Initialize the active part.

void	start ()
	Start the active part.

bool	isInitialized () const
	Check if active part is initialized.

bool	isStarted () const
	Check if active part is started.

::imt::base::dff::runtime::RuntimeTimer::TimerHandle	startOneShotTimer (::imt::base::dff::runtime::RuntimeTimer::TimerHandle timerToStart, uint32_t const timerTicksMs) const final
	Starts or restarts the given one shot timer for this active part.

::imt::base::dff::runtime::RuntimeTimer::TimerHandle	startPeriodicTimer (::imt::base::dff::runtime::RuntimeTimer::TimerHandle timerToStart, uint32_t const intervalMs) const final
	Start a periodic timer for this active part.

::imt::base::dff::runtime::RuntimeTimer::TimerHandle	killTimer (::imt::base::dff::runtime::RuntimeTimer::TimerHandle timerToKill) const final
	Kill the given timer (if required).

Public Member Functions inherited from imt::base::dff::runtime::ExecutableIfc
	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.

Public Member Functions inherited from imt::base::dff::runtime::TimerServiceIfc
virtual RuntimeTimer::TimerHandle	startOneShotTimer (RuntimeTimer::TimerHandle timerToStart, uint32_t const timerTicksMs) const =0
	Starts or restarts the given one shot timer for this ActivePart.

virtual RuntimeTimer::TimerHandle	startPeriodicTimer (RuntimeTimer::TimerHandle timerToStart, uint32_t const intervalMs) const =0
	Start a periodic timer for this ActivePart.

virtual RuntimeTimer::TimerHandle	killTimer (RuntimeTimer::TimerHandle timerToKill) const =0
	Kill an existing timer.

Public Attributes
PortInput const &	PortIn
	Input Port of the active part (as a public visible read-only reference).

Protected Member Functions
virtual void	onInitialize ()=0
	1st step = called by initialize().

virtual void	onStart ()=0
	2nd step = called by start().

Protected Member Functions inherited from imt::base::dff::runtime::ExecutableIfc
	ExecutableIfc () noexcept=default
	Default constructor.

Protected Member Functions inherited from imt::base::dff::runtime::TimerServiceIfc
	TimerServiceIfc () noexcept=default

	TimerServiceIfc (TimerServiceIfc const &) noexcept=delete

	TimerServiceIfc (TimerServiceIfc &&) noexcept=delete

	~TimerServiceIfc () noexcept=default

TimerServiceIfc &	operator= (TimerServiceIfc const &) &noexcept=delete

TimerServiceIfc &	operator= (TimerServiceIfc &&) &noexcept=delete

Detailed Description

Abstract base class for an ActivePart.

ActiveParts are objects which encapsulate their private state, behavior and data. They communicate to each other solely by exchanging messages.

Definition at line 60 of file ActivePartAbs.h.

Constructor & Destructor Documentation

◆ ActivePartAbs()

imt::base::dff::activeparts::ActivePartAbs::ActivePartAbs	(	::imt::base::dff::runtime::RuntimePriority const	priority,
		::imt::base::dff::runtime::ExecutableConfiguration const	configuration = `::imt::base::dff::runtime::ExecutableConfiguration()`
	)

explicit

Constructor.

Parameters

priority	Priority of the active part.
configuration	Executable configuration

Member Function Documentation

◆ getExecutableConfiguration()

::imt::base::dff::runtime::ExecutableConfiguration const & imt::base::dff::activeparts::ActivePartAbs::getExecutableConfiguration ( ) const

finalvirtual

See also: ExecutableIfc

Implements imt::base::dff::runtime::ExecutableIfc.

◆ getPriority()

::imt::base::dff::runtime::RuntimePriority imt::base::dff::activeparts::ActivePartAbs::getPriority ( ) const

finalvirtual

See also: ExecutableIfc

Implements imt::base::dff::runtime::ExecutableIfc.

◆ initialize()

void imt::base::dff::activeparts::ActivePartAbs::initialize ( )

Initialize the active part.

Register in runtime and create internal connections.

◆ isInitialized()

bool imt::base::dff::activeparts::ActivePartAbs::isInitialized ( ) const

Check if active part is initialized.

Returns: True if active part is initialized.

◆ isStarted()

bool imt::base::dff::activeparts::ActivePartAbs::isStarted ( ) const

Check if active part is started.

Returns: True if acrive part is started.

◆ killTimer()

::imt::base::dff::runtime::RuntimeTimer::TimerHandle imt::base::dff::activeparts::ActivePartAbs::killTimer ( ::imt::base::dff::runtime::RuntimeTimer::TimerHandle timerToKill ) const

final

Kill the given timer (if required).

Parameters

timerToKill Handle of the timer to be killed.

Returns: Updated timer handle.

◆ onInitialize()

virtual void imt::base::dff::activeparts::ActivePartAbs::onInitialize ( )

protectedpure virtual

1st step = called by initialize().

Initialize the active part and if necessary the hardware peripherals. No messages should be sent at this stage, use onStart() function!

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

◆ onStart()

virtual void imt::base::dff::activeparts::ActivePartAbs::onStart ( )

protectedpure virtual

2nd step = called by start().

Starts the active part and send all initialization messages.

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

◆ start()

void imt::base::dff::activeparts::ActivePartAbs::start ( )

Start the active part.

Here is the correct place to send the initialization messages.

◆ startOneShotTimer()

::imt::base::dff::runtime::RuntimeTimer::TimerHandle imt::base::dff::activeparts::ActivePartAbs::startOneShotTimer	(	::imt::base::dff::runtime::RuntimeTimer::TimerHandle	timerToStart,
		uint32_t const	timerTicksMs
	)		const

final

Starts or restarts the given one shot timer for this active part.

In case of invalid parameters, timerToStart is set to an invalid time handle.

Parameters

timerToStart	Timer to be started.
timerTicksMs	Timer delay in milliseconds.

Returns: Updated timer handle.

◆ startPeriodicTimer()

::imt::base::dff::runtime::RuntimeTimer::TimerHandle imt::base::dff::activeparts::ActivePartAbs::startPeriodicTimer	(	::imt::base::dff::runtime::RuntimeTimer::TimerHandle	timerToStart,
		uint32_t const	intervalMs
	)		const

final

Start a periodic timer for this active part.

In case of invalid parameters, an invalid time handle is returned.

Parameters

timerToStart	Timer to be started.
intervalMs	Timer period in milliseconds.

Returns: Updated timer handle.

Member Data Documentation

◆ PortIn

PortInput const& imt::base::dff::activeparts::ActivePartAbs::PortIn

Input Port of the active part (as a public visible read-only reference).

Note: It is placed at the end because the instance has to be initialized before the reference

Definition at line 177 of file ActivePartAbs.h.

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

C:/src/imt/Imt.Base-cpp/Imt.Base/Imt.Base.Dff.ActiveParts/inc/Imt.Base.Dff.ActiveParts/ActivePartAbs.h

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ActivePartAbs()

Member Function Documentation

◆ getExecutableConfiguration()

◆ getPriority()

◆ initialize()

◆ isInitialized()

◆ isStarted()

◆ killTimer()

◆ onInitialize()

◆ onStart()

◆ start()

◆ startOneShotTimer()

◆ startPeriodicTimer()

Member Data Documentation

◆ PortIn