CORDET Framework - C2 Implementation
CrPsDp.c File Reference

Interface for accessing data pool items. More...

Go to the source code of this file.

Data Structures

struct  _DpMetaInfoEntry_t
 Structure to hold the location and size information of a datapool entry. More...
 

Typedefs

typedef struct _DpMetaInfoEntry_t DpMetaInfoEntry_t
 Structure to hold the location and size information of a datapool entry.
 

Functions

static DpMetaInfoEntry_tgetMetaInfoParam (ParameterId_t id)
 Get the meta information of a datapool parameter by identifier. More...
 
static DpMetaInfoEntry_tgetMetaInfoVar (ParameterId_t id)
 Get the meta information of a datapool variable by identifier. More...
 
static DpMetaInfoEntry_tgetMetaInfo (ParameterId_t id)
 Get the meta information of a datapool item by identifier. More...
 
size_t getDpValue (ParameterId_t id, void *dest)
 Get the value of a datapool item by identifier. More...
 
size_t getDpValueEx (ParameterId_t id, void *dest, size_t *pElementLength, unsigned int *pNElements)
 Get the value of a datapool item plus meta information by identifier. More...
 
int setDpValue (ParameterId_t id, const void *src)
 Set the value of a datapool item by identifier. More...
 
size_t getDpSize (ParameterId_t id)
 Get the size of a datapool item by identifier. More...
 
size_t getDpParamSize (ParameterId_t id)
 Get the size of a datapool parameter by identifier. More...
 
size_t getDpVarSize (ParameterId_t id)
 Get the size of a datapool variable by identifier. More...
 

Variables

static DpMetaInfoEntry_t dpMetaInfoParams []
 Array of _DpMetaInfoEntry_t to hold the meta information of all datapool entries of the type parameter. More...
 
static DpMetaInfoEntry_t dpMetaInfoVars []
 Array of _DpMetaInfoEntry_t to hold the meta information of all datapool entries of the type variable.
 

Detailed Description

Interface for accessing data pool items.

Note
This file was generated on 2017-10-13 12:48:17
Author
PnP Generator
Christian Reimers chris.nosp@m.tian.nosp@m..reim.nosp@m.ers@.nosp@m.univi.nosp@m.e.ac.nosp@m..at
Markus Rockenbauer marku.nosp@m.s.ro.nosp@m.ckenb.nosp@m.auer.nosp@m.@univ.nosp@m.ie.a.nosp@m.c.at

last modification: 22.01.2018

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/.

Definition in file CrPsDp.c.

Function Documentation

size_t getDpParamSize ( ParameterId_t  id)

Get the size of a datapool parameter by identifier.

Parameters
idThe datapool parameter identifier
Returns
The size of the datapool parameter. 0 if id is invalid.

Definition at line 266 of file CrPsDp.c.

size_t getDpSize ( ParameterId_t  id)

Get the size of a datapool item by identifier.

Parameters
idThe datapool item identifier
Returns
The size of the datapool parameter. 0 if id is invalid.

Definition at line 250 of file CrPsDp.c.

size_t getDpValue ( ParameterId_t  id,
void *  dest 
)

Get the value of a datapool item by identifier.

Parameters
idThe datapool item identifier
destThe address of the target variable where the value gets copied to.
Returns
Number of bytes copied. 0 if id is invalid.

Definition at line 191 of file CrPsDp.c.

size_t getDpValueEx ( ParameterId_t  id,
void *  dest,
size_t *  pElementLength,
unsigned int *  pNElements 
)

Get the value of a datapool item plus meta information by identifier.

Parameters
idThe datapool item identifier
destThe address of the target variable where the value gets copied to.
pElementLengthPointer to where the element size is copied to.
pNElementsPointer to where the number of elements is copied to.
Returns
Number of bytes copied. 0 if id is invalid.

Definition at line 212 of file CrPsDp.c.

size_t getDpVarSize ( ParameterId_t  id)

Get the size of a datapool variable by identifier.

Parameters
idThe datapool variable identifier
Returns
The size of the datapool variable. 0 if id is invalid.

Definition at line 282 of file CrPsDp.c.

static DpMetaInfoEntry_t* getMetaInfo ( ParameterId_t  id)
static

Get the meta information of a datapool item by identifier.

Which contains the starting address, the length, the multiplicity and the length of a single datapool entry.

Parameters
idThe datapool item identifier
Returns
Meta information in the form of the struct DpMetaInfoEntry_t

Definition at line 173 of file CrPsDp.c.

static DpMetaInfoEntry_t* getMetaInfoParam ( ParameterId_t  id)
static

Get the meta information of a datapool parameter by identifier.

Which contains the starting address, the length, the multiplicity and the length of a single datapool entry.

Parameters
idThe datapool item identifier
Returns
Meta information in the form of the struct DpMetaInfoEntry_t

Definition at line 139 of file CrPsDp.c.

static DpMetaInfoEntry_t* getMetaInfoVar ( ParameterId_t  id)
static

Get the meta information of a datapool variable by identifier.

Which contains the starting address, the length, the multiplicity and the length of a single datapool entry.

Parameters
idThe datapool item identifier
Returns
Meta information in the form of the struct DpMetaInfoEntry_t

Definition at line 156 of file CrPsDp.c.

int setDpValue ( ParameterId_t  id,
const void *  src 
)

Set the value of a datapool item by identifier.

Parameters
idThe datapool item identifier
srcThe address of the source variable where the value gets copied from.
Returns
Number of bytes copied. 0 if id is invalid.

Definition at line 233 of file CrPsDp.c.

Variable Documentation

DpMetaInfoEntry_t dpMetaInfoParams[]
static
Initial value:
= {
{(void*)&dpServHkParams.debugVarAddr, sizeof(dpServHkParams.debugVarAddr), HK_N_DEBUG_VAR, sizeof(dpServHkParams.debugVarAddr[0])},
{(void*)&dpServHkParams.dest, sizeof(dpServHkParams.dest), HK_N_REP_DEF, sizeof(dpServHkParams.dest[0])},
{(void*)&dpServHkParams.isEnabled, sizeof(dpServHkParams.isEnabled), HK_N_REP_DEF, sizeof(dpServHkParams.isEnabled[0])},
{(void*)&dpServHkParams.period, sizeof(dpServHkParams.period), HK_N_REP_DEF, sizeof(dpServHkParams.period[0])},
{(void*)&dpServHkParams.sid, sizeof(dpServHkParams.sid), HK_N_REP_DEF, sizeof(dpServHkParams.sid[0])},
{(void*)&dpServLptParams.lptTimeOut, sizeof(dpServLptParams.lptTimeOut), LPT_N_BUF, sizeof(dpServLptParams.lptTimeOut[0])},
{(void*)&dpServTestParams.AreYouAliveTimeOut, sizeof(dpServTestParams.AreYouAliveTimeOut), 1, sizeof(dpServTestParams.AreYouAliveTimeOut)},
{(void*)&dpServTestParams.OnBoardConnectDestLst, sizeof(dpServTestParams.OnBoardConnectDestLst), TEST_MAX_APP, sizeof(dpServTestParams.OnBoardConnectDestLst[0])}
}
CrPsDestSrc_t OnBoardConnectDestLst[TEST_MAX_APP]
List of identifiers of target applications for an On-Board-Connection Test.
CrPsSid_t sid[HK_N_REP_DEF]
Array of HK_N_REP_DEF elements.
Definition: CrPsDpServHk.h:56
CrPsTimeOut_t lptTimeOut[LPT_N_BUF]
CrPsTimeOut_t TimeOut.
Definition: CrPsDpServLpt.h:36
CrPsAddr_t debugVarAddr[HK_N_DEBUG_VAR]
Array of HK_N_DEBUG_VAR elements.
Definition: CrPsDpServHk.h:37
CrPsTimeOut_t AreYouAliveTimeOut
Time-out for the Are-You-Alive Test initiated in response to an Is-Application-Process-Alive Test...
CrPsFlag_t isEnabled[HK_N_REP_DEF]
Array of HK_N_REP_DEF elements.
Definition: CrPsDpServHk.h:47
#define TEST_MAX_APP
Maximum number of target applications for On-Board-Connection Test.
CrPsPeriod_t period[HK_N_REP_DEF]
Collection period in units of HK_COLLECT_PER.
Definition: CrPsDpServHk.h:51
#define HK_N_REP_DEF
Number of Report Definitions in the Report Definition List (maximum number of housekeeping/diagnostic...
CrPsDestSrc_t dest[HK_N_REP_DEF]
Array of HK_N_REP_DEF elements.
Definition: CrPsDpServHk.h:42
#define HK_N_DEBUG_VAR
Number of debug variables.

Array of _DpMetaInfoEntry_t to hold the meta information of all datapool entries of the type parameter.

Definition at line 58 of file CrPsDp.c.

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