FW Profile - C1 Implementation
FwPrConstants.h File Reference

Header file to define all constants and types for the procedure module of the FW Profile. More...

Go to the source code of this file.

Typedefs

typedef struct FwPrDescFwPrDesc_t
 Forward declaration for the pointer to a procedure descriptor. More...
 
typedef void(* FwPrAction_t) (FwPrDesc_t)
 Type for a pointer to a procedure action. More...
 
typedef int FwPrBool_t
 Type used for booleans (0 is "false" and 1 is "true"). More...
 
typedef FwPrBool_t(* FwPrGuard_t) (FwPrDesc_t)
 Type for a pointer to a procedure guard. More...
 
typedef unsigned char FwPrCounterU1_t
 Type used for unsigned counters with a "short" range. More...
 
typedef unsigned short int FwPrCounterU2_t
 Type used for unsigned counters with a "medium" range. More...
 
typedef unsigned int FwPrCounterU3_t
 Type used for unsigned counters with a "long" range. More...
 
typedef long unsigned int FwPrCounterU4_t
 Type used for unsigned counters with a "long int" range. More...
 
typedef signed char FwPrCounterS1_t
 Type used for signed counters with a "short" range. More...
 

Enumerations

Detailed Description

Header file to define all constants and types for the procedure module of the FW Profile.

This header file should be included by all applications which use the procedure module of the FW Profile.

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 FW Profile.

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 FwPrConstants.h.

Typedef Documentation

typedef void(* FwPrAction_t) (FwPrDesc_t)

Type for a pointer to a procedure action.

A procedure action is a function which encapsulates an action of a procedure node. A procedure action takes the descriptor of the procedure as an argument.

Pointers to procedure actions are used when a new procedure is defined: all the actions in the procedure must be defined as functions which conform to the FwPrAction_t prototype and are loaded into the procedure as function pointers.

Definition at line 45 of file FwPrConstants.h.

typedef int FwPrBool_t

Type used for booleans (0 is "false" and 1 is "true").

Definition at line 48 of file FwPrConstants.h.

typedef signed char FwPrCounterS1_t

Type used for signed counters with a "short" range.

Definition at line 78 of file FwPrConstants.h.

typedef unsigned char FwPrCounterU1_t

Type used for unsigned counters with a "short" range.

Definition at line 66 of file FwPrConstants.h.

typedef unsigned short int FwPrCounterU2_t

Type used for unsigned counters with a "medium" range.

Definition at line 69 of file FwPrConstants.h.

typedef unsigned int FwPrCounterU3_t

Type used for unsigned counters with a "long" range.

Definition at line 72 of file FwPrConstants.h.

typedef long unsigned int FwPrCounterU4_t

Type used for unsigned counters with a "long int" range.

Definition at line 75 of file FwPrConstants.h.

typedef struct FwPrDesc* FwPrDesc_t

Forward declaration for the pointer to a procedure descriptor.

A procedure descriptor is a data structure which holds all the information describing a procedure instance. Users only manipulate the pointer to the procedure descriptor. The internal definition of the procedure descriptor (see FwPrPrivate.h) is kept hidden from users.

Definition at line 32 of file FwPrConstants.h.

typedef FwPrBool_t(* FwPrGuard_t) (FwPrDesc_t)

Type for a pointer to a procedure guard.

A procedure guard is a function which encapsulates a transition guard in a procedure. The procedure guard takes the descriptor of the procedure as an argument and it returns 0 to signify that the guard is false or a non-zero value (typically 1) to signify that the guard is true.

Pointers to procedure guards are used when a new procedure is defined: all the guards in the procedure must be defined as functions which conform to the FwPrGuard_t prototype and are loaded into the procedure as function pointers.

Definition at line 63 of file FwPrConstants.h.

Enumeration Type Documentation

Error codes and function return codes for the procedure functions.

Enumerator
prSuccess 

Return codes of a function which has completed execution without errors.

prOutOfMemory 

A call to malloc has failed (it has returned a NULL pointer).

prWrongNOfActions 

The number of actions in the base procedure is not the same as in the derived procedure.

prWrongNOfGuards 

The number of guards in the base procedure is not the same as in the derived procedure.

prIllActNodeId 

An action node is added to a procedure with an illegal (out-of-range) identifier.

prActNodeIdInUse 

An action node is added twice to the same procedure.

prIllDecNodeId 

A decision node is added to a procedure with an illegal (out-of-range) identifier.

prDecNodeIdInUse 

A decision node is added twice to the same procedure.

prTooManyActions 

The number of actions added to the procedure exceeds the number of actions declared when the procedure descriptor was created.

prTooManyGuards 

The number of guards added to the procedure exceeds the number of guards declared when the procedure descriptor was created.

prNullAction 

An action node is defined with a null action.

prTooManyOutFlows 

A node is added to a procedure which has more out-going transitions than fit into the control flow array of the procedure descriptor.

prIllNOfOutFlows 

A choice pseudo-state is added to a procedure with less than 2 out-going control flows.

prTooManyFlows 

A control flow from a certain source is added to a procedure but there isn't space for it in the control flow array of the procedure descriptor.

prIllFlowSrc 

A control flow is added to a SM with a source which has an illegal value.

prConfigErr 

A configuration error has been detected during the procedure configuration process.

prNullActNode 

There is an undefined action node in a procedure.

prNullDecNode 

There is an undefined decision node in a procedure.

prNullFlow 

There is an undefined control flow in a procedure.

prUndefinedFlowSrc 

A control flow is added to a procedure with a source (either a state or a source choice pseudo-state) which has not yet been defined.

prIllegalADest 

A control flow is added to a procedure with an illegal (out-of-range) action node destination.

prIllegalDDest 

A control flow is added to a procedure with an illegal (out-of-range) decision node destination.

prTooFewActions 

The number of actions added to the procedure is smaller than the number of actions declared when the procedure descriptor was created.

prTooFewGuards 

The number of guards added to the procedure is smaller than the number of guards declared when the procedure descriptor was created.

prFlowErr 

An error was encountered while executing a transition in a procedure (see FwPrExecute).

prUndefAction 

The overridden action in a derived procedure does not exist.

prUndefGuard 

The overridden guard in a derived procedure does not exist.

prNotDerivedPr 

The procedure where an action or a guard is overridden or a procedure is embedded is not a derived procedure.

prUnreachableANode 

The procedure has an action node which is not a destination of any control flow.

prUnreachableDNode 

The procedure has a decision node which is not a destination of any control flow.

Definition at line 81 of file FwPrConstants.h.

P&P Software GmbH, Copyright 2011, All Rights Reserved