CORDET Framework - C2 Implementation
CrPsDp.h File Reference

Interface for accessing data pool items. More...

Go to the source code of this file.

Enumerations

enum  {
  DpIdParamsLowest = 1, DpIdParamsHighest = 8, DpIddebugVarAddr = 1, DpIddest = 2,
  DpIdisEnabled = 3, DpIdperiod = 4, DpIdsid = 5, DpIdlptTimeOut = 6,
  DpIdAreYouAliveTimeOut = 7, DpIdOnBoardConnectDestLst = 8, DpIdVarsLowest = 9, DpIdVarsHighest = 64,
  DpIdisEidEnabled = 9, DpIdlastEvtEid_1 = 10, DpIdlastEvtEid_2 = 11, DpIdlastEvtEid_3 = 12,
  DpIdlastEvtEid_4 = 13, DpIdlastEvtTime_1 = 14, DpIdlastEvtTime_2 = 15, DpIdlastEvtTime_3 = 16,
  DpIdlastEvtTime_4 = 17, DpIdnOfDetectedEvts_1 = 18, DpIdnOfDetectedEvts_2 = 19, DpIdnOfDetectedEvts_3 = 20,
  DpIdnOfDetectedEvts_4 = 21, DpIdnOfDisabledEid_1 = 22, DpIdnOfDisabledEid_2 = 23, DpIdnOfDisabledEid_3 = 24,
  DpIdnOfDisabledEid_4 = 25, DpIdnOfGenEvtRep_1 = 26, DpIdnOfGenEvtRep_2 = 27, DpIdnOfGenEvtRep_3 = 28,
  DpIdnOfGenEvtRep_4 = 29, DpIdcycleCnt = 30, DpIddebugVar = 31, DpIdlstId = 32,
  DpIdlstNSampRep = 33, DpIdlstSampleRep = 34, DpIdnSimple = 35, DpIdsampleBufId = 36,
  DpIdlargeMsgTransId = 37, DpIdlptFailCode = 38, DpIdlptRemSize = 39, DpIdlptSize = 40,
  DpIdlptSrc = 41, DpIdlptTime = 42, DpIdnOfDownlinks = 43, DpIdnOfUplinks = 44,
  DpIdpartSeqNmb = 45, DpIdfailCodeAccFailed = 46, DpIdfailCodePrgrFailed = 47, DpIdfailCodeStartFailed = 48,
  DpIdfailCodeTermFailed = 49, DpIdinvDestRerouting = 50, DpIdnOfAccFailed = 51, DpIdnOfPrgrFailed = 52,
  DpIdnOfReroutingFailed = 53, DpIdnOfStartFailed = 54, DpIdnOfTermFailed = 55, DpIdpcktIdAccFailed = 56,
  DpIdpcktIdPrgrFailed = 57, DpIdpcktIdReroutingFailed = 58, DpIdpcktIdStartFailed = 59, DpIdpcktIdTermFailed = 60,
  DpIdstepPrgrFailed = 61, DpIdverFailData = 62, DpIdAreYouAliveSrc = 63, DpIdOnBoardConnectDest = 64
}
 

Functions

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

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

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.

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.

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