CORDET Framework - C2 Implementation
cordetfw/tests/config/CrFwOutFactoryUserPar.h File Reference

User-modifiable parameters for the OutFactory component (see CrFwOutFactory.h). More...

Go to the source code of this file.

Macros

#define CR_FW_OUTFACTORY_MAX_NOF_OUTCMP   10
 The maximum number of OutComponents which may be allocated at any one time. More...
 
#define CR_FW_OUTCMP_NKINDS   18
 The total number of kinds of OutComponents supported by the application. More...
 
#define CR_FW_OUTCMP_INIT_KIND_DESC
 Definition of the OutComponent kinds supported by an application. More...
 

Detailed Description

User-modifiable parameters for the OutFactory component (see CrFwOutFactory.h).

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/tests/config/CrFwOutFactoryUserPar.h.

Macro Definition Documentation

#define CR_FW_OUTCMP_INIT_KIND_DESC

Definition of the OutComponent 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 OutComponent kind is defined by the triplet: [service type, service sub-type, discriminant].

Each line in this initializer describes one OutComponent kind. If the discriminant field is different from zero, then the line describes the characteristics of the reports/commands of that specific kind (as identified by the triplet [service type, service sub-type, discriminant]). If, instead, the discriminant is equal to zero, then the line describes the default characteristics of all reports/commands of the given type and sub-type.

Thus, for instance, line 13 in the example below describes the default characteristics of reports of type 5 and sub-type 4. According to the description at this line, reports of this type/sub-type have a length of 50 bytes. The following three lines describes reports of the same type/sub-type but with discriminants equal to, respectively, 3, 5 and 7. These reports have characteristics which deviate from the default for defined at line 13 (for example, their length is, respectively, 100, 99 and 98 bytes instead of the default value of 50 defined at line 13).

The elements in each line are as follows:

  • The service type.
  • The service sub-type.
  • The discriminant value.
  • The command/report flag. A value of 1 indicates that the OutComponent is a command and a value of 2 indicates that it is a report,
  • The default length (in number of bytes) of the packet (see CrFwPckt.h) to which this kind of OutComponent is serialized.
  • The function implementing the Enable Check Operation for this kind of component (this must be a function pointer of type CrFwOutCmpEnableCheck_t; function CrFwOutCmpDefEnableCheck can be used as default).
  • The function implementing the Ready Check Operation for this kind of component (this must be a function pointer of type CrFwOutCmpReadyCheck_t; function CrFwSmCheckAlwaysTrue can be used as default).
  • The function implementing the Repeat Check Operation for this kind of component (this must be a function pointer of type CrFwOutCmpRepeatCheck_t; function CrFwSmCheckAlwaysFalse can be used as default).
  • The function implementing the Update Operation for this kind of component (this must be a function pointer of type CrFwOutCmpUpdate_t; function CrFwSmEmptyAction can be used as default).
  • The function implementing the Serialize Operation for this kind of component (this must be a function pointer of type CrFwOutCmpSerialize_t; function CrFwOutCmpDefSerialize can be used as default).

The list of service descriptors must satisfy the following constraints:

  • The number of lines must be the same as CR_FW_OUTCMP_NKINDS.
  • The set of service types and sub-types and their discriminants must be consistent with the definition of CR_FW_OUTREGISTRY_INIT_SERV_DESC.
  • 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 packet length must be greater than zero.
  • The packet length must be sufficiently large to ensure that all packet attributes can be stored in the packet.

Constraints 2 to 6 are checked by the auxiliary function CrFwAuxOutFactoryConfigCheck.

The initializer values defined below are which are used for the framework Test Suite. The function pointers in the last row are those of the Sample OutComponent defined in CrFwOutCmpSample1.h.

Definition at line 108 of file cordetfw/tests/config/CrFwOutFactoryUserPar.h.

#define CR_FW_OUTCMP_NKINDS   18

The total number of kinds of OutComponents supported by the application.

An OutComponent 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_OUTCMP_INIT_KIND_DESC and it must be smaller than the range of the CrFwCmdRepKindIndex_t type.

This constant is used as the size of a statically declared array. Hence, a value of zero may not be allowed by some compilers.

Definition at line 42 of file cordetfw/tests/config/CrFwOutFactoryUserPar.h.

#define CR_FW_OUTFACTORY_MAX_NOF_OUTCMP   10

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

This constant must be smaller than the range of CrFwOutFactoryPoolIndex_t.

Definition at line 29 of file cordetfw/tests/config/CrFwOutFactoryUserPar.h.

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