CORDET Framework - C2 Implementation
CrFwOutLoader.c File Reference

Implementation of OutLoader State Machine. More...

Go to the source code of this file.

Functions

FwSmDesc_t CrFwOutLoaderMake ()
 Factory function to retrieve the OutLoader State Machine instance. More...
 
CrFwBool_t CrFwOutLoaderLoad (FwSmDesc_t outCmp)
 Load an OutComponent into its OutManager. More...
 
FwSmDesc_t CrFwOutLoaderDefOutManagerSelect (FwSmDesc_t outCmp)
 Default implementation of the OutManager Selection Operation. More...
 
void CrFwOutLoadDefOutManagerActivate (FwSmDesc_t outManager)
 Default implementation of the OutManager Activation Operation. More...
 

Variables

static FwSmDesc_t outLoader = NULL
 Descriptor of the OutLoader Singleton.
 
static CrFwCmpData_t outLoaderData
 The data structure for the OutLoader Singleton.
 
static CrFwOutManagerSelect_t outManagerSelect = CR_FW_OUTLOADER_OUTMANAGER_SELECT
 The function implementing the OutManager Selection Operation.
 
static CrFwOutManagerActivate_t outManagerActivate = CR_FW_OUTLOADER_OUTMANAGER_ACTIVATE
 The function implementing the OutManager Activation Operation.
 
static FwPrAction_t initCheck = CR_FW_OUTLOADER_INITCHECK
 The function implementing the Initialization Check.
 
static FwPrAction_t initAction = CR_FW_OUTLOADER_INITACTION
 The function implementing the Initialization Action.
 
static FwPrAction_t configCheck = CR_FW_OUTLOADER_CONFIGCHECK
 The function implementing the Configuration Check.
 
static FwPrAction_t configAction = CR_FW_OUTLOADER_CONFIGACTION
 The function implementing the Configuration Action.
 
static FwSmAction_t shutdownAction = CR_FW_OUTLOADER_SHUTDOWNACTION
 The function implementing the Shutdown Action.
 

Detailed Description

Implementation of OutLoader State Machine.

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 CrFwOutLoader.c.

Function Documentation

void CrFwOutLoadDefOutManagerActivate ( FwSmDesc_t  outManager)

Default implementation of the OutManager Activation Operation.

This implementation returns without doing anything.

Parameters
outManagerthe descriptor of the OutManager to be activated (this argument is not used in this implementation)

Definition at line 139 of file CrFwOutLoader.c.

FwSmDesc_t CrFwOutLoaderDefOutManagerSelect ( FwSmDesc_t  outCmp)

Default implementation of the OutManager Selection Operation.

This implementation always returns the first OutManager (i.e. the OutManager returned by CrFwOutManagerMake when it is called with an argument equal to zero).

Parameters
outCmpthe descriptor of the OutComponent loaded into the OutLoader (this argument is not used in this implementation)
Returns
the first OutManager

Definition at line 133 of file CrFwOutLoader.c.

CrFwBool_t CrFwOutLoaderLoad ( FwSmDesc_t  outCmp)

Load an OutComponent into its OutManager.

This function runs the procedure shown in the figure below. The procedure has two adaptation points which are defined by specifying two functions in CrFwOutLoaderUserPar.h.

After execution of this function, the OutComponent must not be used by the caller because it has either been released (if the load operation in the OutManager was not successful) or will be released by the OutManager after it is executed.

OutLoaderLoad.png
Parameters
outCmpthe descriptor of the OutComponent to be loaded in the OutManager
Returns
1 if the OutComponent was successfully loaded in the OutManager; 0 otherwise

Definition at line 121 of file CrFwOutLoader.c.

FwSmDesc_t CrFwOutLoaderMake ( )

Factory function to retrieve the OutLoader State Machine instance.

The first time this function is called, it creates the OutLoader instance. Subsequent calls returns the same instance.

The first time this function is called, it returns the OutLoader State Machine which has been started but which still needs to be initialized and configured.

Returns
the descriptor of the OutLoader State Machine or NULL if the state machine could not be created.

Definition at line 75 of file CrFwOutLoader.c.

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