ParaLib 2.0.15-master SHA: 2e03d68caa
PARA_Data.c File Reference

Parameter-Interface for connection with a PC. More...

#include <stdbool.h>
#include <stdint.h>
#include "SYS_Type.h"
#include <string.h>
#include "PARA_Lib.h"

Functions

bool IsValidForRead (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Check if the actual access-right is sufficient to read the parameter. More...
 
bool IsValidForWrite (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Check if the actual access-right is sufficient to write the parameter. More...
 
bool IsValidForSetToDefault (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Check if the actual access-right is sufficient to set to default the parameter. More...
 
int32_t ReadFunction_STD_I8 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default read-function for signed char datatype. More...
 
int32_t WriteFunction_STD_I8 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default write-function for signed char datatype. More...
 
int32_t SetToDefaultFunction_STD_I8 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default setToDefault-function for signed char datatype. More...
 
int32_t ReadFunction_STD_U8 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default read-function for unsigned char datatype. More...
 
int32_t WriteFunction_STD_U8 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default write-function for unsigned char datatype. More...
 
int32_t SetToDefaultFunction_STD_U8 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default setToDefault-function for unsigned char datatype. More...
 
int32_t ReadFunction_STD_U8_BitWise (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default read-function for unsigned char datatype as bit-array. More...
 
int32_t WriteFunction_STD_U8_BitWise (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default write-function for unsigned char datatype as bit-array. More...
 
int32_t SetToDefaultFunction_STD_U8_BitWise (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default setToDefault-function for signed char datatype as bit-array. More...
 
int32_t ReadFunction_STD_I16 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default read-function for signed word (16-Bit) datatype. More...
 
int32_t WriteFunction_STD_I16 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default write-function for signed word (16-Bit) datatype. More...
 
int32_t SetToDefaultFunction_STD_I16 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default setToDefault-function for signed word (16-Bit) datatype. More...
 
int32_t ReadFunction_STD_U16 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default read-function for unsigned word (16-Bit) datatype. More...
 
int32_t WriteFunction_STD_U16 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default write-function for unsigned word (16-Bit) datatype. More...
 
int32_t SetToDefaultFunction_STD_U16 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default setToDefault-function for nsigned word (16-Bit) datatype. More...
 
int32_t ReadFunction_STD_I32 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default read-function for signed int (32-Bit) datatype. More...
 
int32_t WriteFunction_STD_I32 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default write-function for signed int (32-Bit) datatype. More...
 
int32_t SetToDefaultFunction_STD_I32 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default setToDefault-function for signed int (32-Bit) datatype. More...
 
int32_t ReadFunction_STD_I32Q16 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 
int32_t WriteFunction_STD_I32Q16 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 
int32_t SetToDefaultFunction_STD_I32Q16 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 
int32_t ReadFunction_STD_U32 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default read-function for unsigned int (32-Bit) datatype. More...
 
int32_t WriteFunction_STD_U32 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default write-function for unsigned int (32-Bit) datatype. More...
 
int32_t SetToDefaultFunction_STD_U32 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default setToDefault-function for unsigned int (32-Bit) datatype. More...
 
int32_t ReadFunction_STD_F32 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default read-function for float (32-Bit) datatype. More...
 
int32_t WriteFunction_STD_F32 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default write-function for float (32-Bit) datatype. More...
 
int32_t SetToDefaultFunction_STD_F32 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default setToDefault-function for float (32-Bit) datatype. More...
 
int32_t ReadFunction_STD_I64 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default read-function for signed int (64-Bit) datatype. More...
 
int32_t WriteFunction_STD_I64 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default write-function for signed long int (64-Bit) datatype. More...
 
int32_t SetToDefaultFunction_STD_I64 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default setToDefault-function for signed long int (64-Bit) datatype. More...
 
int32_t ReadFunction_STD_U64 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default read-function for unsigned long int (64-Bit) datatype. More...
 
int32_t WriteFunction_STD_U64 (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default write-function for unsigned long int (64-Bit) datatype. More...
 
int32_t SetToDefaultFunction_STD_U64 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default setToDefault-function for unsigned long int (64-Bit) datatype. More...
 
int32_t ReadFunction_STD_STR (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default read-function for string datatype. More...
 
int32_t WriteFunction_STD_STR (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default write-function for string datatype. More...
 
int32_t SetToDefaultFunction_STD_STR (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default setToDefault-function for string datatype. More...
 
int32_t WriteFunction_STD_Const (Parameter *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default write-function for not writeable parameters. More...
 
int32_t SetToDefaultFunction_STD_Const (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
 Default SetToDefault-function for not writeable parameters. More...
 
void GetParaDataAsObject (Parameter *p, uint32_t pData, object *ob, uint8_t ui8AccessLevel)
 Get Parameter-data as object type. More...
 
void GetParaValueAsObject (Parameter *p, uint16_t SubId, object *ob, uint8_t ui8AccessLevel)
 Get Parameter-value as object type. More...
 
float ObjToFloat32 (object *ob)
 Convertrs a given object to float. More...
 

Detailed Description

Parameter-Interface for connection with a PC.

Functions for Backup-Storage into EEProm.

internal Parameters for accessing the Parameter-System


© Copyright 2017-2022 Copyright: Retostronik GmbH Stütingstraße 30 58285 Gevelsberg

Function Documentation

◆ GetParaDataAsObject()

void GetParaDataAsObject ( Parameter p,
uint32_t  pData,
object ob,
uint8_t  ui8AccessLevel 
)

Get Parameter-data as object type.

Dependant of the parameter pData, the Data of the given parameter is returned into object ob.

  • GET_MIN: The minimum value of the parameter is returned
  • GET_MAX: The maximum value of the parameter is returned
  • GET_DEFAULT: The default value of the parameter is returned
  • GET_BACKUP: The Backup value of the parameter is returned
    Parameters
    pPointer to the Parameter.
    pDataType of data. element of enum GET_VALUES
    [out]obObject to be written
    ui8AccessLevelActual AccessLevel (see Access restrictions).

◆ GetParaValueAsObject()

void GetParaValueAsObject ( Parameter p,
uint16_t  SubId,
object ob,
uint8_t  ui8AccessLevel 
)

Get Parameter-value as object type.

The vlaue of the given parameter is returned into object ob.

Parameters
pPointer to the Parameter.
SubIdSubId of the parameter
[out]obObject to be written
ui8AccessLevelActual AccessLevel (see Access restrictions).

◆ IsValidForRead()

bool IsValidForRead ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)
inline

Check if the actual access-right is sufficient to read the parameter.

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
pDataData to store
ui32MaxCountBuffer size. If smaller than data size, return false
ui32OffsetStart-offset to read from. If bigger than data-size return false.
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Return values
trueParameter can be read
falseParameter is not allowed to read

◆ IsValidForSetToDefault()

bool IsValidForSetToDefault ( Parameter ptThis,
uint16_t  ui16SubId,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)
inline

Check if the actual access-right is sufficient to set to default the parameter.

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Return values
trueParameter can be set to default
falseParameter is not allowed to be set to default

◆ IsValidForWrite()

bool IsValidForWrite ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)
inline

Check if the actual access-right is sufficient to write the parameter.

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
pDataData to store
ui32MaxCountBuffer size. If smaller than data size, return false
ui32OffsetStart-offset to read from. If bigger than data-size return false.
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Return values
trueParameter can be written
falseParameter is not allowed to be written

◆ ObjToFloat32()

float ObjToFloat32 ( object ob)

Convertrs a given object to float.

Parameters
obObject to be converted
Returns
float-value of the given object.

◆ ReadFunction_STD_F32()

int32_t ReadFunction_STD_F32 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default read-function for float (32-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
[out]pDataOutputbuffer to store the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the used buffer.

◆ ReadFunction_STD_I16()

int32_t ReadFunction_STD_I16 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default read-function for signed word (16-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
[out]pDataOutputbuffer to store the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the used buffer.

◆ ReadFunction_STD_I32()

int32_t ReadFunction_STD_I32 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default read-function for signed int (32-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
[out]pDataOutputbuffer to store the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the used buffer.

◆ ReadFunction_STD_I32Q16()

int32_t ReadFunction_STD_I32Q16 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)
Deprecated:
Default read-function for signed int (32-Bit) with 16 Bit fraction datatype. This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).
Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
[out]pDataOutputbuffer to store the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the used buffer.

◆ ReadFunction_STD_I64()

int32_t ReadFunction_STD_I64 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default read-function for signed int (64-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
[out]pDataOutputbuffer to store the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the used buffer.

◆ ReadFunction_STD_I8()

int32_t ReadFunction_STD_I8 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default read-function for signed char datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
[out]pDataOutputbuffer to store the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the used buffer.

◆ ReadFunction_STD_STR()

int32_t ReadFunction_STD_STR ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default read-function for string datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead). This function gives the complete string. First one or two character(s) store the length in 7BitEncodedInt Structure (see https://msdn.microsoft.com/en-us/library/dd946975(v=office.12).aspx)

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
[out]pDataOutputbuffer to store the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the used buffer.

◆ ReadFunction_STD_U16()

int32_t ReadFunction_STD_U16 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default read-function for unsigned word (16-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
[out]pDataOutputbuffer to store the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the used buffer.

◆ ReadFunction_STD_U32()

int32_t ReadFunction_STD_U32 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default read-function for unsigned int (32-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
[out]pDataOutputbuffer to store the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the used buffer.

◆ ReadFunction_STD_U64()

int32_t ReadFunction_STD_U64 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default read-function for unsigned long int (64-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
[out]pDataOutputbuffer to store the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the used buffer.

◆ ReadFunction_STD_U8()

int32_t ReadFunction_STD_U8 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default read-function for unsigned char datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
[out]pDataOutputbuffer to store the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the used buffer.

◆ ReadFunction_STD_U8_BitWise()

int32_t ReadFunction_STD_U8_BitWise ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default read-function for unsigned char datatype as bit-array.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
[out]pDataOutputbuffer to store the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the used buffer.

◆ SetToDefaultFunction_STD_Const()

int32_t SetToDefaultFunction_STD_Const ( Parameter ptThis,
uint16_t  ui16SubId,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default SetToDefault-function for not writeable parameters.

This write-function can be used, if the parameter is only readable. No Write Operation is allowed.

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to process.
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data
0

◆ SetToDefaultFunction_STD_F32()

int32_t SetToDefaultFunction_STD_F32 ( Parameter ptThis,
uint16_t  ui16SubId,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default setToDefault-function for float (32-Bit) datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to process.
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ SetToDefaultFunction_STD_I16()

int32_t SetToDefaultFunction_STD_I16 ( Parameter ptThis,
uint16_t  ui16SubId,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default setToDefault-function for signed word (16-Bit) datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to process.
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ SetToDefaultFunction_STD_I32()

int32_t SetToDefaultFunction_STD_I32 ( Parameter ptThis,
uint16_t  ui16SubId,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default setToDefault-function for signed int (32-Bit) datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to process.
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ SetToDefaultFunction_STD_I32Q16()

int32_t SetToDefaultFunction_STD_I32Q16 ( Parameter ptThis,
uint16_t  ui16SubId,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)
Deprecated:
Default setToDefault-function for signed int (32-Bit) with 16 Bit fraction datatype. Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).
Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to process.
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ SetToDefaultFunction_STD_I64()

int32_t SetToDefaultFunction_STD_I64 ( Parameter ptThis,
uint16_t  ui16SubId,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default setToDefault-function for signed long int (64-Bit) datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to process.
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ SetToDefaultFunction_STD_I8()

int32_t SetToDefaultFunction_STD_I8 ( Parameter ptThis,
uint16_t  ui16SubId,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default setToDefault-function for signed char datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to process.
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ SetToDefaultFunction_STD_STR()

int32_t SetToDefaultFunction_STD_STR ( Parameter ptThis,
uint16_t  ui16SubId,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default setToDefault-function for string datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to process.
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ SetToDefaultFunction_STD_U16()

int32_t SetToDefaultFunction_STD_U16 ( Parameter ptThis,
uint16_t  ui16SubId,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default setToDefault-function for nsigned word (16-Bit) datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to process.
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ SetToDefaultFunction_STD_U32()

int32_t SetToDefaultFunction_STD_U32 ( Parameter ptThis,
uint16_t  ui16SubId,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default setToDefault-function for unsigned int (32-Bit) datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to process.
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ SetToDefaultFunction_STD_U64()

int32_t SetToDefaultFunction_STD_U64 ( Parameter ptThis,
uint16_t  ui16SubId,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default setToDefault-function for unsigned long int (64-Bit) datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to process.
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ SetToDefaultFunction_STD_U8()

int32_t SetToDefaultFunction_STD_U8 ( Parameter ptThis,
uint16_t  ui16SubId,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default setToDefault-function for unsigned char datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to process.
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ SetToDefaultFunction_STD_U8_BitWise()

int32_t SetToDefaultFunction_STD_U8_BitWise ( Parameter ptThis,
uint16_t  ui16SubId,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default setToDefault-function for signed char datatype as bit-array.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to process.
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ WriteFunction_STD_Const()

int32_t WriteFunction_STD_Const ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default write-function for not writeable parameters.

This write-function can be used, if the parameter is only readable. No Write Operation is allowed.

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
pDataInputbuffer to read the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
0

◆ WriteFunction_STD_F32()

int32_t WriteFunction_STD_F32 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default write-function for float (32-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
pDataInputbuffer to read the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ WriteFunction_STD_I16()

int32_t WriteFunction_STD_I16 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default write-function for signed word (16-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
pDataInputbuffer to read the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ WriteFunction_STD_I32()

int32_t WriteFunction_STD_I32 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default write-function for signed int (32-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
pDataInputbuffer to read the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ WriteFunction_STD_I32Q16()

int32_t WriteFunction_STD_I32Q16 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)
Deprecated:
Default write-function for signed int (32-Bit) with 16 Bit fraction datatype. This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).
Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
pDataInputbuffer to read the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ WriteFunction_STD_I64()

int32_t WriteFunction_STD_I64 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default write-function for signed long int (64-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
pDataInputbuffer to read the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ WriteFunction_STD_I8()

int32_t WriteFunction_STD_I8 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default write-function for signed char datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
pDataInputbuffer to read the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ WriteFunction_STD_STR()

int32_t WriteFunction_STD_STR ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default write-function for string datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead). This function expects the complete string. First one or two character(s) store the length in 7BitEncodedInt Structure (see https://msdn.microsoft.com/en-us/library/dd946975(v=office.12).aspx)

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
pDataInputbuffer to read the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ WriteFunction_STD_U16()

int32_t WriteFunction_STD_U16 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default write-function for unsigned word (16-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
pDataInputbuffer to read the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ WriteFunction_STD_U32()

int32_t WriteFunction_STD_U32 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default write-function for unsigned int (32-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
pDataInputbuffer to read the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ WriteFunction_STD_U64()

int32_t WriteFunction_STD_U64 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default write-function for unsigned long int (64-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
pDataInputbuffer to read the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ WriteFunction_STD_U8()

int32_t WriteFunction_STD_U8 ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default write-function for unsigned char datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
pDataInputbuffer to read the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data

◆ WriteFunction_STD_U8_BitWise()

int32_t WriteFunction_STD_U8_BitWise ( Parameter ptThis,
uint16_t  ui16SubId,
void *  pData,
int32_t  ui32MaxCount,
uint32_t  ui32Offset,
ParameterAccessSource  tAccessSource,
uint8_t  ui8AccessLevel 
)

Default write-function for unsigned char datatype as bit-array.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters
ptThisPointer to the Parameter.
ui16SubIdSubID to read.
pDataInputbuffer to read the parametervalue.
ui32MaxCountBuffer size. If smaller than data size, return 0
ui32OffsetStart-offset to read from. If bigger than data-size return 0
tAccessSourceSource of access (see Access restrictions).
ui8AccessLevelActual AccessLevel (see Access restrictions).
Returns
Size in bytes of the written data