CORDET Framework - C2 Implementation
CrFwOutRegistryUserPar.h File Reference

User-modifiable parameters for the OutRegistry component (see CrFwOutRegistry.h). More...

Go to the source code of this file.

Macros

#define CR_FW_OUTREGISTRY_N   64
 The maximum number of out-going commands or reports which can be tracked by the OutRegistry. More...
 
#define CR_FW_OUTREGISTRY_NSERV   10
 The total number of service types/sub-types provided by the application. More...
 
#define CR_FW_OUTREGISTRY_INIT_SERV_DESC
 Definition of the range of out-going services supported by an application. More...
 

Detailed Description

User-modifiable parameters for the OutRegistry component (see CrFwOutRegistry.h).

This header file defines the set of services to be provided by the application. A service is defined in terms of the following characteristics:

  • The service type identifier
  • The service sub-type identifier
  • The range of discriminant values for that service type and sub-type
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 CrFwOutRegistryUserPar.h.

Macro Definition Documentation

◆ CR_FW_OUTREGISTRY_INIT_SERV_DESC

#define CR_FW_OUTREGISTRY_INIT_SERV_DESC
Value:
{ {1, 1, 0, 0, 0, 0, 0, 0}, \
{1, 2, 1, 10, 0, 0, 0, 0}, \
{1, 7, 0, 0, 0, 0, 0, 0}, \
{1, 8, 1, 10, 0, 0, 0, 0}, \
{5, 1, 1, 10, 0, 0, 0, 0}, \
{5, 2, 10, 20, 0, 0, 0, 0}, \
{5, 3, 20, 31, 0, 0, 0, 0}, \
{5, 4, 0, 40, 0, 0, 0, 0}, \
{25, 3, 0, 0,0, 0, 0, 0}, \
{50, 1, 0, 0, 0, 0, 0, 0}, \
}

Definition of the range of out-going services 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. Each line in this initializer describes one [service type, service sub-type] pair together with a range of discriminant. The elements in each line are as follows:

  • The service type s
  • The service sub-type b
  • The lower bound l of the range of discriminant values
  • The upper bound u of the range of discriminant values
  • Four values used internally by the software which must be set to zero

If a [type,sub-type] pair does not support a discriminant, then l and u must be set to zero.

The list of service descriptors must satisfy the following constraints:

  • The number of lines must be the same as CR_FW_OUTREGISTRY_NSERV.
  • The service types must be listed in increasing order.
  • The service sub-types within a service type must be listed in increasing order.
  • The set of service type and sub-types must be consistent with the service types and sub-types declared in the CR_FW_OUTCMP_INIT_KIND_DESC initializer.
  • The lower bound l of a range of discriminant values must be smaller than or equal to the upper bound u

Compliance with the last four constraints is checked by CrFwAuxOutRegistryConfigCheck.

Definition at line 78 of file CrFwOutRegistryUserPar.h.

◆ CR_FW_OUTREGISTRY_N

#define CR_FW_OUTREGISTRY_N   64

The maximum number of out-going commands or reports which can be tracked by the OutRegistry.

This constant must be smaller than the range of CrFwTrackingIndex_t.

Adaptation Point:
ORG-01: Maximum Number of Trackable Commands/Reports for OutRegistry

Definition at line 34 of file CrFwOutRegistryUserPar.h.

◆ CR_FW_OUTREGISTRY_NSERV

#define CR_FW_OUTREGISTRY_NSERV   10

The total number of service types/sub-types provided by the application.

An application provides a number of service types and, for each service type, it supports a number of sub-types. This constant defines the total number of [service type, service sub-type] pairs supported by the application. Its value must be consistent with the number of service type/sub-types defined in CR_FW_OUTCMP_INIT_KIND_DESC (consistency is verified by one of the configuration checks in CrFwAux.h).

This constant must be smaller than the range of: CrFwCmdRepIndex_t.

Definition at line 48 of file CrFwOutRegistryUserPar.h.

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