CORDET Framework - C2 Implementation
CrFwDummyExecProc.h File Reference

Dummy Component Execution Procedure (CEP) for the Base Component. More...

Go to the source code of this file.

Functions

FwPrDesc_t CrFwBaseCmpGetDummyExecProc ()
 Retrieve the singleton instance of the Dummy CEP. More...
 
void CwFwBaseCmpDummyExecAction (FwPrDesc_t prDesc)
 Dummy action executed in the single node of the Dummy Execution Procedure. More...
 

Detailed Description

Dummy Component Execution Procedure (CEP) for the Base Component.

The CEP is one of the procedures which implement the behaviour of the Base Component (see CrFwBaseCmp.h). This procedure is an adaptation point in the Base Component. The implementation provided in this file is the default defined at the level of the Base Component. Components which extend the Base Component may override it and define their own implementation.

The CORDET Framework does not define a generic CEP. This implementation therefore defines a dummy CEP which can be used by components which do not need a CEP. This dummy CEP (see figure below) has one single action node which executes a dummy action every time the procedure is executed. The dummy action can be overridden.

The Dummy CEP (like the Base Component) is a singleton. This header file gives access to the singleton instance of the Dummy CEP.

Author
Vaclav Cechticky vacla.nosp@m.v.ce.nosp@m.chtic.nosp@m.ky@p.nosp@m.np-so.nosp@m.ftwa.nosp@m.re.co.nosp@m.m
Alessandro Pasetti paset.nosp@m.ti@p.nosp@m.np-so.nosp@m.ftwa.nosp@m.re.co.nosp@m.m

This file is part of the CORDET Framework.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

For information on alternative licensing, please contact P&P Software GmbH.

Definition in file CrFwDummyExecProc.h.

Function Documentation

◆ CrFwBaseCmpGetDummyExecProc()

FwPrDesc_t CrFwBaseCmpGetDummyExecProc ( )

Retrieve the singleton instance of the Dummy CEP.

This function returns the descriptor of the Dummy CEP. Note that no data are attached to the descriptor as it is returned by this function.

Returns
the descriptor of the CEP or NULL if the procedure could not be created.

Definition at line 39 of file CrFwDummyExecProc.c.

◆ CwFwBaseCmpDummyExecAction()

void CwFwBaseCmpDummyExecAction ( FwPrDesc_t  prDesc)

Dummy action executed in the single node of the Dummy Execution Procedure.

This dummy action returns without doing anything.

Parameters
prDescthe procedure descriptor

Definition at line 33 of file CrFwDummyExecProc.c.

P&P Software GmbH, Copyright 2012-2013, All Rights Reserved