![]() |
ParaLib 2.0.15-master SHA: 2e03d68caa
|
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... | |
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
Get Parameter-data as object type.
Dependant of the parameter pData, the Data of the given parameter is returned into object ob.
| p | Pointer to the Parameter. | |
| pData | Type of data. element of enum GET_VALUES | |
| [out] | ob | Object to be written |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
Get Parameter-value as object type.
The vlaue of the given parameter is returned into object ob.
| p | Pointer to the Parameter. | |
| SubId | SubId of the parameter | |
| [out] | ob | Object to be written |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
|
inline |
Check if the actual access-right is sufficient to read the parameter.
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to read. |
| pData | Data to store |
| ui32MaxCount | Buffer size. If smaller than data size, return false |
| ui32Offset | Start-offset to read from. If bigger than data-size return false. |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
|
inline |
Check if the actual access-right is sufficient to set to default the parameter.
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to read. |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
|
inline |
Check if the actual access-right is sufficient to write the parameter.
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to read. |
| pData | Data to store |
| ui32MaxCount | Buffer size. If smaller than data size, return false |
| ui32Offset | Start-offset to read from. If bigger than data-size return false. |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| float ObjToFloat32 | ( | object * | ob | ) |
Convertrs a given object to float.
| ob | Object to be converted |
| 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).
| ptThis | Pointer to the Parameter. | |
| ui16SubId | SubID to read. | |
| [out] | pData | Outputbuffer to store the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 | |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 | |
| tAccessSource | Source of access (see Access restrictions). | |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. | |
| ui16SubId | SubID to read. | |
| [out] | pData | Outputbuffer to store the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 | |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 | |
| tAccessSource | Source of access (see Access restrictions). | |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. | |
| ui16SubId | SubID to read. | |
| [out] | pData | Outputbuffer to store the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 | |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 | |
| tAccessSource | Source of access (see Access restrictions). | |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| int32_t ReadFunction_STD_I32Q16 | ( | Parameter * | ptThis, |
| uint16_t | ui16SubId, | ||
| void * | pData, | ||
| int32_t | ui32MaxCount, | ||
| uint32_t | ui32Offset, | ||
| ParameterAccessSource | tAccessSource, | ||
| uint8_t | ui8AccessLevel | ||
| ) |
| ptThis | Pointer to the Parameter. | |
| ui16SubId | SubID to read. | |
| [out] | pData | Outputbuffer to store the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 | |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 | |
| tAccessSource | Source of access (see Access restrictions). | |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. | |
| ui16SubId | SubID to read. | |
| [out] | pData | Outputbuffer to store the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 | |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 | |
| tAccessSource | Source of access (see Access restrictions). | |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. | |
| ui16SubId | SubID to read. | |
| [out] | pData | Outputbuffer to store the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 | |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 | |
| tAccessSource | Source of access (see Access restrictions). | |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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)
| ptThis | Pointer to the Parameter. | |
| ui16SubId | SubID to read. | |
| [out] | pData | Outputbuffer to store the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 | |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 | |
| tAccessSource | Source of access (see Access restrictions). | |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. | |
| ui16SubId | SubID to read. | |
| [out] | pData | Outputbuffer to store the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 | |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 | |
| tAccessSource | Source of access (see Access restrictions). | |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. | |
| ui16SubId | SubID to read. | |
| [out] | pData | Outputbuffer to store the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 | |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 | |
| tAccessSource | Source of access (see Access restrictions). | |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. | |
| ui16SubId | SubID to read. | |
| [out] | pData | Outputbuffer to store the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 | |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 | |
| tAccessSource | Source of access (see Access restrictions). | |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. | |
| ui16SubId | SubID to read. | |
| [out] | pData | Outputbuffer to store the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 | |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 | |
| tAccessSource | Source of access (see Access restrictions). | |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. | |
| ui16SubId | SubID to read. | |
| [out] | pData | Outputbuffer to store the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 | |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 | |
| tAccessSource | Source of access (see Access restrictions). | |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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.
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to process. |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to process. |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to process. |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to process. |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| int32_t SetToDefaultFunction_STD_I32Q16 | ( | Parameter * | ptThis, |
| uint16_t | ui16SubId, | ||
| ParameterAccessSource | tAccessSource, | ||
| uint8_t | ui8AccessLevel | ||
| ) |
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to process. |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to process. |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to process. |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to process. |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to process. |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to process. |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to process. |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to process. |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to process. |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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.
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to read. |
| pData | Inputbuffer to read the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to read. |
| pData | Inputbuffer to read the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to read. |
| pData | Inputbuffer to read the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to read. |
| pData | Inputbuffer to read the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| int32_t WriteFunction_STD_I32Q16 | ( | Parameter * | ptThis, |
| uint16_t | ui16SubId, | ||
| void * | pData, | ||
| int32_t | ui32MaxCount, | ||
| uint32_t | ui32Offset, | ||
| ParameterAccessSource | tAccessSource, | ||
| uint8_t | ui8AccessLevel | ||
| ) |
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to read. |
| pData | Inputbuffer to read the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to read. |
| pData | Inputbuffer to read the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to read. |
| pData | Inputbuffer to read the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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)
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to read. |
| pData | Inputbuffer to read the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to read. |
| pData | Inputbuffer to read the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to read. |
| pData | Inputbuffer to read the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to read. |
| pData | Inputbuffer to read the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to read. |
| pData | Inputbuffer to read the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |
| 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).
| ptThis | Pointer to the Parameter. |
| ui16SubId | SubID to read. |
| pData | Inputbuffer to read the parametervalue. |
| ui32MaxCount | Buffer size. If smaller than data size, return 0 |
| ui32Offset | Start-offset to read from. If bigger than data-size return 0 |
| tAccessSource | Source of access (see Access restrictions). |
| ui8AccessLevel | Actual AccessLevel (see Access restrictions). |