Dataflow Runtime API  3.1.1.0
Public Member Functions | Protected Member Functions | List of all members
imt::base::dff::activeparts::ActivePartContainerAbs Class Referenceabstract

A container groups several elements together (usually ActiveParts). More...

#include <Imt.Base.Dff.ActiveParts/ActivePartContainerAbs.h>

Public Member Functions

 ActivePartContainerAbs (void)
 Constructor. More...
 
virtual ~ActivePartContainerAbs (void)
 Destructor. More...
 
void initialize (void)
 Initialize the ActivePartContainer. More...
 
void start (void)
 Start the ActivePartContainer. More...
 
bool isInitialized (void) const
 Check if ActivePartContainer is initialized. More...
 
bool isStarted (void) const
 Check if ActivePartContainer is started. More...
 

Protected Member Functions

virtual void onInitialize (void)=0
 1st step = called by initialize() This is the place to initialize sub parts and connect internal channels. More...
 
virtual void onStart (void)=0
 2nd step = called by start(). More...
 

Detailed Description

A container groups several elements together (usually ActiveParts).

It is not an ActivePart itself, it only returns the PortIn / PortOut of the containing ActiveParts.

Constructor & Destructor Documentation

◆ ActivePartContainerAbs()

imt::base::dff::activeparts::ActivePartContainerAbs::ActivePartContainerAbs ( void  )

Constructor.

◆ ~ActivePartContainerAbs()

virtual imt::base::dff::activeparts::ActivePartContainerAbs::~ActivePartContainerAbs ( void  )
virtual

Destructor.

Member Function Documentation

◆ initialize()

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

Initialize the ActivePartContainer.

◆ isInitialized()

bool imt::base::dff::activeparts::ActivePartContainerAbs::isInitialized ( void  ) const

Check if ActivePartContainer is initialized.

Returns
True if is initialized.

◆ isStarted()

bool imt::base::dff::activeparts::ActivePartContainerAbs::isStarted ( void  ) const

Check if ActivePartContainer is started.

Returns
True if is started.

◆ onInitialize()

virtual void imt::base::dff::activeparts::ActivePartContainerAbs::onInitialize ( void  )
protectedpure virtual

1st step = called by initialize() This is the place to initialize sub parts and connect internal channels.

Example:

// Initialize included ActiveParts.
SubActivePart.initialize();
SubActivePartContainer.initialize();
SubActivePartIrq.initialize();
// Connect Ports.
Channel1.connectPorts(SubActivePart.PortOut, SubActivePartContainer.PortIn);
Channel2.connectPorts(SubActivePartIrq.PortOut, SubActivePart.PortIn);

◆ onStart()

virtual void imt::base::dff::activeparts::ActivePartContainerAbs::onStart ( void  )
protectedpure virtual

2nd step = called by start().

This is the place to start sub parts and send the initialization messages.

Example:

// Start included ActiveParts.
SubActivePart.start();
SubActivePartContainer.start();
SubActivePartIrq.start();

◆ start()

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

Start the ActivePartContainer.


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