CORDET Framework - C2 Implementation
CrFwResetProc.c File Reference

Implementation of Component Reset Procedure. More...

Go to the source code of this file.

Functions

void CrFwBaseCmpDefConfigCheck (FwPrDesc_t prDesc)
 Function which performs the default Configuration Check of the CRP. More...
 
void CrFwBaseCmpDefConfigAction (FwPrDesc_t prDesc)
 Function which performs the default Configuration Action of the CRP. More...
 
FwPrDesc_t CrFwCmpGetResetProc ()
 Retrieve the singleton instance of the CRP. More...
 

Variables

static FwPrDesc_t resetPrDesc = NULL
 The singleton instance of the CRP. More...
 

Detailed Description

Implementation of Component Reset Procedure.

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

Function Documentation

void CrFwBaseCmpDefConfigAction ( FwPrDesc_t  prDesc)

Function which performs the default Configuration Action of the CRP.

This function implements one of the actions of the CRP. In general, the Configuration Action for a component initializes all data structures required by the component and performs other configuration actions as required. The configuration action has an outcome: it can either succeed or it can fail.

This function assumes the procedure data to be of type CrFwCmpData_t. It uses the outcome field of this data structure to store the outcome of the configuration action (a value of "true" means that the configuration action was successful).

This function implements the Configuration Action for the Base Component which does nothing and always returns an outcome of "action successful" (i.e. always sets the outcome check to TRUE).

This action is an adaptation point of the framework. Components which extend the Base Component (and which therefore must also extend the CRP) may want to override this function to implement their own configuration behaviour).

Parameters
prDescthe CRP descriptor

Definition at line 39 of file CrFwResetProc.c.

void CrFwBaseCmpDefConfigCheck ( FwPrDesc_t  prDesc)

Function which performs the default Configuration Check of the CRP.

This function implements one of the actions of the CRP. In general, the Configuration Check for a component checks that all parameters required for the component configuration have legal values.

This function assumes the procedure data to be of type CrFwCmpData_t. It uses the outcome field of this data structure to store the outcome of the configuration check.

This function implements the Configuration Check for the Base Component which always returns an outcome of "check successful" (i.e. always sets the outcome check to TRUE).

This action is an adaptation point for the framework. Components which extend the Base Component (and which therefore must also extend the CRP) may want to override this function to implement their own configuration behaviour).

Parameters
prDescthe CIP descriptor

Definition at line 33 of file CrFwResetProc.c.

FwPrDesc_t CrFwCmpGetResetProc ( )

Retrieve the singleton instance of the CRP.

This function returns the descriptor of the CRP. Note that no data are attached to the descriptor as it is returned by this function. The CRP descriptor returned by this function is therefore not ready to be executed. It can only be executed after the procedure data have been loaded into it.

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

Definition at line 45 of file CrFwResetProc.c.

Variable Documentation

FwPrDesc_t resetPrDesc = NULL
static

The singleton instance of the CRP.

Definition at line 30 of file CrFwResetProc.c.

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