CORDET Framework - C2 Implementation
|
Auxiliary module to check the static part of an application's configuration. More...
Go to the source code of this file.
Enumerations | |
enum | CrFwConfigCheckOutcome_t { crConsistencyCheckSuccess = 1 , crOutRegistryConfigParInconsistent = 2 , crOutFactoryConfigParInconsistent = 3 , crInFactoryInCmdConfigParInconsistent = 4 , crInFactoryInRepConfigParInconsistent = 5 , crOutStreamConfigParInconsistent = 6 , crInStreamConfigParInconsistent = 7 , crInRegistryConfigParInconsistent = 8 , crInManagerConfigParInconsistent = 9 , crOutManagerConfigParInconsistent = 10 } |
Type for the outcome of the consistency check on the configuration parameters. More... | |
Functions | |
CrFwConfigCheckOutcome_t | CrFwAuxConfigCheck () |
Check the configuration of an application. More... | |
CrFwBool_t | CrFwAuxOutRegistryConfigCheck () |
Check the configuration of the OutRegistry component. More... | |
CrFwBool_t | CrFwAuxOutFactoryConfigCheck () |
Check the configuration of the OutFactory component. More... | |
CrFwBool_t | CrFwAuxOutStreamConfigCheck () |
Check the configuration of the OutStream component. More... | |
CrFwBool_t | CrFwAuxInStreamConfigCheck () |
Check the configuration of the InStream component. More... | |
CrFwBool_t | CrFwAuxInFactoryInCmdConfigCheck () |
Check the configuration of the InCommand part of the InFactory component. More... | |
CrFwBool_t | CrFwAuxInFactoryInRepConfigCheck () |
Check the configuration of the InReport part of the InFactory component. More... | |
CrFwBool_t | CrFwAuxInRegistryConfigCheck () |
Check the configuration of the InRegistry component. More... | |
CrFwBool_t | CrFwAuxInManagerConfigCheck () |
Check the configuration of the InManager component. More... | |
CrFwBool_t | CrFwAuxOutManagerConfigCheck () |
Check the configuration of the OutManager component. More... | |
Auxiliary module to check the static part of an application's configuration.
The configuration of an application instantiated from the CORDET Framework is, for the most part, defined statically in files with names like: CrFwXxxUserPar
where "Xxx" is the name of the framework component to which the configuration information applies. This module defines a set of functions which check the consistency of the configuration information in these configuration files. A function is defined for each configuration file and, additionally, function CrFwAuxConfigCheck
checks all the configuration files.
Mode of Use of the Aux Module
Applications would normally use the functions in this module during the application development phase to verify the correctness of the information in the configuration files. Once this correctness has been confirmed, the configuration checks can be omitted. It is therefore not expected that this module will be included in the final executable for an application.
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 CrFwAux.h.
Type for the outcome of the consistency check on the configuration parameters.
CrFwConfigCheckOutcome_t CrFwAuxConfigCheck | ( | ) |
Check the configuration of an application.
This function calls all the configuration check functions and verifies that they all return true (to signify: "no configuration error detected"). The function returns false as soon as it encounters a configuration check function which returns false.
CrFwConfigCheckOutcome_t
indicating which configuration check has failed. CrFwBool_t CrFwAuxInFactoryInCmdConfigCheck | ( | ) |
Check the configuration of the InCommand part of the InFactory component.
The following checks are performed on the configuration data in CrFwInFactoryUserPar.h
:
CR_FW_INCMD_INIT_KIND_DESC
)CR_FW_INCMD_INIT_KIND_DESC
)CR_FW_INCMD_INIT_KIND_DESC
)CR_FW_MAX_SERV_TYPE
, CR_FW_MAX_SERV_SUBTYPE
and CR_FW_MAX_DISCRIMINANT
.CrFwBool_t CrFwAuxInFactoryInRepConfigCheck | ( | ) |
Check the configuration of the InReport part of the InFactory component.
The following checks are performed on the configuration data in CrFwInFactoryUserPar.h
:
CR_FW_INREP_INIT_KIND_DESC
)CR_FW_INREP_INIT_KIND_DESC
)CR_FW_INREP_INIT_KIND_DESC
)CR_FW_MAX_SERV_TYPE
, CR_FW_MAX_SERV_SUBTYPE
and CR_FW_MAX_DISCRIMINANT
.CrFwBool_t CrFwAuxInManagerConfigCheck | ( | ) |
Check the configuration of the InManager component.
The following checks are performed on the configuration data in CrFwInManagerPar.h
:
CrFwBool_t CrFwAuxInRegistryConfigCheck | ( | ) |
Check the configuration of the InRegistry component.
The following checks are performed on the configuration data in CrFwInRegistryUserPar.h
:
CR_FW_INREGISTRY_N
is greater than zero.CrFwBool_t CrFwAuxInStreamConfigCheck | ( | ) |
Check the configuration of the InStream component.
The following checks are performed on the configuration data in CrFwInStreamUserPar.h
:
CrFwBool_t CrFwAuxOutFactoryConfigCheck | ( | ) |
Check the configuration of the OutFactory component.
The following checks are performed on the configuration data in CrFwOutFactoryUserPar.h
:
CR_FW_OUTCMP_INIT_KIND_DESC
)CR_FW_OUTCMP_INIT_KIND_DESC
)CR_FW_OUTCMP_INIT_KIND_DESC
)CR_FW_OUTCMP_INIT_KIND_DESC
initializer are consistent with service type, sub-types and discriminant values defined in the CR_FW_OUTREGISTRY_INIT_SERV_DESC
.CR_FW_OUTCMP_INIT_KIND_DESC
are greater than zero.CrFwBool_t CrFwAuxOutManagerConfigCheck | ( | ) |
Check the configuration of the OutManager component.
The following checks are performed on the configuration data in CrFwOutManagerPar.h
:
CrFwBool_t CrFwAuxOutRegistryConfigCheck | ( | ) |
Check the configuration of the OutRegistry component.
The following checks are performed on the configuration data in CrFwOutRegistryUserPar.h
:
CR_FW_OUTREGISTRY_INIT_SERV_DESC
)CR_FW_OUTREGISTRY_INIT_SERV_DESC
)CR_FW_OUTREGISTRY_INIT_SERV_DESC
initializer are consistent with service type, sub-types and discriminant values defined in the CR_FW_OUTCMP_INIT_KIND_DESC
.CR_FW_OUTREGISTRY_INIT_SERV_DESC
is smaller than or equal to the upper bound.CrFwBool_t CrFwAuxOutStreamConfigCheck | ( | ) |
Check the configuration of the OutStream component.
The following checks are performed on the configuration data in CrFwOutStreamUserPar.h
: