FW Profile - C1 Implementation
FwPrPrivate.h File Reference

Declaration of the internal data structures of the FW Procedure Module. More...

Go to the source code of this file.

Data Structures

struct  PrANode_t
 Structure representing an action node in a procedure. More...
 
struct  PrDNode_t
 Structure representing a decision node in a procedure. More...
 
struct  PrFlow_t
 Structure representing a control flow. More...
 
struct  PrBaseDesc_t
 Structure representing the base descriptor of a procedure. More...
 
struct  FwPrDesc
 Structure representing a procedure descriptor. More...
 

Enumerations

Functions

FwPrBool_t PrDummyGuard (FwPrDesc_t prDesc)
 Dummy guard which always returns true. More...
 

Detailed Description

Declaration of the internal data structures of the FW Procedure Module.

Users should not normally be concerned with these data structures.

The data structures declared in this header file are used to define the procedure descriptor. A procedure descriptor holds all the information related to a certain procedure. A procedure descriptor consists of two parts: the base descriptor and the extension descriptor.

The base descriptor holds the information which is not changed when the procedure is extended. This consists of:

  • The list of action nodes in the procedure
  • The list of decision nodes in the procedure
  • The list of control flows in the procedure

The extension descriptor holds the information which may be overridden when the procedure is extended. This consists of:

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

Enumeration Type Documentation

enum NodeType_t

Enumerated type for the type of a node in a procedure.

Enumerator
actionNode 

An action state in a procedure.

decisionNode 

A decision node in a procedure.

stoppedNode 

Either the initial or the final node.

Definition at line 53 of file FwPrPrivate.h.

Function Documentation

FwPrBool_t PrDummyGuard ( FwPrDesc_t  prDesc)

Dummy guard which always returns true.

This guard is used where no control flow guard is specified.

Parameters
prDescprocedure descriptor. This parameter is unused in this dummy guard. The parameter is retained for compatibility with the FwPrGuard_t type.
Returns
always return 1 (to signify that the guard is true).

Definition at line 23 of file FwPrCore.c.

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