PARA_ParaAccess.c File Reference

#include <string.h>
#include "../lib/PARA/PARA_Lib.h"
#include "../lib/PARA/PARA_ID_System.h"
#include "project_Config.h"

Macros
#define	DEFAULT_ACCESSCODE_USER   0x7B30378C
#define	DEFAULT_ACCESSCODE_PROFESSIONAL   0x824B49AF
#define	DEFAULT_ACCESSCODE_DEVELOPER   0x23EA7C12
#define	PARA_STRING_MAX_LENGTH   16380
	Maximum length of the parameter strings (name, description, format, ...). The length is transfered as 2 byte 7BitEncodedInt (< 16384). More...

Enumerations
enum	ParameterStringType {   STRING_TYPE_NAME , STRING_TYPE_DESCRIPTION , STRING_TYPE_FORMAT , STRING_TYPE_GROUP_NAME ,   STRING_TYPE_SUBSTITUTION_TEXTS }
	String type of a parameter or group, which is read by ReadParameterString() More...

Functions
int32_t	ReadFunction_PARA_ParaId (Parameter *ptThis, const ParameterRequest *ptRequest)
int32_t	ReadFunction_PARA_GroupId (Parameter *ptThis, const ParameterRequest *ptRequest)
static int32_t	ReadParameterString (Parameter *ptThis, const ParameterRequest *ptRequest, ParameterStringType tType)
int32_t	ReadFunction_PARA_ParaName (Parameter *ptThis, const ParameterRequest *ptRequest)
int32_t	ReadFunction_PARA_ParaDescription (Parameter *ptThis, const ParameterRequest *ptRequest)
int32_t	ReadFunction_PARA_ParaFormat (Parameter *ptThis, const ParameterRequest *ptRequest)
int32_t	ReadFunction_PARA_Access (Parameter *ptThis, const ParameterRequest *ptRequest)
int32_t	ReadFunction_PARA_DataType (Parameter *ptThis, const ParameterRequest *ptRequest)
int32_t	ReadFunction_PARA_SubIdCount (Parameter *ptThis, const ParameterRequest *ptRequest)
int32_t	ReadFunction_PARA_GroupGroupId (Parameter *ptThis, const ParameterRequest *ptRequest)
int32_t	ReadFunction_PARA_GroupParent (Parameter *ptThis, const ParameterRequest *ptRequest)
int32_t	ReadFunction_PARA_GroupName (Parameter *ptThis, const ParameterRequest *ptRequest)
int32_t	ReadFunction_PARA_MinValue (Parameter *ptThis, const ParameterRequest *ptRequest)
int32_t	ReadFunction_PARA_MaxValue (Parameter *ptThis, const ParameterRequest *ptRequest)
int32_t	ReadFunction_PARA_DefaultValue (Parameter *ptThis, const ParameterRequest *ptRequest)
int32_t	ReadFunction_PARA_SubstText (Parameter *ptThis, const ParameterRequest *ptRequest)
int32_t	ReadFunction_PARA_Flags (Parameter *ptThis, const ParameterRequest *ptRequest)
static int32_t	ReadFunction_AccessPasscode (Parameter *ptThis, const ParameterRequest *ptRequest)
static int32_t	WriteFunction_AccessPasscode (Parameter *ptThis, const ParameterRequest *ptRequest)

Variables
uint8_t	g_ui8ActualAccessLevel =1
	Actual access-level (see Access restrictions). More...
uint8_t *	g_pui8ActualAccessLevelPointer = &g_ui8ActualAccessLevel
	Pointer to the Actual access-level (see Access restrictions). More...
const ParaData_I32	ParaData_ParaCount
const Parameter	PARA_ParaCount
const Parameter	PARA_ParaId
const Parameter	PARA_GroupId
const ParaData_STR	ParaData_ParaName
const Parameter	PARA_ParaName
const Parameter	PARA_ParaDescription
const Parameter	PARA_ParaFormat
const Parameter	PARA_Access
const Parameter	PARA_DataType
const Parameter	PARA_SubIdCount
const ParaData_I32	ParaData_GroupCount
const Parameter	PARA_GroupCount
const Parameter	PARA_GroupGroupId
const Parameter	PARA_GroupParent
const Parameter	PARA_GroupName
const ParaData_F32	ParaData_MinValue
const Parameter	PARA_MinValue
const Parameter	PARA_MaxValue
const Parameter	PARA_DefaultValue
const Parameter	PARA_ParaSubstText
const Parameter	PARA_Flags
const ParaData_U32	ParaData_AccessPasscode
const Parameter	PARA_AccessCode

Macro Definition Documentation

DEFAULT_ACCESSCODE_DEVELOPER

#define DEFAULT_ACCESSCODE_DEVELOPER   0x23EA7C12

DEFAULT_ACCESSCODE_PROFESSIONAL

#define DEFAULT_ACCESSCODE_PROFESSIONAL   0x824B49AF

DEFAULT_ACCESSCODE_USER

#define DEFAULT_ACCESSCODE_USER   0x7B30378C

PARA_STRING_MAX_LENGTH

#define PARA_STRING_MAX_LENGTH   16380

Maximum length of the parameter strings (name, description, format, ...). The length is transfered as 2 byte 7BitEncodedInt (< 16384).

Enumeration Type Documentation

ParameterStringType

enum ParameterStringType

String type of a parameter or group, which is read by ReadParameterString()

Enumerator
STRING_TYPE_NAME
STRING_TYPE_DESCRIPTION
STRING_TYPE_FORMAT
STRING_TYPE_GROUP_NAME
STRING_TYPE_SUBSTITUTION_TEXTS

Function Documentation

ReadFunction_AccessPasscode()

static int32_t ReadFunction_AccessPasscode ( Parameter *  ptThis, const ParameterRequest *  ptRequest  )

static

ReadFunction_PARA_Access()

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

ReadFunction_PARA_DataType()

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

ReadFunction_PARA_DefaultValue()

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

ReadFunction_PARA_Flags()

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

ReadFunction_PARA_GroupGroupId()

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

ReadFunction_PARA_GroupId()

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

ReadFunction_PARA_GroupName()

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

ReadFunction_PARA_GroupParent()

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

ReadFunction_PARA_MaxValue()

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

ReadFunction_PARA_MinValue()

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

ReadFunction_PARA_ParaDescription()

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

ReadFunction_PARA_ParaFormat()

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

ReadFunction_PARA_ParaId()

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

ReadFunction_PARA_ParaName()

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

ReadFunction_PARA_SubIdCount()

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

ReadFunction_PARA_SubstText()

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

ReadParameterString()

static int32_t ReadParameterString ( Parameter *  ptThis, const ParameterRequest *  ptRequest, ParameterStringType  tType  )

static

WriteFunction_AccessPasscode()

static int32_t WriteFunction_AccessPasscode ( Parameter *  ptThis, const ParameterRequest *  ptRequest  )

static

Variable Documentation

g_pui8ActualAccessLevelPointer

uint8_t* g_pui8ActualAccessLevelPointer = &g_ui8ActualAccessLevel

Pointer to the Actual access-level (see Access restrictions).

g_ui8ActualAccessLevel

uint8_t g_ui8ActualAccessLevel =1

Actual access-level (see Access restrictions).

PARA_Access

const Parameter PARA_Access

Initial value:

= 
{
GROUP_ID_Internal,  
PARA_ID_Access, 
 
VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ,   
MAX_uint16, 
 
"Access",   
"", 
"{0}",  
 
(void*)&ParaData_ParaName,  
 
(ReadFunction*)ReadFunction_PARA_Access,    
(WriteFunction*)WriteFunction_STD_Const,    
(RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
 
(TYPE_uint16<<28)|(NOT_STORED<<24)|FLAG_SYSTEM, 
"", 
}

PARA_AccessCode

const Parameter PARA_AccessCode

Initial value:

=
{
    GROUP_ID_System,    
    PARA_ID_AccessPasscode, 
    
    VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ | VIEWER_WRITE | USER_WRITE | PROFESSIONAL_WRITE | DEVELOPER_WRITE,    
    1,  
    
    "Parameter Access Level",   
    "Actual Access-Level. To change write the correct code to this parameter",  
    "{0}",  
    
    (void*)&ParaData_AccessPasscode,    
    
    (ReadFunction*)ReadFunction_AccessPasscode, 
    (WriteFunction*)WriteFunction_AccessPasscode,   
    (RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
    
    (TYPE_uint32<<28)|(NOT_STORED<<24)|FLAG_SCOPEABLE | FLAG_VOLATILE | FLAG_NO_FILE_OVERWRITE, 
    "0=None;1=Viewer;2=User;3=Professional;4=Developer", 
}

PARA_DataType

const Parameter PARA_DataType

Initial value:

= 
{
GROUP_ID_Internal,  
PARA_ID_DataType,   
 
VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ,   
MAX_uint16, 
 
"DataType", 
"", 
"{0}",  
 
(void*)&ParaData_ParaName,  
 
(ReadFunction*)ReadFunction_PARA_DataType,  
(WriteFunction*)WriteFunction_STD_Const,    
(RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
 
(TYPE_uint16<<28)|(NOT_STORED<<24)|FLAG_SYSTEM, 
"", 
}

PARA_DefaultValue

const Parameter PARA_DefaultValue

Initial value:

= 
{
GROUP_ID_Internal,  
PARA_ID_DefaultValue,   
 
VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ,   
MAX_uint16, 
 
"DefaultValues",    
"", 
"{0}",  
 
(void*)&ParaData_MinValue,  
 
(ReadFunction*)ReadFunction_PARA_DefaultValue,  
(WriteFunction*)WriteFunction_STD_Const,    
(RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
 
(TYPE_float<<28)|(NOT_STORED<<24)|FLAG_SYSTEM,  
"", 
}

PARA_Flags

const Parameter PARA_Flags

Initial value:

= 
{
GROUP_ID_Internal,  
PARA_ID_ParaFlags,  
 
VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ,   
MAX_uint16, 
 
"Flags",    
"", 
"{0}",  
 
(void*)&ParaData_ParaName,  
 
(ReadFunction*)ReadFunction_PARA_Flags, 
(WriteFunction*)WriteFunction_STD_Const,    
(RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
 
(TYPE_uint32<<28)|(NOT_STORED<<24)|FLAG_SYSTEM, 
"", 
}

PARA_GroupCount

const Parameter PARA_GroupCount

Initial value:

= 
{
GROUP_ID_Internal,  
PARA_ID_GroupCount, 
 
VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ,   
1,  
 
"GroupCount",   
"number of groups", 
"{0}",  
 
(void*)&ParaData_GroupCount,    
 
(ReadFunction*)ReadFunction_STD_U32,    
(WriteFunction*)WriteFunction_STD_Const,    
(RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
 
(TYPE_int32<<28)|(NOT_STORED<<24)|FLAG_SYSTEM,  
"", 
}

PARA_GroupGroupId

const Parameter PARA_GroupGroupId

Initial value:

= 
{
GROUP_ID_Internal,  
PARA_ID_GroupGroupId,   
 
VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ,   
MAX_uint16, 
 
"GroupGroupId", 
"", 
"{0}",  
 
0,  
 
(ReadFunction*)ReadFunction_PARA_GroupGroupId,  
(WriteFunction*)WriteFunction_STD_Const,    
(RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
 
(TYPE_uint16<<28)|(NOT_STORED<<24)|FLAG_SYSTEM, 
"", 
}

PARA_GroupId

const Parameter PARA_GroupId

Initial value:

= 
{
GROUP_ID_Internal,  
PARA_ID_GroupId,    
 
VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ,   
MAX_uint16, 
 
"GroupId",  
"", 
"{0}",  
 
0,  
 
(ReadFunction*)ReadFunction_PARA_GroupId,   
(WriteFunction*)WriteFunction_STD_Const,    
(RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
 
(TYPE_uint16<<28)|(NOT_STORED<<24)|FLAG_SYSTEM, 
"", 
}

PARA_GroupName

const Parameter PARA_GroupName

Initial value:

= 
{
GROUP_ID_Internal,  
PARA_ID_GroupName,  
 
VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ,   
MAX_uint16, 
 
"GroupName",    
"", 
"{0}",  
 
(void*)&ParaData_ParaName,  
 
(ReadFunction*)ReadFunction_PARA_GroupName, 
(WriteFunction*)WriteFunction_STD_Const,    
(RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
 
(TYPE_string<<28)|(NOT_STORED<<24)|FLAG_SYSTEM, 
"", 
}

PARA_GroupParent

const Parameter PARA_GroupParent

Initial value:

= 
{
GROUP_ID_Internal,  
PARA_ID_GroupParent,    
 
VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ,   
MAX_uint16, 
 
"GroupParent",  
"", 
"{0}",  
 
0,  
 
(ReadFunction*)ReadFunction_PARA_GroupParent,   
(WriteFunction*)WriteFunction_STD_Const,    
(RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
 
(TYPE_uint16<<28)|(NOT_STORED<<24)|FLAG_SYSTEM, 
"", 
}

PARA_MaxValue

const Parameter PARA_MaxValue

Initial value:

= 
{
GROUP_ID_Internal,  
PARA_ID_MaxValue,   
 
VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ,   
MAX_uint16, 
 
"MaxValues",    
"", 
"{0}",  
 
(void*)&ParaData_MinValue,  
 
(ReadFunction*)ReadFunction_PARA_MaxValue,  
(WriteFunction*)WriteFunction_STD_Const,    
(RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
 
(TYPE_float<<28)|(NOT_STORED<<24)|FLAG_SYSTEM,  
"", 
}

PARA_MinValue

const Parameter PARA_MinValue

Initial value:

= 
{
GROUP_ID_Internal,  
PARA_ID_MinValue,   
 
VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ,   
MAX_uint16, 
 
"MinValues",    
"", 
"{0}",  
 
(void*)&ParaData_MinValue,  
 
(ReadFunction*)ReadFunction_PARA_MinValue,  
(WriteFunction*)WriteFunction_STD_Const,    
(RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
 
(TYPE_float<<28)|(NOT_STORED<<24)|FLAG_SYSTEM,  
"", 
}

PARA_ParaCount

const Parameter PARA_ParaCount

Initial value:

= 
{
GROUP_ID_Internal,  
PARA_ID_ParaCount,  
 
VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ,   
1,  
 
"ParaCount",    
"number of parameters", 
"{0}",  
 
(void*)&ParaData_ParaCount, 
 
(ReadFunction*)ReadFunction_STD_U32,    
(WriteFunction*)WriteFunction_STD_Const,    
(RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
 
(TYPE_int32<<28)|(NOT_STORED<<24)|FLAG_SYSTEM,  
"", 
}

PARA_ParaDescription

const Parameter PARA_ParaDescription

Initial value:

= 
{
GROUP_ID_Internal,  
PARA_ID_ParaDescription,    
 
VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ,   
MAX_uint16, 
 
"Description",  
"", 
"{0}",  
 
(void*)&ParaData_ParaName,  
 
(ReadFunction*)ReadFunction_PARA_ParaDescription,   
(WriteFunction*)WriteFunction_STD_Const,    
(RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
 
(TYPE_string<<28)|(NOT_STORED<<24)|FLAG_SYSTEM, 
"", 
}

PARA_ParaFormat

const Parameter PARA_ParaFormat

Initial value:

= 
{
GROUP_ID_Internal,  
PARA_ID_ParaFormat, 
 
VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ,   
MAX_uint16, 
 
"Format",   
"", 
"{0}",  
 
(void*)&ParaData_ParaName,  
 
(ReadFunction*)ReadFunction_PARA_ParaFormat,    
(WriteFunction*)WriteFunction_STD_Const,    
(RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
 
(TYPE_string<<28)|(NOT_STORED<<24)|FLAG_SYSTEM, 
"", 
}

PARA_ParaId

const Parameter PARA_ParaId

Initial value:

= 
{
GROUP_ID_Internal,  
PARA_ID_ParaId, 
 
VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ,   
MAX_uint16, 
 
"ParaId",   
"", 
"{0}",  
 
0,  
 
(ReadFunction*)ReadFunction_PARA_ParaId,    
(WriteFunction*)WriteFunction_STD_Const,    
(RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
 
(TYPE_uint16<<28)|(NOT_STORED<<24)|FLAG_SYSTEM, 
"", 
}

PARA_ParaName

const Parameter PARA_ParaName

Initial value:

= 
{
GROUP_ID_Internal,  
PARA_ID_ParaName,   
 
VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ,   
MAX_uint16, 
 
"Name", 
"", 
"{0}",  
 
(void*)&ParaData_ParaName,  
 
(ReadFunction*)ReadFunction_PARA_ParaName,  
(WriteFunction*)WriteFunction_STD_Const,    
(RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
 
(TYPE_string<<28)|(NOT_STORED<<24)|FLAG_SYSTEM, 
"", 
}

PARA_ParaSubstText

const Parameter PARA_ParaSubstText

Initial value:

= 
{
GROUP_ID_Internal,  
PARA_ID_SubstitutionalTexts,    
 
VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ,   
MAX_uint16, 
 
"SubstitutionalTexts",  
"", 
"{0}",  
 
(void*)&ParaData_ParaName,  
 
(ReadFunction*)ReadFunction_PARA_SubstText, 
(WriteFunction*)WriteFunction_STD_Const,    
(RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
 
(TYPE_string<<28)|(NOT_STORED<<24)|FLAG_SYSTEM, 
"", 
}

PARA_SubIdCount

const Parameter PARA_SubIdCount

Initial value:

= 
{
GROUP_ID_Internal,  
PARA_ID_SubIdCount, 
 
VIEWER_READ | USER_READ | PROFESSIONAL_READ | DEVELOPER_READ,   
MAX_uint16, 
 
"SubIdCount",   
"", 
"{0}",  
 
0,  
 
(ReadFunction*)ReadFunction_PARA_SubIdCount,    
(WriteFunction*)WriteFunction_STD_Const,    
(RestoreDefaultFunction*)SetToDefaultFunction_STD_Const,    
 
(TYPE_uint16<<28)|(NOT_STORED<<24)|FLAG_SYSTEM, 
"", 
}

ParaData_AccessPasscode

const ParaData_U32 ParaData_AccessPasscode

Initial value:

=
{
    
    0,  
    MIN_uint32, 
    MAX_uint32, 
    0 
}

ParaData_GroupCount

const ParaData_I32 ParaData_GroupCount

Initial value:

= 
{
 
(int32_t*)&ANZAHL_GRUPPEN,  
MIN_int32, 
MAX_int32, 
0 
}

ParaData_MinValue

const ParaData_F32 ParaData_MinValue

Initial value:

= 
{
 
0,  
MIN_float32, 
MAX_float32, 
0 
}

ParaData_ParaCount

const ParaData_I32 ParaData_ParaCount

Initial value:

= 
{
 
&ANZAHL_PARAMETER,  
MIN_int32, 
MAX_int32, 
0 
}

ParaData_ParaName

const ParaData_STR ParaData_ParaName

Initial value:

= 
{
0,  
 16380 , 
"" 
}