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 (void pvThis, const ParameterRequest ptRequest)
	Check if the actual access-right is sufficient to read the parameter. More...

bool	IsValidForWrite (void pvThis, const ParameterRequest ptRequest)
	Check if the actual access-right is sufficient to write the parameter. More...

bool	IsValidForSetToDefault (void pvThis, const ParameterRequest ptRequest)
	Check if the actual access-right is sufficient to set to default the parameter. More...

int32_t	ReadFunction_STD_I8 (Parameter_I8 ptThis, const ParameterRequest ptRequest)
	Default read-function for signed char datatype. More...

int32_t	WriteFunction_STD_I8 (Parameter_I8 ptThis, const ParameterRequest ptRequest)
	Default write-function for signed char datatype. More...

int32_t	SetToDefaultFunction_STD_I8 (Parameter_I8 ptThis, const ParameterRequest ptRequest)
	Default setToDefault-function for signed char datatype. More...

int32_t	ReadFunction_STD_U8 (Parameter_U8 ptThis, const ParameterRequest ptRequest)
	Default read-function for unsigned char datatype. More...

int32_t	WriteFunction_STD_U8 (Parameter_U8 ptThis, const ParameterRequest ptRequest)
	Default write-function for unsigned char datatype. More...

int32_t	SetToDefaultFunction_STD_U8 (Parameter_U8 ptThis, const ParameterRequest ptRequest)
	Default setToDefault-function for unsigned char datatype. More...

int32_t	ReadFunction_STD_U8_BitWise (Parameter_U8 ptThis, const ParameterRequest ptRequest)
	Default read-function for unsigned char datatype as bit-array. More...

int32_t	WriteFunction_STD_U8_BitWise (Parameter_U8 ptThis, const ParameterRequest ptRequest)
	Default write-function for unsigned char datatype as bit-array. More...

int32_t	SetToDefaultFunction_STD_U8_BitWise (Parameter_U8 ptThis, const ParameterRequest ptRequest)
	Default setToDefault-function for signed char datatype as bit-array. More...

int32_t	ReadFunction_STD_I16 (Parameter_I16 ptThis, const ParameterRequest ptRequest)
	Default read-function for signed word (16-Bit) datatype. More...

int32_t	WriteFunction_STD_I16 (Parameter_I16 ptThis, const ParameterRequest ptRequest)
	Default write-function for signed word (16-Bit) datatype. More...

int32_t	SetToDefaultFunction_STD_I16 (Parameter_I16 ptThis, const ParameterRequest ptRequest)
	Default setToDefault-function for signed word (16-Bit) datatype. More...

int32_t	ReadFunction_STD_U16 (Parameter_U16 ptThis, const ParameterRequest ptRequest)
	Default read-function for unsigned word (16-Bit) datatype. More...

int32_t	WriteFunction_STD_U16 (Parameter_U16 ptThis, const ParameterRequest ptRequest)
	Default write-function for unsigned word (16-Bit) datatype. More...

int32_t	SetToDefaultFunction_STD_U16 (Parameter_U16 ptThis, const ParameterRequest ptRequest)
	Default setToDefault-function for nsigned word (16-Bit) datatype. More...

int32_t	ReadFunction_STD_I32 (Parameter_I32 ptThis, const ParameterRequest ptRequest)
	Default read-function for signed int (32-Bit) datatype. More...

int32_t	WriteFunction_STD_I32 (Parameter_I32 ptThis, const ParameterRequest ptRequest)
	Default write-function for signed int (32-Bit) datatype. More...

int32_t	SetToDefaultFunction_STD_I32 (Parameter_I32 ptThis, const ParameterRequest ptRequest)
	Default setToDefault-function for signed int (32-Bit) datatype. More...

int32_t	ReadFunction_STD_I32Q16 (Parameter_F32 ptThis, const ParameterRequest ptRequest)

int32_t	WriteFunction_STD_I32Q16 (Parameter_F32 ptThis, const ParameterRequest ptRequest)

int32_t	SetToDefaultFunction_STD_I32Q16 (Parameter_F32 ptThis, const ParameterRequest ptRequest)

int32_t	ReadFunction_STD_U32 (Parameter_U32 ptThis, const ParameterRequest ptRequest)
	Default read-function for unsigned int (32-Bit) datatype. More...

int32_t	WriteFunction_STD_U32 (Parameter_U32 ptThis, const ParameterRequest ptRequest)
	Default write-function for unsigned int (32-Bit) datatype. More...

int32_t	SetToDefaultFunction_STD_U32 (Parameter_U32 ptThis, const ParameterRequest ptRequest)
	Default setToDefault-function for unsigned int (32-Bit) datatype. More...

int32_t	ReadFunction_STD_F32 (Parameter_F32 ptThis, const ParameterRequest ptRequest)
	Default read-function for float (32-Bit) datatype. More...

int32_t	WriteFunction_STD_F32 (Parameter_F32 ptThis, const ParameterRequest ptRequest)
	Default write-function for float (32-Bit) datatype. More...

int32_t	SetToDefaultFunction_STD_F32 (Parameter_F32 ptThis, const ParameterRequest ptRequest)
	Default setToDefault-function for float (32-Bit) datatype. More...

int32_t	ReadFunction_STD_I64 (Parameter_I64 ptThis, const ParameterRequest ptRequest)
	Default read-function for signed int (64-Bit) datatype. More...

int32_t	WriteFunction_STD_I64 (Parameter_I64 ptThis, const ParameterRequest ptRequest)
	Default write-function for signed long int (64-Bit) datatype. More...

int32_t	SetToDefaultFunction_STD_I64 (Parameter_I64 ptThis, const ParameterRequest ptRequest)
	Default setToDefault-function for signed long int (64-Bit) datatype. More...

int32_t	ReadFunction_STD_U64 (Parameter_U64 ptThis, const ParameterRequest ptRequest)
	Default read-function for unsigned long int (64-Bit) datatype. More...

int32_t	WriteFunction_STD_U64 (Parameter_U64 ptThis, const ParameterRequest ptRequest)
	Default write-function for unsigned long int (64-Bit) datatype. More...

int32_t	SetToDefaultFunction_STD_U64 (Parameter_U64 ptThis, const ParameterRequest ptRequest)
	Default setToDefault-function for unsigned long int (64-Bit) datatype. More...

int32_t	ReadFunction_STD_STR (Parameter_STR ptThis, const ParameterRequest ptRequest)
	Default read-function for string datatype. More...

int32_t	WriteFunction_STD_STR (Parameter_STR ptThis, const ParameterRequest ptRequest)
	Default write-function for string datatype. More...

int32_t	SetToDefaultFunction_STD_STR (Parameter_STR ptThis, const ParameterRequest ptRequest)
	Default setToDefault-function for string datatype. More...

int32_t	WriteFunction_STD_Const (Parameter ptThis, const ParameterRequest ptRequest)
	Default write-function for not writeable parameters. More...

int32_t	SetToDefaultFunction_STD_Const (Parameter ptThis, const ParameterRequest ptRequest)
	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

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

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

◆ 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

	p	Pointer to the Parameter.
	SubId	SubId of the parameter
[out]	ob	Object to be written
	ui8AccessLevel	Actual AccessLevel (see Access restrictions).

◆ IsValidForRead()

bool IsValidForRead	(	void *	pvThis,
		const ParameterRequest *	ptRequest
	)

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

Parameters

pvThis	Pointer to the Parameter (Parameter or any Parameter_<T>).
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Return values

true	Parameter can be read
false	Parameter is not allowed to read

◆ IsValidForSetToDefault()

bool IsValidForSetToDefault	(	void *	pvThis,
		const ParameterRequest *	ptRequest
	)

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

Parameters

pvThis	Pointer to the Parameter (Parameter or any Parameter_<T>).
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Return values

true	Parameter can be set to default
false	Parameter is not allowed to be set to default

◆ IsValidForWrite()

bool IsValidForWrite	(	void *	pvThis,
		const ParameterRequest *	ptRequest
	)

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

Parameters

pvThis	Pointer to the Parameter (Parameter or any Parameter_<T>).
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Return values

true	Parameter can be written
false	Parameter is not allowed to be written

◆ ObjToFloat32()

float ObjToFloat32 ( object * ob )

Convertrs a given object to float.

Parameters

ob	Object to be converted

Returns: float-value of the given object.

◆ ReadFunction_STD_F32()

int32_t ReadFunction_STD_F32	(	Parameter_F32 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_I16()

int32_t ReadFunction_STD_I16	(	Parameter_I16 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_I32()

int32_t ReadFunction_STD_I32	(	Parameter_I32 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_I32Q16()

int32_t ReadFunction_STD_I32Q16	(	Parameter_F32 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_I64()

int32_t ReadFunction_STD_I64	(	Parameter_I64 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_I8()

int32_t ReadFunction_STD_I8	(	Parameter_I8 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_STR()

int32_t ReadFunction_STD_STR	(	Parameter_STR *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_U16()

int32_t ReadFunction_STD_U16	(	Parameter_U16 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_U32()

int32_t ReadFunction_STD_U32	(	Parameter_U32 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_U64()

int32_t ReadFunction_STD_U64	(	Parameter_U64 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_U8()

int32_t ReadFunction_STD_U8	(	Parameter_U8 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_U8_BitWise()

int32_t ReadFunction_STD_U8_BitWise	(	Parameter_U8 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the used buffer.

◆ SetToDefaultFunction_STD_Const()

int32_t SetToDefaultFunction_STD_Const	(	Parameter *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data; 0

◆ SetToDefaultFunction_STD_F32()

int32_t SetToDefaultFunction_STD_F32	(	Parameter_F32 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_I16()

int32_t SetToDefaultFunction_STD_I16	(	Parameter_I16 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_I32()

int32_t SetToDefaultFunction_STD_I32	(	Parameter_I32 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_I32Q16()

int32_t SetToDefaultFunction_STD_I32Q16	(	Parameter_F32 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_I64()

int32_t SetToDefaultFunction_STD_I64	(	Parameter_I64 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_I8()

int32_t SetToDefaultFunction_STD_I8	(	Parameter_I8 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_STR()

int32_t SetToDefaultFunction_STD_STR	(	Parameter_STR *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_U16()

int32_t SetToDefaultFunction_STD_U16	(	Parameter_U16 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_U32()

int32_t SetToDefaultFunction_STD_U32	(	Parameter_U32 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_U64()

int32_t SetToDefaultFunction_STD_U64	(	Parameter_U64 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_U8()

int32_t SetToDefaultFunction_STD_U8	(	Parameter_U8 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_U8_BitWise()

int32_t SetToDefaultFunction_STD_U8_BitWise	(	Parameter_U8 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ WriteFunction_STD_Const()

int32_t WriteFunction_STD_Const	(	Parameter *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: 0

◆ WriteFunction_STD_F32()

int32_t WriteFunction_STD_F32	(	Parameter_F32 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ WriteFunction_STD_I16()

int32_t WriteFunction_STD_I16	(	Parameter_I16 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ WriteFunction_STD_I32()

int32_t WriteFunction_STD_I32	(	Parameter_I32 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ WriteFunction_STD_I32Q16()

int32_t WriteFunction_STD_I32Q16	(	Parameter_F32 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ WriteFunction_STD_I64()

int32_t WriteFunction_STD_I64	(	Parameter_I64 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ WriteFunction_STD_I8()

int32_t WriteFunction_STD_I8	(	Parameter_I8 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ WriteFunction_STD_STR()

int32_t WriteFunction_STD_STR	(	Parameter_STR *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ WriteFunction_STD_U16()

int32_t WriteFunction_STD_U16	(	Parameter_U16 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ WriteFunction_STD_U32()

int32_t WriteFunction_STD_U32	(	Parameter_U32 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ WriteFunction_STD_U64()

int32_t WriteFunction_STD_U64	(	Parameter_U64 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ WriteFunction_STD_U8()

int32_t WriteFunction_STD_U8	(	Parameter_U8 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

◆ WriteFunction_STD_U8_BitWise()

int32_t WriteFunction_STD_U8_BitWise	(	Parameter_U8 *	ptThis,
		const ParameterRequest *	ptRequest
	)

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

ptThis	Pointer to the Parameter.
ptRequest	Request information (SubId, data buffer, access source and level), see ParameterRequest.

Returns: Size in bytes of the written data

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