CORDET Framework - C2 Implementation
cordetfw-examples/src/CrConfigDemoMaster/CrFwInFactoryUserPar.h File Reference

User-modifiable parameters for the InFactory component (see CrFwInFactory.h) of the Master Application of the CORDET Demo. More...

Go to the source code of this file.

Macros

#define CR_FW_INFACTORY_MAX_NOF_INCMD   5
 The maximum number of components representing an incoming command which may be allocated at any one time. More...
 
#define CR_FW_INFACTORY_MAX_NOF_INREP   5
 The maximum number of InReports which may be allocated at any one time. More...
 
#define CR_FW_INCMD_NKINDS   1
 The total number of kinds of incoming commands supported by the application. More...
 
#define CR_FW_INREP_NKINDS   1
 The total number of kinds of incoming reports supported by the application. More...
 
#define CR_FW_INCMD_INIT_KIND_DESC
 Definition of the incoming command kinds supported by the application. More...
 
#define CR_FW_INREP_INIT_KIND_DESC
 Definition of the incoming report kinds supported by an application. More...
 

Detailed Description

User-modifiable parameters for the InFactory component (see CrFwInFactory.h) of the Master Application of the CORDET Demo.

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 cordetfw-examples/src/CrConfigDemoMaster/CrFwInFactoryUserPar.h.

Macro Definition Documentation

#define CR_FW_INCMD_INIT_KIND_DESC
Value:
&CrFwSmEmptyAction, &CrFwSmEmptyAction, &CrFwSmEmptyAction}, \
}
void CrFwSmEmptyAction(FwSmDesc_t smDesc)
Convenience function to be used in a state machine as default implementation for an action which retu...
CrFwBool_t CrFwPrCheckAlwaysTrue(FwPrDesc_t prDesc)
Convenience function to be used in a procedure as default implementation for a check which always ret...
CrFwBool_t CrFwSmCheckAlwaysTrue(FwSmDesc_t smDesc)
Convenience function to be used in a state machine as default implementation for a check which always...

Definition of the incoming command kinds supported by the application.

An application supports a number of service types and, for each service type, it supports a number of sub-types. Each sub-type may support a range of discriminant values. An incoming command kind is defined by the triplet: [service type, service sub-type, discriminant].

Each line in this initializer describes one incoming command kind. The elements in each line are as follows:

  • The service type.
  • The service sub-type.
  • The discriminant value. A value of zero indicates either that no discriminant is associated to commands/reports of that type and sub-type or else that all commands/reports of this type and sub-type have the same characteristics.
  • The function implementing the Validity Check Operation for this kind of incoming command (this must be a function pointer of type CrFwInCmdValidityCheck_t; function CrFwPrCheckAlwaysTrue can be used as a default).
  • The function implementing the Ready Check Operation for this kind of incoming command (this must be a function pointer of type CrFwInCmdReadyCheck_t; function CrFwSmCheckAlwaysTrue can be used as a default).
  • The function implementing the Start Action Operation for this kind of incoming command (this must be a function pointer of type CrFwInCmdStartAction_t; function CrFwSmEmptyAction can be used as a default).
  • The function implementing the Progress Action Operation for this kind of incoming command (this must be a function pointer of type CrFwInCmdProgressAction_t; function CrFwSmEmptyAction can be used as a default).
  • The function implementing the Termination Action Operation for this kind of incoming command (this must be a function pointer of type CrFwInCmdTerminationAction_t; function CrFwSmEmptyAction can be used as a default).
  • The function implementing the Abort Action Operation for this kind of incoming command (this must be a function pointer of type CrFwInCmdAbortAction_t; function CrFwSmEmptyAction can be used as a default).

The list of service descriptors must satisfy the following constraints:

  • The number of lines must be the same as CR_FW_INCMD_NKINDS.
  • The values of the service types, sub-types and discriminant must be lower than CR_FW_MAX_SERV_TYPE, CR_FW_MAX_SERV_SUBTYPE and CR_FW_MAX_DISCRIMINANT.
  • The service types must be listed in increasing order.
  • The service sub-types within a service type must be listed in increasing order.
  • The discriminant values within a service type/sub-type must be listed in increasing order.

The last four constraints are checked by the auxiliary function CrFwAuxInFactoryInCmdConfigCheck.

The initializer values defined below are those which are used for the Master Application. The Master Application does not receive any commands but a dummy command is defined all the same to avoid use of zero-sized array.

Definition at line 116 of file cordetfw-examples/src/CrConfigDemoMaster/CrFwInFactoryUserPar.h.

#define CR_FW_INCMD_NKINDS   1

The total number of kinds of incoming commands supported by the application.

An incoming command kind is defined by the triplet: [service type, service sub-type, discriminant value]. The value of this constant must be the same as the number of rows of the initializer CR_FW_INCMD_INIT_KIND_DESC and it must be smaller than the range of the CrFwCmdRepKindIndex_t type.

The Master Application does not receive any InCommands and hence this constant should be equal to zero. However, this constant is used as a the size of an array. Zero sized arrays are not allowed in all versions of C. Hence, in order to ensure compatibility with a wide range of C compilers, a value of 1 is used for this constant.

Definition at line 54 of file cordetfw-examples/src/CrConfigDemoMaster/CrFwInFactoryUserPar.h.

#define CR_FW_INFACTORY_MAX_NOF_INCMD   5

The maximum number of components representing an incoming command which may be allocated at any one time.

This constant must be a positive integer smaller than the range of CrFwInFactoryPoolIndex_t.

Definition at line 31 of file cordetfw-examples/src/CrConfigDemoMaster/CrFwInFactoryUserPar.h.

#define CR_FW_INFACTORY_MAX_NOF_INREP   5

The maximum number of InReports which may be allocated at any one time.

This constant must be smaller than the range of CrFwInFactoryPoolIndex_t.

Definition at line 37 of file cordetfw-examples/src/CrConfigDemoMaster/CrFwInFactoryUserPar.h.

#define CR_FW_INREP_INIT_KIND_DESC
Value:
}
CrFwBool_t CrMaInRepTempViolationValidityCheck(FwPrDesc_t prDesc)
Implementation of the Validity Check Operation for the Master Application.
void CrMaInRepTempViolationUpdateAction(FwPrDesc_t prDesc)
Implementation of the Update Action Operation for the Master Application.

Definition of the incoming report kinds supported by an application.

An application supports a number of service types and, for each service type, it supports a number of sub-types. Each sub-type may support a range of discriminant values. An incoming report kind is defined by the triplet: [service type, service sub-type, discriminant].

Each line in this initializer describes one incoming report kind. The elements in each line are as follows:

  • The service type.
  • The service sub-type.
  • The discriminant value. A value of zero indicates either that no discriminant is associated to commands/reports of that type and sub-type or else that all commands/reports of this type and sub-type have the same characteristics.
  • The function implementing the Update Action Operation for this kind of incoming report (this must be a function pointer of type CrFwInRepUpdateAction_t; function CrFwPrEmptyAction can be used as a default).
  • The function implementing the Validity Check Operation for this kind of incoming report (this must be a function pointer of type CrFwInRepValidityCheck_t; function CrFwPrCheckAlwaysTrue can be used as a default).

The list of service descriptors must satisfy the following constraints:

  • The number of lines must be the same as CR_FW_INREP_NKINDS.
  • The values of the service types, sub-types and discriminant must be lower than CR_FW_MAX_SERV_TYPE, CR_FW_MAX_SERV_SUBTYPE and CR_FW_MAX_DISCRIMINANT. maximum values defined in CrFwUserConstants.h (TBC).
  • The service types must be listed in increasing order.
  • The service sub-types within a service type must be listed in increasing order.
  • The discriminant values within a service type/sub-type must be listed in increasing order.

The last four constraints are checked by the auxiliary function CrFwAuxInFactoryInRepConfigCheck.

The initializer values defined below are those which are used for the Master Application. The function pointers are defined in CrMaInRepTempViolation.h.

Definition at line 159 of file cordetfw-examples/src/CrConfigDemoMaster/CrFwInFactoryUserPar.h.

#define CR_FW_INREP_NKINDS   1

The total number of kinds of incoming reports supported by the application.

An incoming report kind is defined by the triplet: [service type, service sub-type, discriminant value]. The value of this constant must be the same as the number of rows of the initializer CR_FW_INREP_INIT_KIND_DESC and it must be smaller than the range of the CrFwCmdRepKindIndex_t type.

Definition at line 64 of file cordetfw-examples/src/CrConfigDemoMaster/CrFwInFactoryUserPar.h.

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