Parameter base class. More...

#include <Parameter_Base.h>

Inheritance diagram for TParameter_Base:

Collaboration diagram for TParameter_Base:

Public Member Functions
	TParameter_Base ()
	Parameter base class constructor method. More...

virtual BOOL	Init ()=0
	Parameter object initialisation method. More...

VOID	Set_Type (TConOpSys_Variant_Data_Type enum_Type)
	Set new parameter datatype. More...

VOID	Set_Media_Storage_Index (U32 u32_New_Media_Storage_Index)
	Set media storage index. More...

BOOL	Is_Pointer_Type ()
	Return test result for parameter is pointer type. More...

BOOL	Is_Storage_Type ()
	Return test result for parameter is storage type. More...

BOOL	Is_Name (C8 *c8_Parameter_Name)
	Return parameter name checking status. More...

BOOL	Is_ID (U32 u32_ID)
	Return parameter identifier checking status. More...

BOOL	Is_Value_Valid ()
	Return status of the parameter value validation. More...

BOOL	Is_Nonvolatile ()
	Return nonvalatile parameter status. More...

BOOL	Is_Quasivolatile ()
	Return quasivalatile parameter status. More...

BOOL	Is_Store_To_Media_Database ()
	Return store to media parameter status. More...

BOOL	Is_Initialised ()
	Return parameter initialisation status. More...

BOOL	Is_Default_Initialised ()
	Return parameter default value initialisation status. More...

BOOL	Is_Media_Initialised ()
	Return parameter media value initialisation status. More...

BOOL	Is_Writable ()
	Return parameter writability status. More...

BOOL	Is_Readable ()
	Return parameter readability status. More...

BOOL	Is_Array ()
	Return parameter array status. More...

BOOL	Is_Element_Exists (U32 u32_Element_Index)
	Return parameter element index exist status. More...

VOID	Send_Information (TProtocol_Base *object_Protocol)
	Send parameter information over given protocol. More...

BOOL	Write_Value_As_String (C8 *s8_New_Value)
	Write parameter value from zero terminated decimal string. More...

BOOL	Write_Value_As_Hex_String (C8 *s8_New_Value)
	Write parameter value from zero terminated hex string. More...

BOOL	Write_Value_As_Hex_String (C8 *s8_New_Value, U32 u32_Element_Index)
	Write parameter element value from zero terminated hex string. More...

BOOL	Write_Value_As_BOOL (BOOL bool_New_Value)
	Write parameter value from boolean value. More...

BOOL	Write_Value_As_U8 (U8 u8_New_Value)
	Write parameter value from U8 value. More...

BOOL	Write_Value_As_I8 (I8 i8_New_Value)
	Write parameter value from I8 value. More...

BOOL	Write_Value_As_U16 (U16 u16_New_Value)
	Write parameter value from U16 value. More...

BOOL	Write_Value_As_I16 (I16 i16_New_Value)
	Write parameter value from I16 value. More...

BOOL	Write_Value_As_U32 (U32 u32_New_Value)
	Write parameter value from U32 value. More...

BOOL	Write_Value_As_I32 (I32 i32_New_Value)
	Write parameter value from I32 value. More...

BOOL	Write_Value_As_U64 (U64 u64_New_Value)
	Write parameter value from U64 value. More...

BOOL	Write_Value_As_U64 (U64 u64_New_Value, U32 u32_Element_Index)
	Write parameter value from U64 value. More...

BOOL	Write_Value_As_I64 (I64 i64_New_Value)
	Write parameter value from I64 value. More...

BOOL	Write_Value_As_F32 (F32 f32_New_Value)
	Write parameter value from F32 value. More...

BOOL	Write_Value_As_F64 (F64 f64_New_Value)
	Write parameter value from F64 value. More...

BOOL	Write_Value_As_Variant (TConOpSys_Variant *object_New_Value)
	Write parameter value from variant value. More...

BOOL	Write_Value_As_Variant (TConOpSys_Variant *object_New_Value, U32 u32_Element_Index)
	Write parameter element value from variant value. More...

BOOL	Read_Value_As_BOOL (BOOL *bool_Value)
	Read parameter value as boolean value. More...

BOOL	Read_Value_As_U8 (U8 *u8_Value)
	Read parameter value as 8-bit unsigned value. More...

BOOL	Read_Value_As_I8 (I8 *i8_Value)
	Read parameter value as 8-bit signed value. More...

BOOL	Read_Value_As_U16 (U16 *u16_Value)
	Read parameter value as 16-bit unsigned value. More...

BOOL	Read_Value_As_I16 (I16 *i16_Value)
	Read parameter value as 16-bit signed value. More...

BOOL	Read_Value_As_U32 (U32 *u32_Value)
	Read parameter value as 32-bit unsigned value. More...

BOOL	Read_Value_As_I32 (I32 *i32_Value)
	Read parameter value as 32-bit signed value. More...

BOOL	Read_Value_As_U64 (U64 *u64_Value)
	Read parameter value as 64-bit unsigned value. More...

BOOL	Read_Value_As_I64 (I64 *i64_Value)
	Read parameter value as 64-bit signed value. More...

BOOL	Read_Value_As_F32 (F32 *f32_Value)
	Read parameter value as 32-bit floating point value. More...

BOOL	Read_Value_As_F64 (F64 *f64_Value)
	Read parameter value as 64-bit floating point value. More...

BOOL	Read_Value_As_Variant (TConOpSys_Variant *object_Read_Value)
	Read parameter value as variant value. More...

BOOL	Read_Value_As_Variant (TConOpSys_Variant *object_Read_Value, U32 u32_Element_Index)
	Read parameter value as variant value. More...

BOOL	Read_Value_As_Raw_Data (U8 *u8_Raw_Data)
	Read parameter value as raw data value. More...

VOID	Connect (TBlock_Output_Connector *object_Connector)
	Connect parameter to the function block output connector. More...

VOID	Connect (BOOL bool_Value)
	Connect parameter to the constant value of BOOL datatype. More...

VOID	Connect (I8 i8_Value)
	Connect parameter to the constant value of I8 datatype. More...

VOID	Connect (U8 u8_Value)
	Connect parameter to the constant value of U8 datatype. More...

VOID	Connect (I16 i16_Value)
	Connect parameter to the constant value of I16 datatype. More...

VOID	Connect (U16 u16_Value)
	Connect parameter to the constant value of U16 datatype. More...

VOID	Connect (I32 i32_Value)
	Connect parameter to the constant value of I32 datatype. More...

VOID	Connect (U32 u32_Value)
	Connect parameter to the constant value of U32 datatype. More...

VOID	Connect (I64 i64_Value)
	Connect parameter to the constant value of I64 datatype. More...

VOID	Connect (U64 u64_Value)
	Connect parameter to the constant value of U64 datatype. More...

VOID	Connect (F32 f32_Value)
	Connect parameter to the constant value of F32 datatype. More...

VOID	Connect (F64 f64_Value)
	Connect parameter to the constant value of F64 datatype. More...

U32	Get_ID ()
	Get parameter identifier. More...

TConOpSys_Variant_Data_Type	Get_Storage_Type ()
	Get parameter underlying storage data type. More...

U32	Get_Parameter_Properties ()
	Get parameter properties as U32 value. More...

U32	Get_Parameter_Element_Count ()
	Get parameter element count by array parameters. More...

TConOpSys_Variant_Data_Type	Get_Type ()
	Get parameter actual datatype. More...

TParameter_Access_Mode	Get_Access_Mode ()
	Get parameter actual access mode. More...

TParameter_Boundary_Check_Mode	Get_Limit_Check_Mode ()
	Get parameter actual boundary check mode. More...

TParameter_Display_Format	Get_Display_Format ()
	Get parameter actual display format. More...

BOOL	Get_Nonvolatile_Flag ()
	Get parameter nonvolatile flag. More...

U32	Get_Size ()
	Get parameter value in bytes. More...

TConOpSys_Variant	Get_Minimum_Value ()
	Get parameter minimum value as variant. More...

TConOpSys_Variant	Get_Maximum_Value ()
	Get parameter maximum value as variant. More...

TConOpSys_Variant	Get_Default_Value ()
	Get parameter default value as variant. More...

TConOpSys_Variant	Get_Value ()
	Get parameter actual value as variant. More...

TConOpSys_Variant_Data	Get_Variant_Data ()
	Get parameter actual underlaying storage datatype. More...

TConOpSys_Variant_Data	Get_Variant_Data (U32 u32_Element_Index)
	Get parameter actual underlaying storage datatype. More...

U32	Get_Media_Storage_Index ()
	Get parameter actual media storage index. More...

VOID	Clear_Media_Storage_Index ()
	Clear parameter actual media storage index. More...

U64	Get_PUUID_High ()
	Get parameter actual PUUID high. More...

U64	Get_PUUID_Low ()
	Get parameter actual PUUID low. More...

U32	Get_Element_Count ()
	Get parameter element count. More...

C8 *	Get_Parameter_Name ()
	Get parameter name. More...

C8 *	Get_Group_Name ()
	Get parameter group name. More...

C8 *	Get_Description ()
	Get parameter description. More...

C8 *	Get_Unit_Name ()
	Get parameter units name. More...

VOID	Clear_Value ()
	Clear parameter value. More...

virtual BOOL	Init_Data_Processing ()
	Parameter initialisation data default virtual processing method. More...

virtual BOOL	Pre_Read_Data_Processing ()
	Parameter pre-read data processing default virtual processing method. More...

virtual BOOL	Post_Read_Data_Processing ()
	Parameter post-read data processing default virtual processing method. More...

virtual BOOL	Pre_Write_Data_Processing ()
	Parameter pre-write data processing default virtual processing method. More...

virtual BOOL	Post_Write_Data_Processing ()
	Parameter post-write data processing default virtual processing method. More...

virtual BOOL	Check_Parameter_Boundary_Processing ()
	Check parameter boundary data processing default virtual processing method. More...

virtual BOOL	Check_And_Fix_Parameter_Boundary_Processing ()
	Fix parameter boundary data processing default virtual processing method. More...

VOID	Set_Store_Request ()
	Set parameter value store request. More...

VOID	Clear_Store_Request ()
	Clear parameter value store request. More...

VOID	Initialise_From_Media (TConOpSys_Variant_Data struct_Variant_Data_Pointer)
	Initialise parameter value from the media. More...

VOID	Initialise_From_Media (TConOpSys_Variant_Data struct_Variant_Data_Pointer, U32 u32_Element_Index)
	Initialise parameter value from the media. More...

VOID	Append_Hash_Data (U32 *u32_Hash_Value)
	Append parameter descriptor data to the hash value. More...

VOID	operator= (TBlock_Output_Connector &object_Connector)
	Connect to the output connector. More...

Public Attributes
TConOpSys_Variant	struct_Value
	Parameter value storage variable. More...

Protected Member Functions
BOOL	Configure (const TParameter_Descriptor *struct_New_Parameter_Descriptor)
	Configure parameter from parameter descriptor. More...

BOOL	Initialise_Value ()
	Initiaise parameter value method. More...

BOOL	Initialise_Element ()
	Initiaise single element parameter method. More...

BOOL	Initialise_Array ()
	Initiaise array parameter method. More...

Protected Attributes
TParameter_Descriptor *	struct_Parameter_Descriptor = (TParameter_Descriptor*)NULL
	Pointer to the parameter descriptor structure. More...

Private Member Functions
BOOL	Check_Limits (TConOpSys_Variant *object_New_Value)
	Check value against actual bounds method. More...

BOOL	Check_And_Fix_Out_Of_Limit_Value ()
	Check and fix out of limit values method. More...

Private Attributes
TParameter_Status	struct_Status = { .u32_Status = (U32)0x00000000 }
	Parameter status. More...

U32	u32_Media_Storage_Index = (U32)0xFFFFFFFF
	Media storage index. More...

Detailed Description

Parameter base class.

Constructor & Destructor Documentation

◆ TParameter_Base()

TParameter_Base::TParameter_Base ( )

Parameter base class constructor method.

Note: None

Override: Not allowed

Attention: Don't call this method directly.

References TConOpSys_Variant::Clear(), and struct_Value.

Here is the call graph for this function:

Member Function Documentation

◆ Append_Hash_Data()

VOID TParameter_Base::Append_Hash_Data ( U32 * u32_Hash_Value )

Append parameter descriptor data to the hash value.

Note: None

Parameters

[in,out] *u32_Hash_Value - Pointer to the hash value

Override: Not allowed

Attention: None

References struct_Parameter_Descriptor, and TCRC_32::Update().

Referenced by TParameter_Manager::Register().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Check_And_Fix_Out_Of_Limit_Value()

BOOL TParameter_Base::Check_And_Fix_Out_Of_Limit_Value ( )

private

Check and fix out of limit values method.

Note: This method verified actual parameter values against actual boundaries and set value to default in out of boundaries case

Returns: BOOL - Method execution status

Return values

false	- Parameter value in bounds
true	- Parameter value out of bounds

Override: Optional

Attention: None

Todo:: ANVILEX : changes requered during parameter manager optimisation. Comparation may be suspect.

Todo:: ANVILEX : changes requered during parameter manager optimisation. Comparation may be suspect.

Todo:: ANVILEX : changes requered during parameter manager optimisation. Comparation may be suspect.

Todo:: ANVILEX : changes requered during parameter manager optimisation. Comparation may be suspect.

Todo:: ANVILEX : changes requered during parameter manager optimisation. Comparation may be suspect.

Todo:: ANVILEX : changes requered during parameter manager optimisation. Comparation may be suspect.

Todo:: ANVILEX : changes requered during parameter manager optimisation. Comparation may be suspect.

Todo:: ANVILEX : changes requered during parameter manager optimisation. Comparation may be suspect.

References Check_And_Fix_Parameter_Boundary_Processing(), check_mode_Greater, check_mode_GreaterEqual, check_mode_Less, check_mode_Less_Greater, check_mode_Less_GreaterEqual, check_mode_LessEqual, check_mode_LessEqual_Greater, check_mode_LessEqual_GreaterEqual, check_mode_No_Check, check_mode_User, TParameter_Descriptor::enum_Limit_Check_Mode, TParameter_Descriptor::struct_Default_Value, TParameter_Descriptor::struct_Maximum_Value, TParameter_Descriptor::struct_Minimum_Value, struct_Parameter_Descriptor, and struct_Value.

Referenced by Initialise_Element(), and Initialise_From_Media().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Check_And_Fix_Parameter_Boundary_Processing()

BOOL TParameter_Base::Check_And_Fix_Parameter_Boundary_Processing ( )

virtual

Fix parameter boundary data processing default virtual processing method.

Note: None

Returns: BOOL - Method execution status

Return values

false	- Parameter boundary test processing failed with error
true	- Parameter boundary test processing successed

Override: Optional

Attention: None

Referenced by Check_And_Fix_Out_Of_Limit_Value().

Here is the caller graph for this function:

◆ Check_Limits()

BOOL TParameter_Base::Check_Limits ( TConOpSys_Variant * object_New_Value )

private

Check value against actual bounds method.

Todo:: ANVILEX KM: ???

Note: None

Parameters

[in] *object_New_Value - Pointer to the value

Returns: BOOL - Method execution status

Return values

false	- Value in bounds
true	- Value out of bounds

Override: Optional

Attention: None

Todo:: ANVILEX KM: ???

Todo:: ANVILEX : changes requered during parameter manager optimisation. Comparation may be suspect.

Todo:: ANVILEX : changes requered during parameter manager optimisation. Comparation may be suspect.

Todo:: ANVILEX : changes requered during parameter manager optimisation. Comparation may be suspect.

Todo:: ANVILEX : changes requered during parameter manager optimisation. Comparation may be suspect.

Todo:: ANVILEX : changes requered during parameter manager optimisation. Comparation may be suspect.

Todo:: ANVILEX : changes requered during parameter manager optimisation. Comparation may be suspect.

Todo:: ANVILEX : changes requered during parameter manager optimisation. Comparation may be suspect.

Todo:: ANVILEX : changes requered during parameter manager optimisation. Comparation may be suspect.

References check_mode_Greater, check_mode_GreaterEqual, check_mode_Less, check_mode_Less_Greater, check_mode_Less_GreaterEqual, check_mode_LessEqual, check_mode_LessEqual_Greater, check_mode_LessEqual_GreaterEqual, check_mode_No_Check, check_mode_User, Check_Parameter_Boundary_Processing(), TParameter_Descriptor::enum_Limit_Check_Mode, TParameter_Descriptor::struct_Maximum_Value, TParameter_Descriptor::struct_Minimum_Value, and struct_Parameter_Descriptor.

Referenced by Write_Value_As_Variant().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Check_Parameter_Boundary_Processing()

BOOL TParameter_Base::Check_Parameter_Boundary_Processing ( )

virtual

Check parameter boundary data processing default virtual processing method.

Note: None

Returns: BOOL - Method execution status

Return values

false	- Parameter boundary test processing failed with error
true	- Parameter boundary test processing successed

Override: Optional

Attention: None

Referenced by Check_Limits().

Here is the caller graph for this function:

◆ Clear_Media_Storage_Index()

VOID TParameter_Base::Clear_Media_Storage_Index ( )

Clear parameter actual media storage index.

Note: None

Override: Not allowed

Attention: None

References u32_Media_Storage_Index.

Referenced by TParameter_Manager::Clear_Parameter_Storage_Indexis().

Here is the caller graph for this function:

◆ Clear_Store_Request()

VOID TParameter_Base::Clear_Store_Request ( )

Clear parameter value store request.

Note: None

Override: Not allowed

Attention: None

References TParameter_Status::Fields, struct_Status, and TParameter_Status::u32_Store_To_Media_Request.

◆ Clear_Value()

VOID TParameter_Base::Clear_Value ( )

Clear parameter value.

Note: Set parameter value storage to initial zero condition

Override: Not allowed

Attention: None

References TConOpSys_Variant::Clear(), and struct_Value.

Referenced by TSignal_Recorder::Set_Trigger_Source().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Configure()

BOOL TParameter_Base::Configure ( const TParameter_Descriptor * struct_New_Parameter_Descriptor )

protected

Configure parameter from parameter descriptor.

Note: None

Parameters

[in] *struct_New_Parameter_Descriptor - Pointer to the parameter descriptor

Returns: BOOL - Method execution status

Return values

false	- Parameter cofiguration failed
true	- Parameter cofiguration successed

Override: Not allowed

Attention: None

References TParameter_Descriptor::enum_Data_Type, TParameter_Status::Fields, Is_ConOpSys_Variant_Data_Type_Array(), Is_ConOpSys_Variant_Data_Type_Element(), Is_ConOpSys_Variant_Data_Type_Pointer(), TConOpSys_Variant::Set_Type(), struct_Parameter_Descriptor, struct_Status, TParameter_Descriptor::struct_Storage, struct_Value, TParameter_Descriptor::u32_Element_Count, TParameter_Status::u32_Status, and TParameter_Status::u32_Unsupported_Data_Type.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Connect() [1/12]

VOID TParameter_Base::Connect ( BOOL bool_Value )

Connect parameter to the constant value of BOOL datatype.

Note: None

Parameters

[in] bool_Value - BOOL value

Override: Not allowed

Attention: None

References enum_BOOL, TParameter_Status::Fields, TConOpSys_Variant::Is_Assignable_From(), Set_Type(), TConOpSys_Variant::Set_Value_As_BOOL(), struct_Status, struct_Value, and TParameter_Status::u32_Incompatible_Type_Assigment.

Here is the call graph for this function:

◆ Connect() [2/12]

VOID TParameter_Base::Connect ( F32 f32_Value )

Connect parameter to the constant value of F32 datatype.

Note: None

Parameters

[in] f32_Value - F32 value to connect

Override: Not allowed

Attention: None

References enum_F32, TParameter_Status::Fields, TConOpSys_Variant::Is_Assignable_From(), Set_Type(), TConOpSys_Variant::Set_Value_As_F32(), struct_Status, struct_Value, and TParameter_Status::u32_Incompatible_Type_Assigment.

Here is the call graph for this function:

◆ Connect() [3/12]

VOID TParameter_Base::Connect ( F64 f64_Value )

Connect parameter to the constant value of F64 datatype.

Note: None

Parameters

[in] f64_Value - F64 value to connect

Override: Not allowed

Attention: None

References enum_F64, TParameter_Status::Fields, TConOpSys_Variant::Is_Assignable_From(), Set_Type(), TConOpSys_Variant::Set_Value_As_F64(), struct_Status, struct_Value, and TParameter_Status::u32_Incompatible_Type_Assigment.

Here is the call graph for this function:

◆ Connect() [4/12]

VOID TParameter_Base::Connect ( I16 i16_Value )

Connect parameter to the constant value of I16 datatype.

Note: None

Parameters

[in] i16_Value - I16 value to connect

Override: Not allowed

Attention: None

References enum_I16, TParameter_Status::Fields, TConOpSys_Variant::Is_Assignable_From(), Set_Type(), TConOpSys_Variant::Set_Value_As_I16(), struct_Status, struct_Value, and TParameter_Status::u32_Incompatible_Type_Assigment.

Here is the call graph for this function:

◆ Connect() [5/12]

VOID TParameter_Base::Connect ( I32 i32_Value )

Connect parameter to the constant value of I32 datatype.

Note: None

Parameters

[in] i32_Value - I32 value to connect

Override: Not allowed

Attention: None

References enum_I32, TParameter_Status::Fields, TConOpSys_Variant::Is_Assignable_From(), Set_Type(), TConOpSys_Variant::Set_Value_As_I32(), struct_Status, struct_Value, and TParameter_Status::u32_Incompatible_Type_Assigment.

Here is the call graph for this function:

◆ Connect() [6/12]

VOID TParameter_Base::Connect ( I64 i64_Value )

Connect parameter to the constant value of I64 datatype.

Note: None

Parameters

[in] i64_Value - I64 value to connect

Override: Not allowed

Attention: None

References enum_I64, TParameter_Status::Fields, TConOpSys_Variant::Is_Assignable_From(), Set_Type(), TConOpSys_Variant::Set_Value_As_I64(), struct_Status, struct_Value, and TParameter_Status::u32_Incompatible_Type_Assigment.

Here is the call graph for this function:

◆ Connect() [7/12]

VOID TParameter_Base::Connect ( I8 i8_Value )

Connect parameter to the constant value of I8 datatype.

Note: None

Parameters

[in] i8_Value - I8 value to connect

Override: Not allowed

Attention: None

References enum_I8, TParameter_Status::Fields, TConOpSys_Variant::Is_Assignable_From(), Set_Type(), TConOpSys_Variant::Set_Value_As_I8(), struct_Status, struct_Value, and TParameter_Status::u32_Incompatible_Type_Assigment.

Here is the call graph for this function:

◆ Connect() [8/12]

VOID TParameter_Base::Connect ( TBlock_Output_Connector * object_Connector )

Connect parameter to the function block output connector.

Note: None

Parameters

[in] *object_Connector - Pointer to the function block output connector

Override: Not allowed

Attention: None Connect block output connector to the parameter

References TConOpSys_Variant::Assign(), TParameter_Status::Fields, TBlock_Connector::Get_Variant_Type(), TConOpSys_Variant::Is_Assignable_From(), TBlock_Connector::object_Storage, struct_Status, struct_Value, and TParameter_Status::u32_Incompatible_Type_Assigment.

Here is the call graph for this function:

◆ Connect() [9/12]

VOID TParameter_Base::Connect ( U16 u16_Value )

Connect parameter to the constant value of U16 datatype.

Note: None

Parameters

[in] u16_Value - U16 value to connect

Override: Not allowed

Attention: None

References enum_U16, TParameter_Status::Fields, TConOpSys_Variant::Is_Assignable_From(), Set_Type(), TConOpSys_Variant::Set_Value_As_U16(), struct_Status, struct_Value, and TParameter_Status::u32_Incompatible_Type_Assigment.

Here is the call graph for this function:

◆ Connect() [10/12]

VOID TParameter_Base::Connect ( U32 u32_Value )

Connect parameter to the constant value of U32 datatype.

Note: None

Parameters

[in] u32_Value - U32 value to connect

Override: Not allowed

Attention: None

References enum_U32, TParameter_Status::Fields, TConOpSys_Variant::Is_Assignable_From(), Set_Type(), TConOpSys_Variant::Set_Value_As_U32(), struct_Status, struct_Value, and TParameter_Status::u32_Incompatible_Type_Assigment.

Here is the call graph for this function:

◆ Connect() [11/12]

VOID TParameter_Base::Connect ( U64 u64_Value )

Connect parameter to the constant value of U64 datatype.

Note: None

Parameters

[in] u64_Value - U64 value to connect

Override: Not allowed

Attention: None

References enum_U64, TParameter_Status::Fields, TConOpSys_Variant::Is_Assignable_From(), Set_Type(), TConOpSys_Variant::Set_Value_As_U64(), struct_Status, struct_Value, and TParameter_Status::u32_Incompatible_Type_Assigment.

Here is the call graph for this function:

◆ Connect() [12/12]

VOID TParameter_Base::Connect ( U8 u8_Value )

Connect parameter to the constant value of U8 datatype.

Note: None

Parameters

[in] u8_Value - U8 value to connect

Override: Not allowed

Attention: None

References enum_U8, TParameter_Status::Fields, TConOpSys_Variant::Is_Assignable_From(), Set_Type(), TConOpSys_Variant::Set_Value_As_U8(), struct_Status, struct_Value, and TParameter_Status::u32_Incompatible_Type_Assigment.

Here is the call graph for this function:

◆ Get_Access_Mode()

TParameter_Access_Mode TParameter_Base::Get_Access_Mode ( )

Get parameter actual access mode.

Note: None

Returns: TParameter_Access_Mode - Parameter actual access mode

Override: Not allowed

Attention: None

References access_mode_Unknown, TParameter_Descriptor::enum_Access_Mode, NULL, and struct_Parameter_Descriptor.

Referenced by TParameter_Manager::Calculate_Database_Hash().

Here is the caller graph for this function:

◆ Get_Default_Value()

TConOpSys_Variant TParameter_Base::Get_Default_Value ( )

Get parameter default value as variant.

Note: None

Returns: TConOpSys_Variant - Parameter default value

Override: Not allowed

Attention: None

References TConOpSys_Variant::Get_Type(), TConOpSys_Variant::Set_Type(), TParameter_Descriptor::struct_Default_Value, struct_Parameter_Descriptor, and struct_Value.

Referenced by TParameter_Manager::Calculate_Database_Hash(), TProtocol_ANVILEX_Over_UART::Protocol_Parameter_Information_Request(), and TProtocol_ANVILEX_Over_UART_V2::Protocol_Parameter_Information_Request().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get_Description()

C8 * TParameter_Base::Get_Description ( )

Get parameter description.

Note: Returns pointer to the parameter description string

Returns: C8* - Pointer to the parameter description string

Override: Not allowed

Attention: None

References TParameter_Descriptor::c8_Description, and struct_Parameter_Descriptor.

Referenced by TParameter_Manager::Calculate_Database_Hash(), TProtocol_ANVILEX_Over_UART::Protocol_Parameter_Information_Request(), and TProtocol_ANVILEX_Over_UART_V2::Protocol_Parameter_Information_Request().

Here is the caller graph for this function:

◆ Get_Display_Format()

TParameter_Display_Format TParameter_Base::Get_Display_Format ( )

Get parameter actual display format.

Note: None

Returns: TParameter_Display_Format - Parameter actual display format

Override: Not allowed

Attention: None

References display_format_Native, TParameter_Descriptor::enum_Display_Format, NULL, and struct_Parameter_Descriptor.

Referenced by TParameter_Manager::Calculate_Database_Hash().

Here is the caller graph for this function:

◆ Get_Element_Count()

U32 TParameter_Base::Get_Element_Count ( )

Get parameter element count.

Note: None

Returns: U32 - Parameter element count

Override: Not allowed

Attention: None

References struct_Parameter_Descriptor, and TParameter_Descriptor::u32_Element_Count.

Referenced by TParameter_Manager::Media_Database_Write_Parameter().

Here is the caller graph for this function:

◆ Get_Group_Name()

C8 * TParameter_Base::Get_Group_Name ( )

Get parameter group name.

Note: Returns pointer to the parameter group name string

Returns: C8* - Pointer to the parameter group name string

Override: Not allowed

Attention: None

References TParameter_Descriptor::c8_Group, and struct_Parameter_Descriptor.

Referenced by TParameter_Manager::Calculate_Database_Hash(), TProtocol_ANVILEX_Over_UART::Protocol_Parameter_Information_Request(), and TProtocol_ANVILEX_Over_UART_V2::Protocol_Parameter_Information_Request().

Here is the caller graph for this function:

◆ Get_ID()

U32 TParameter_Base::Get_ID ( )

Get parameter identifier.

Note: None

Returns: U32 - Parameter identifier

Override: Not allowed

Attention: None

References NULL, struct_Parameter_Descriptor, and TParameter_Descriptor::u32_ID.

Referenced by TParameter_Manager::Calculate_Database_Hash(), TCommand_SCOPE::Execute(), TParameter_Manager::Is_Registered_By_ID(), TParameter_Manager::Media_Database_Write_Parameter(), TParameter_SCOPE_CHANNEL_PARAMETER_ID::Pre_Read_Data_Processing(), TParameter_SCOPE_TRIGGER_PARAMETER_ID::Pre_Read_Data_Processing(), TProtocol_ANVILEX_Over_UART::Protocol_Parameter_Information_Request(), TProtocol_ANVILEX_Over_UART_V2::Protocol_Parameter_Information_Request(), TParameter_Manager::Recall_Nonvolatile_Parameter_Values(), TParameter_Manager::Store_Nonvolatile_Parameter_Values(), and TParameter_Manager::Verify_Database().

Here is the caller graph for this function:

◆ Get_Limit_Check_Mode()

TParameter_Boundary_Check_Mode TParameter_Base::Get_Limit_Check_Mode ( )

Get parameter actual boundary check mode.

Note: None

Returns: TParameter_Boundary_Check_Mode - Parameter actual boundary check mode

Override: Not allowed

Attention: None

References check_mode_Unknown, TParameter_Descriptor::enum_Limit_Check_Mode, NULL, and struct_Parameter_Descriptor.

Referenced by TParameter_Manager::Calculate_Database_Hash().

Here is the caller graph for this function:

◆ Get_Maximum_Value()

TConOpSys_Variant TParameter_Base::Get_Maximum_Value ( )

Get parameter maximum value as variant.

Note: None

Returns: TConOpSys_Variant - Parameter maximum value

Override: Not allowed

Attention: None

References TConOpSys_Variant::Get_Type(), TConOpSys_Variant::Set_Type(), TParameter_Descriptor::struct_Maximum_Value, struct_Parameter_Descriptor, and struct_Value.

Referenced by TParameter_Manager::Calculate_Database_Hash(), TProtocol_ANVILEX_Over_UART::Protocol_Parameter_Information_Request(), and TProtocol_ANVILEX_Over_UART_V2::Protocol_Parameter_Information_Request().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get_Media_Storage_Index()

U32 TParameter_Base::Get_Media_Storage_Index ( )

Get parameter actual media storage index.

Note: None

Returns: U32 - Parameter actual media storage index

Override: Not allowed

Attention: None

References u32_Media_Storage_Index.

Referenced by TParameter_Manager::Media_Database_Write_Parameter(), and TParameter_Manager::Store_Nonvolatile_Parameter_Values().

Here is the caller graph for this function:

◆ Get_Minimum_Value()

TConOpSys_Variant TParameter_Base::Get_Minimum_Value ( )

Get parameter minimum value as variant.

Note: None

Returns: TConOpSys_Variant - Parameter minimum value

Override: Not allowed

Attention: None

References TConOpSys_Variant::Get_Type(), TConOpSys_Variant::Set_Type(), TParameter_Descriptor::struct_Minimum_Value, struct_Parameter_Descriptor, and struct_Value.

Referenced by TParameter_Manager::Calculate_Database_Hash(), TProtocol_ANVILEX_Over_UART::Protocol_Parameter_Information_Request(), and TProtocol_ANVILEX_Over_UART_V2::Protocol_Parameter_Information_Request().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get_Nonvolatile_Flag()

BOOL TParameter_Base::Get_Nonvolatile_Flag ( )

Get parameter nonvolatile flag.

Note: None

Returns: BOOL - Parameter nonvolatile flag

Return values

false	- Parameter volatile
true	- Parameter nonvolatile

Override: Not allowed

Attention: None

References TParameter_Descriptor::bool_Nonvolatile, NULL, and struct_Parameter_Descriptor.

Referenced by TParameter_Manager::Calculate_Database_Hash().

Here is the caller graph for this function:

◆ Get_Parameter_Element_Count()

U32 TParameter_Base::Get_Parameter_Element_Count ( )

Get parameter element count by array parameters.

Note: None

Returns: U32 - Parameter element count

Override: Not allowed

Attention: None

References struct_Parameter_Descriptor, and TParameter_Descriptor::u32_Element_Count.

Referenced by TProtocol_ANVILEX_Over_UART::Protocol_Parameter_Information_Request(), and TProtocol_ANVILEX_Over_UART_V2::Protocol_Parameter_Information_Request().

Here is the caller graph for this function:

◆ Get_Parameter_Name()

C8 * TParameter_Base::Get_Parameter_Name ( )

Get parameter name.

Note: Returns pointer to the parameter name string

Returns: C8* - Pointer to the parameter name string

Override: Not allowed

Attention: None

References TParameter_Descriptor::c8_Name, and struct_Parameter_Descriptor.

Referenced by TParameter_Manager::Calculate_Database_Hash(), TProtocol_ANVILEX_Over_UART::Protocol_Parameter_Information_Request(), and TProtocol_ANVILEX_Over_UART_V2::Protocol_Parameter_Information_Request().

Here is the caller graph for this function:

◆ Get_Parameter_Properties()

U32 TParameter_Base::Get_Parameter_Properties ( )

Get parameter properties as U32 value.

Note: None

Returns: U32 - Parameter properties

Override: Not allowed

Attention: None

< Not implemented, must be depricated in the future

< Not implemented, must be set to 1 for correct scope operation

< Not implemented, must be set to 1 for correct paarameter manager operation

< Not implemented, must be set to 1 for correct scope operation

Referenced by TProtocol_ANVILEX_Over_UART::Protocol_Parameter_Information_Request(), and TProtocol_ANVILEX_Over_UART_V2::Protocol_Parameter_Information_Request().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get_PUUID_High()

U64 TParameter_Base::Get_PUUID_High ( )

Get parameter actual PUUID high.

Note: None

Returns: U64 - Parameter actual PUUID high

Override: Not allowed

Attention: None

References struct_Parameter_Descriptor, and TParameter_Descriptor::u64_PUUID_High.

Referenced by TParameter_Manager::Media_Database_Write_Parameter(), and TParameter_Manager::Recall_Nonvolatile_Parameter_Values().

Here is the caller graph for this function:

◆ Get_PUUID_Low()

U64 TParameter_Base::Get_PUUID_Low ( )

Get parameter actual PUUID low.

Note: None

Returns: U64 - Parameter actual PUUID low

Override: Not allowed

Attention: None

References struct_Parameter_Descriptor, and TParameter_Descriptor::u64_PUUID_Low.

Referenced by TParameter_Manager::Media_Database_Write_Parameter(), and TParameter_Manager::Recall_Nonvolatile_Parameter_Values().

Here is the caller graph for this function:

◆ Get_Size()

U32 TParameter_Base::Get_Size ( )

Get parameter value in bytes.

Note: None

Returns: U32 - Parameter value size in byte

Override: Not allowed

Attention: None

References TConOpSys_Variant::Get_Size(), and struct_Value.

Referenced by TABCC_Base::Bus_Transaction(), and TProtocol_MODBUS_Over_UART::Read_Write_Multiple_Registers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get_Storage_Type()

TConOpSys_Variant_Data_Type TParameter_Base::Get_Storage_Type ( )

Get parameter underlying storage data type.

Note: None

Returns: TConOpSys_Variant_Data_Type - Parameter underlying storage data type

Override: Not allowed

Attention: None

References TConOpSys_Variant::Get_Storage_Type(), and struct_Value.

Referenced by TParameter_Manager::Calculate_Database_Hash(), TProtocol_ANVILEX_Over_UART_V2::Protocol_Parameter_Write_Request(), Read_Value_As_Variant(), TSignal_Recorder::Set_Trigger_Source(), and Write_Value_As_Variant().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get_Type()

TConOpSys_Variant_Data_Type TParameter_Base::Get_Type ( )

Get parameter actual datatype.

Note: None

Returns: TConOpSys_Variant_Data_Type - Parameter actual datatype

Override: Not allowed

Attention: None

References TConOpSys_Variant::Get_Type(), and struct_Value.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get_Unit_Name()

C8 * TParameter_Base::Get_Unit_Name ( )

Get parameter units name.

Note: Returns pointer to the parameter units name string

Returns: C8* - Pointer to the parameter units name string

Override: Not allowed

Attention: None

References TParameter_Descriptor::c8_Unit, and struct_Parameter_Descriptor.

Referenced by TParameter_Manager::Calculate_Database_Hash(), TProtocol_ANVILEX_Over_UART::Protocol_Parameter_Information_Request(), and TProtocol_ANVILEX_Over_UART_V2::Protocol_Parameter_Information_Request().

Here is the caller graph for this function:

◆ Get_Value()

TConOpSys_Variant TParameter_Base::Get_Value ( )

Get parameter actual value as variant.

Note: None

Returns: TConOpSys_Variant - Parameter actual value

Override: Not allowed

Attention: None

Todo:: ANVILEX KM: Implement array support

References struct_Value.

Referenced by TProtocol_ANVILEX_Over_UART::Protocol_Parameter_Write_Request(), and TProtocol_ANVILEX_Over_UART_V2::Protocol_Parameter_Write_Request().

Here is the caller graph for this function:

◆ Get_Variant_Data() [1/2]

TConOpSys_Variant_Data TParameter_Base::Get_Variant_Data ( )

Get parameter actual underlaying storage datatype.

Note: None

Returns: TConOpSys_Variant_Data - Parameter actual underlaying storage datatype

Override: Not allowed

Attention: None

Todo:: ANVILEX KM: Implement array support

References TConOpSys_Variant::struct_Data, and struct_Value.

Referenced by TParameter_Manager::Media_Database_Write_Parameter(), TProtocol_MODBUS_Over_UART::Read_Coils(), and TProtocol_MODBUS_Over_UART::Read_Discrete_Inputs().

Here is the caller graph for this function:

◆ Get_Variant_Data() [2/2]

TConOpSys_Variant_Data TParameter_Base::Get_Variant_Data ( U32 u32_Element_Index )

Get parameter actual underlaying storage datatype.

Note: None

Parameters

[in] u32_Element_Index - Element index for

Returns: TConOpSys_Variant_Data - Parameter actual underlaying storage datatype

Override: Not allowed

Attention: None

Todo:: ANVILEX KM: WARNING ==> Rewrite method. ==> Very urgent!!!

References Is_Element_Exists(), TConOpSys_Variant_Data::pvoid_Value, TConOpSys_Variant::struct_Data, and struct_Value.

Here is the call graph for this function:

◆ Init()

virtual BOOL TParameter_Base::Init ( )

pure virtual

Parameter object initialisation method.

Note: None

Returns: BOOL - Initialisation status

Return values

false	- Parameter object initialisation failed
true	- Parameter object initialisation successed without any errors

Override: Requered

Attention: None

Referenced by TParameter_Manager::Register().

Here is the caller graph for this function:

◆ Init_Data_Processing()

BOOL TParameter_Base::Init_Data_Processing ( )

virtual

Parameter initialisation data default virtual processing method.

Note: None

Returns: BOOL - Method execution status

Return values

false	- Parameter initialisation failed with error
true	- Parameter initialisation successed

Override: Optional

Attention: None

◆ Initialise_Array()

BOOL TParameter_Base::Initialise_Array ( )

protected

Initiaise array parameter method.

Note: This method performs internal parameter data storage initialisation

Returns: BOOL - Method execution status

Return values

false	- Parameter value initialisation failed
true	- Parameter value initialisation successed

Override: Not allowed

Attention: None

Todo:: ANVILEX KM: Processing error can be optimised using "bool_Return_Code" direct

Todo:: Set pre-write processing error

Todo:: ANVILEX KM: May be better to check boundary before assign

Todo:: ANVILEX KM: Must be rewritten to support array

Todo:: Set post-write processing error

Todo:: ANVILEX KM: Set depending on initialisation result

References enum_Default_Initialised, TParameter_Status::Fields, Post_Write_Data_Processing(), Pre_Write_Data_Processing(), TConOpSys_Variant::Set_Value_As_Variant(), TParameter_Descriptor::struct_Default_Value, struct_Parameter_Descriptor, struct_Status, struct_Value, true, TParameter_Descriptor::u32_Element_Count, and TParameter_Status::u32_Initialisation_Status.

Referenced by Initialise_Value().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Initialise_Element()

BOOL TParameter_Base::Initialise_Element ( )

protected

Initiaise single element parameter method.

Note: This method performs internal parameter data storage initialisation

Returns: BOOL - Method execution status

Return values

false	- Parameter value initialisation failed
true	- Parameter value initialisation successed

Override: Not allowed

Attention: None

Todo:: Set pre-write processing error

Todo:: ANVILEX KM: May be better to check boundary before assign

Todo:: Set post-write processing error

Todo:: ANVILEX KM: Set depending on initialisation result

References Check_And_Fix_Out_Of_Limit_Value(), enum_Default_Initialised, TParameter_Status::Fields, Post_Write_Data_Processing(), Pre_Write_Data_Processing(), TConOpSys_Variant::Set_Value_As_Variant(), TParameter_Descriptor::struct_Default_Value, struct_Parameter_Descriptor, struct_Status, struct_Value, and TParameter_Status::u32_Initialisation_Status.

Referenced by Initialise_Value().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Initialise_From_Media() [1/2]

VOID TParameter_Base::Initialise_From_Media ( TConOpSys_Variant_Data struct_Variant_Data_Pointer )

Initialise parameter value from the media.

Note: None

Parameters

[in] *struct_Variant_Data_Pointer - Pointer to the initialisation data object

Override: Not allowed

Attention: None

Todo:: ANVILEX KM: Transfer pointer to variant data record for speed up parameter initialisation

Todo:: ANVILEX KM: Check for array support

References Check_And_Fix_Out_Of_Limit_Value(), enum_Initialisation_Error, enum_Media_Initialised, TParameter_Status::Fields, Is_Nonvolatile(), Post_Write_Data_Processing(), Pre_Write_Data_Processing(), TConOpSys_Variant::struct_Data, struct_Status, struct_Value, and TParameter_Status::u32_Initialisation_Status.

Here is the call graph for this function:

◆ Initialise_From_Media() [2/2]

VOID TParameter_Base::Initialise_From_Media	(	TConOpSys_Variant_Data	struct_Variant_Data_Pointer,
		U32	u32_Element_Index
	)

Initialise parameter value from the media.

Note: None

Parameters

[in]	*struct_Variant_Data_Pointer	- Pointer to the initialisation data object
[in]	*u32_Element_Index	- Element index

Override: Not allowed

Attention: None

Todo:: ANVILEX KM: To implement

◆ Initialise_Value()

BOOL TParameter_Base::Initialise_Value ( )

protected

Initiaise parameter value method.

Note: This method performs internal parameter data storage initialisation

Returns: BOOL - Method execution status

Return values

false	- Parameter value initialisation failed
true	- Parameter value initialisation successed

Override: Not allowed

Attention: None

References Get_Type(), Initialise_Array(), Initialise_Element(), Is_ConOpSys_Variant_Data_Type_Array(), Is_ConOpSys_Variant_Data_Type_Element(), Is_ConOpSys_Variant_Data_Type_Pointer(), and true.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Is_Array()

BOOL TParameter_Base::Is_Array ( )

Return parameter array status.

Note: None

Returns: BOOL - Parameter array status

Return values

false	- Parameter not an array.
true	- Parameter is an array.

Override: Not allowed

Attention: None

References struct_Parameter_Descriptor, and TParameter_Descriptor::u32_Element_Count.

Referenced by TParameter_Manager::Media_Database_Write_Parameter(), and TParameter_Manager::Recall_Nonvolatile_Parameter_Values().

Here is the caller graph for this function:

◆ Is_Default_Initialised()

BOOL TParameter_Base::Is_Default_Initialised ( )

Return parameter default value initialisation status.

Note: None

Returns: BOOL - Parameter default value initialisation status

Return values

false	- Parameter not initialised from default value.
true	- Parameter initialised from default value.

Override: Not allowed

Attention: None

References enum_Default_Initialised, TParameter_Status::Fields, struct_Status, and TParameter_Status::u32_Initialisation_Status.

Referenced by TParameter_Manager::Get_Default_Initialised_Parameter_Count().

Here is the caller graph for this function:

◆ Is_Element_Exists()

BOOL TParameter_Base::Is_Element_Exists ( U32 u32_Element_Index )

Return parameter element index exist status.

Note: None

Parameters

[in] u32_Element_Index - Parameter element index

Returns: BOOL - Parameter element index exist status

Return values

false	- Parameter element index not exists.
true	- Parameter element index exists.

Override: Not allowed

Attention: None

Todo:: ANVILEX KM: Verify relation operator. Is index 0 or 1 based

References struct_Parameter_Descriptor, and TParameter_Descriptor::u32_Element_Count.

Referenced by Get_Variant_Data(), and Write_Value_As_Variant().

Here is the caller graph for this function:

◆ Is_ID()

BOOL TParameter_Base::Is_ID ( U32 u32_ID )

Return parameter identifier checking status.

Note: None

Parameters

[in] u32_ID - Parameter identifier

Returns: BOOL - Parameter identifier checking status

Return values

false	- Parameter has other identifier
true	- Parameter has same identifier

Override: Not allowed

Attention: None

References struct_Parameter_Descriptor, and TParameter_Descriptor::u32_ID.

Referenced by TParameter_Manager::Get_Parameter_By_ID(), and TParameter_Manager::Is_Registered_By_ID().

Here is the caller graph for this function:

◆ Is_Initialised()

BOOL TParameter_Base::Is_Initialised ( )

Return parameter initialisation status.

Note: None

Returns: BOOL - Parameter initialisation status

Return values

false	- Parameter not initialised.
true	- Parameter initialised.

Override: Not allowed

Attention: None

References TParameter_Descriptor::bool_Nonvolatile, enum_Default_Initialised, enum_Media_Initialised, false, TParameter_Status::Fields, struct_Parameter_Descriptor, struct_Status, and TParameter_Status::u32_Initialisation_Status.

Referenced by TParameter_Manager::Get_Not_Initialised_Parameter_Count().

Here is the caller graph for this function:

◆ Is_Media_Initialised()

BOOL TParameter_Base::Is_Media_Initialised ( )

Return parameter media value initialisation status.

Note: None

Returns: BOOL - Parameter media value initialisation status

Return values

false	- Parameter not initialised from media value.
true	- Parameter initialised from media value.

Override: Not allowed

Attention: None

References enum_Media_Initialised, TParameter_Status::Fields, struct_Status, and TParameter_Status::u32_Initialisation_Status.

Referenced by TParameter_Manager::Get_Media_Initialised_Parameter_Count().

Here is the caller graph for this function:

◆ Is_Name()

BOOL TParameter_Base::Is_Name ( C8 * c8_Parameter_Name )

Return parameter name checking status.

Note: None

Parameters

[in] *c8_Parameter_Name - Pointer to the null terminated parameter name string

Returns: BOOL - Parameter name checking status

Return values

false	- Parameter has other name
true	- Parameter has same name

Override: Not allowed

Attention: None

References TParameter_Descriptor::c8_Name, and struct_Parameter_Descriptor.

Referenced by TParameter_Manager::Get_Parameter_By_Name(), and TParameter_Manager::Resolve_Parameter_Index_By_Name().

Here is the caller graph for this function:

◆ Is_Nonvolatile()

BOOL TParameter_Base::Is_Nonvolatile ( )

Return nonvalatile parameter status.

Note: None

Returns: BOOL - Nonvalatile parameter status

Return values

false	- Parameter is non nonvolatile.
true	- Parameter is nonvolatile.

Override: Not allowed

Attention: None

References TParameter_Descriptor::bool_Nonvolatile, and struct_Parameter_Descriptor.

Referenced by TParameter_Manager::Get_Nonvolatile_Parameter_Count(), TParameter_Manager::Get_Volatile_Parameter_Count(), Initialise_From_Media(), TParameter_Manager::Media_Database_Write_Parameter(), and TParameter_Manager::Store_Nonvolatile_Parameter_Values().

Here is the caller graph for this function:

◆ Is_Pointer_Type()

BOOL TParameter_Base::Is_Pointer_Type ( )

Return test result for parameter is pointer type.

Note: None

Returns: BOOL - Parameter type test result

Return values

false	- Parameter is non a pointer type
true	- Parameter is a pointer type

Override: Not allowed

Attention: None

References TConOpSys_Variant::Is_Pointer_Type(), and struct_Value.

Referenced by TSignal_Recorder::Set_Trigger_Source().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Is_Quasivolatile()

BOOL TParameter_Base::Is_Quasivolatile ( )

Return quasivalatile parameter status.

Note: None

Returns: BOOL - Quasivalatile parameter status

Return values

false	- Parameter is non quasivolatile.
true	- Parameter is quasivolatile.

Override: Not allowed

Attention: None

References TParameter_Descriptor::enum_Storage_Type, pst_enum_Quasivolatile, and struct_Parameter_Descriptor.

◆ Is_Readable()

BOOL TParameter_Base::Is_Readable ( )

Return parameter readability status.

Note: None

Returns: BOOL - Parameter readability status

Return values

false	- Parameter not readable.
true	- Parameter readable.

Override: Not allowed

Attention: None

References access_mode_Constant, access_mode_Read_Only, access_mode_Read_Write, access_mode_Unknown, access_mode_Write_Only, TParameter_Descriptor::enum_Access_Mode, and struct_Parameter_Descriptor.

Referenced by TProtocol_CANopen_Slave_Over_CAN::SDO_Process().

Here is the caller graph for this function:

◆ Is_Storage_Type()

BOOL TParameter_Base::Is_Storage_Type ( )

Return test result for parameter is storage type.

Note: None

Returns: BOOL - Parameter type test result

Return values

false	- Parameter is non a storage type
true	- Parameter is a storage type

Override: Not allowed

Attention: None

References TConOpSys_Variant::Is_Storage_Type(), and struct_Value.

Referenced by TSignal_Recorder::Set_Trigger_Source().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Is_Store_To_Media_Database()

BOOL TParameter_Base::Is_Store_To_Media_Database ( )

Return store to media parameter status.

Note: None

Returns: BOOL - Store to media parameter status

Return values

false	- Parameter is not to store into media database.
true	- Parameter is to store into media database.

Override: Not allowed

Attention: None

Todo:: ANVILEX: Add processing of the quasivolatile parameters

References TParameter_Descriptor::bool_Nonvolatile, TParameter_Status::Fields, struct_Parameter_Descriptor, struct_Status, and TParameter_Status::u32_Store_To_Media_Request.

Referenced by TParameter_Manager::Execute(), TProtocol_ANVILEX_Over_UART::Protocol_Parameter_Write_Request(), TProtocol_ANVILEX_Over_UART::Terminal_Parameter_Write_Request(), and TProtocol_ANVILEX_Over_UART_V2::Terminal_Parameter_Write_Request().

Here is the caller graph for this function:

◆ Is_Value_Valid()

BOOL TParameter_Base::Is_Value_Valid ( )

Return status of the parameter value validation.

Note: None

Returns: BOOL - Validation status

Return values

false	- Parameter value invalid.
true	- Parameter value valid.

Override: Not allowed

Attention: None

◆ Is_Writable()

BOOL TParameter_Base::Is_Writable ( )

Return parameter writability status.

Note: None

Returns: BOOL - Parameter writability status

Return values

false	- Parameter not writable.
true	- Parameter writable.

Override: Not allowed

Attention: None

References access_mode_Constant, access_mode_Read_Only, access_mode_Read_Write, access_mode_Unknown, access_mode_Write_Only, TParameter_Descriptor::enum_Access_Mode, and struct_Parameter_Descriptor.

Referenced by TProtocol_CANopen_Slave_Over_CAN::SDO_Process().

Here is the caller graph for this function:

◆ operator=()

VOID TParameter_Base::operator= ( TBlock_Output_Connector & object_Connector )

Connect to the output connector.

References TConOpSys_Variant::Assign(), TParameter_Status::Fields, TBlock_Connector::Get_Variant_Type(), TConOpSys_Variant::Is_Assignable_From(), TBlock_Connector::object_Storage, struct_Status, struct_Value, and TParameter_Status::u32_Incompatible_Type_Assigment.

Here is the call graph for this function:

◆ Post_Read_Data_Processing()

BOOL TParameter_Base::Post_Read_Data_Processing ( )

virtual

Parameter post-read data processing default virtual processing method.

Note: None

Returns: BOOL - Method execution status

Return values

false	- Parameter post-read data processing failed with error
true	- Parameter post-read data processing successed

Override: Optional

Attention: None

Referenced by Read_Value_As_Variant().

Here is the caller graph for this function:

◆ Post_Write_Data_Processing()

BOOL TParameter_Base::Post_Write_Data_Processing ( )

virtual

Parameter post-write data processing default virtual processing method.

Note: None

Returns: BOOL - Method execution status

Return values

false	- Parameter post-write data processing failed with error
true	- Parameter post-write data processing successed

Override: Optional

Attention: None

Referenced by Initialise_Array(), Initialise_Element(), Initialise_From_Media(), and Write_Value_As_Variant().

Here is the caller graph for this function:

◆ Pre_Read_Data_Processing()

BOOL TParameter_Base::Pre_Read_Data_Processing ( )

virtual

Parameter pre-read data processing default virtual processing method.

Note: None

Returns: BOOL - Method execution status

Return values

false	- Parameter pre-read data processing failed with error
true	- Parameter pre-read data processing successed

Override: Optional

Attention: None

Referenced by Read_Value_As_Variant().

Here is the caller graph for this function:

◆ Pre_Write_Data_Processing()

BOOL TParameter_Base::Pre_Write_Data_Processing ( )

virtual

Parameter pre-write data processing default virtual processing method.

Note: None

Returns: BOOL - Method execution status

Return values

false	- Parameter pre-write data processing failed with error
true	- Parameter pre-write data processing successed

Override: Optional

Attention: None

Referenced by Initialise_Array(), Initialise_Element(), Initialise_From_Media(), and Write_Value_As_Variant().

Here is the caller graph for this function:

◆ Read_Value_As_BOOL()

BOOL TParameter_Base::Read_Value_As_BOOL ( BOOL * bool_Value )

Read parameter value as boolean value.

Note: None

Parameters

[out] *bool_Value - Pointer to the boolean variable to read

Returns: BOOL - Read status

Return values

false	- Read procedure failed
true	- Read procedure successed without any errors

Override: Not allowed

Attention: None

References TConOpSys_Variant_Data::bool_Value, enum_BOOL, enum_PBOOL, Get_Type(), NULL, TConOpSys_Variant_Data::pbool_Value, TConOpSys_Variant::struct_Data, and struct_Value.

Referenced by TSystem_LED_Base::Decode(), TCommand_APPLICATION::Execute(), TProtocol_MODBUS_Over_UART::Read_Holding_Registers(), TProtocol_MODBUS_Over_UART::Read_Input_Register(), and TProtocol_CANopen_Slave_Over_CAN::SDO_Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Read_Value_As_F32()

BOOL TParameter_Base::Read_Value_As_F32 ( F32 * f32_Value )

Read parameter value as 32-bit floating point value.

Note: None

Parameters

[out] *f32_Value - Pointer to the 32-bit floating point variable to read

Returns: BOOL - Read status

Return values

false	- Read procedure failed
true	- Read procedure successed without any errors

Override: Not allowed

Attention: None

References enum_F32, enum_PF32, TConOpSys_Variant_Data::f32_Value, Get_Type(), NULL, TConOpSys_Variant_Data::pf32_Value, TConOpSys_Variant::struct_Data, and struct_Value.

Referenced by TProtocol_MODBUS_Over_UART::Read_Holding_Registers(), TProtocol_MODBUS_Over_UART::Read_Input_Register(), and TProtocol_CANopen_Slave_Over_CAN::SDO_Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Read_Value_As_F64()

BOOL TParameter_Base::Read_Value_As_F64 ( F64 * f64_Value )

Read parameter value as 64-bit floating point value.

Note: None

Parameters

[out] *f64_Value - Pointer to the 64-bit floating point variable to read

Returns: BOOL - Read status

Return values

false	- Read procedure failed
true	- Read procedure successed without any errors

Override: Not allowed

Attention: None

References enum_F64, enum_PF64, TConOpSys_Variant_Data::f64_Value, Get_Type(), NULL, TConOpSys_Variant_Data::pf64_Value, TConOpSys_Variant::struct_Data, and struct_Value.

Here is the call graph for this function:

◆ Read_Value_As_I16()

BOOL TParameter_Base::Read_Value_As_I16 ( I16 * i16_Value )

Read parameter value as 16-bit signed value.

Note: None

Parameters

[out] *i16_Value - Pointer to the 16-bit signed variable to read

Returns: BOOL - Read status

Return values

false	- Read procedure failed
true	- Read procedure successed without any errors

Override: Not allowed

Attention: None

References enum_I16, enum_PI16, Get_Type(), TConOpSys_Variant_Data::i16_Value, NULL, TConOpSys_Variant_Data::pi16_Value, TConOpSys_Variant::struct_Data, and struct_Value.

Referenced by TProtocol_CANopen_Slave_Over_CAN::SDO_Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Read_Value_As_I32()

BOOL TParameter_Base::Read_Value_As_I32 ( I32 * i32_Value )

Read parameter value as 32-bit signed value.

Note: None

Parameters

[out] *i32_Value - Pointer to the 32-bit signed variable to read

Returns: BOOL - Read status

Return values

false	- Read procedure failed
true	- Read procedure successed without any errors

Override: Not allowed

Attention: None

References enum_I32, enum_PI32, Get_Type(), TConOpSys_Variant_Data::i32_Value, NULL, TConOpSys_Variant_Data::pi32_Value, TConOpSys_Variant::struct_Data, and struct_Value.

Referenced by TProtocol_CANopen_Slave_Over_CAN::SDO_Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Read_Value_As_I64()

BOOL TParameter_Base::Read_Value_As_I64 ( I64 * i64_Value )

Read parameter value as 64-bit signed value.

Note: None

Parameters

[out] *i64_Value - Pointer to the 64-bit signed variable to read

Returns: BOOL - Read status

Return values

false	- Read procedure failed
true	- Read procedure successed without any errors

Override: Not allowed

Attention: None

References enum_I64, enum_PI64, Get_Type(), TConOpSys_Variant_Data::i64_Value, NULL, TConOpSys_Variant_Data::pi64_Value, TConOpSys_Variant::struct_Data, and struct_Value.

Here is the call graph for this function:

◆ Read_Value_As_I8()

BOOL TParameter_Base::Read_Value_As_I8 ( I8 * i8_Value )

Read parameter value as 8-bit signed value.

Note: None

Parameters

[out] *i8_Value - Pointer to the 8-bit signed variable to read

Returns: BOOL - Read status

Return values

false	- Read procedure failed
true	- Read procedure successed without any errors

Override: Not allowed

Attention: None

References enum_I8, enum_PI8, Get_Type(), TConOpSys_Variant_Data::i8_Value, NULL, TConOpSys_Variant_Data::pi8_Value, TConOpSys_Variant::struct_Data, and struct_Value.

Referenced by TProtocol_CANopen_Slave_Over_CAN::SDO_Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Read_Value_As_Raw_Data()

BOOL TParameter_Base::Read_Value_As_Raw_Data ( U8 * u8_Raw_Data )

Read parameter value as raw data value.

Note: None

Parameters

[out] *u8_Raw_Data - Pointer to the data buffer variable to read

Returns: BOOL - Read status

Return values

false	- Read procedure failed
true	- Read procedure successed without any errors

Override: Not allowed

Attention: None

Todo:: ANVILEX: This data types not supported now

Todo:: ANVILEX: This data type not supported now

Todo:: ANVILEX: This data type not supported now

Todo:: ANVILEX: This data type not supported now

Todo:: ANVILEX: This data type not supported now

Referenced by TABCC_Base::Bus_Transaction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Read_Value_As_U16()

BOOL TParameter_Base::Read_Value_As_U16 ( U16 * u16_Value )

Read parameter value as 16-bit unsigned value.

Note: None

Parameters

[out] *u16_Value - Pointer to the 16-bit unsigned variable to read

Returns: BOOL - Read status

Return values

false	- Read procedure failed
true	- Read procedure successed without any errors

Override: Not allowed

Attention: None

References enum_PU16, enum_U16, Get_Type(), NULL, TConOpSys_Variant_Data::pu16_Value, TConOpSys_Variant::struct_Data, struct_Value, and TConOpSys_Variant_Data::u16_Value.

Referenced by TProtocol_MODBUS_Over_UART::Read_Holding_Registers(), TProtocol_MODBUS_Over_UART::Read_Input_Register(), and TProtocol_CANopen_Slave_Over_CAN::SDO_Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Read_Value_As_U32()

BOOL TParameter_Base::Read_Value_As_U32 ( U32 * u32_Value )

Read parameter value as 32-bit unsigned value.

Note: None

Parameters

[out] *u32_Value - Pointer to the 32-bit unsigned variable to read

Returns: BOOL - Read status

Return values

false	- Read procedure failed
true	- Read procedure successed without any errors

Override: Not allowed

Attention: None

References enum_PU32, enum_U32, Get_Type(), NULL, TConOpSys_Variant_Data::pu32_Value, TConOpSys_Variant::struct_Data, struct_Value, and TConOpSys_Variant_Data::u32_Value.

Referenced by TSystem_LED_Base::Decode(), TCommand_APPLICATION::Execute(), TProtocol_MODBUS_Over_UART::Read_Holding_Registers(), TProtocol_MODBUS_Over_UART::Read_Input_Register(), and TProtocol_CANopen_Slave_Over_CAN::SDO_Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Read_Value_As_U64()

BOOL TParameter_Base::Read_Value_As_U64 ( U64 * u64_Value )

Read parameter value as 64-bit unsigned value.

Note: None

Parameters

[out] *u64_Value - Pointer to the 64-bit unsigned variable to read

Returns: BOOL - Read status

Return values

false	- Read procedure failed
true	- Read procedure successed without any errors

Override: Not allowed

Attention: None

References enum_PU64, enum_U64, Get_Type(), NULL, TConOpSys_Variant_Data::pu64_Value, TConOpSys_Variant::struct_Data, struct_Value, and TConOpSys_Variant_Data::u64_Value.

Here is the call graph for this function:

◆ Read_Value_As_U8()

BOOL TParameter_Base::Read_Value_As_U8 ( U8 * u8_Value )

Read parameter value as 8-bit unsigned value.

Note: None

Parameters

[out] *u8_Value - Pointer to the 8-bit unsigned variable to read

Returns: BOOL - Read status

Return values

false	- Read procedure failed
true	- Read procedure successed without any errors

Override: Not allowed

Attention: None

References enum_PU8, enum_U8, Get_Type(), NULL, TConOpSys_Variant_Data::pu8_Value, TConOpSys_Variant::struct_Data, struct_Value, and TConOpSys_Variant_Data::u8_Value.

Referenced by TProtocol_MODBUS_Over_UART::Read_Holding_Registers(), TProtocol_MODBUS_Over_UART::Read_Input_Register(), and TProtocol_CANopen_Slave_Over_CAN::SDO_Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Read_Value_As_Variant() [1/2]

BOOL TParameter_Base::Read_Value_As_Variant ( TConOpSys_Variant * object_Read_Value )

Read parameter value as variant value.

Note: None

Parameters

[out] *object_Read_Value - Pointer to the variant variable to read

Returns: BOOL - Read status

Return values

false	- Read procedure failed
true	- Read procedure successed without any errors

Override: Not allowed

Attention: None

References Post_Read_Data_Processing(), Pre_Read_Data_Processing(), and struct_Value.

Referenced by TProtocol_ANVILEX_Over_UART::Protocol_Parameter_Read_Request(), TProtocol_ANVILEX_Over_UART_V2::Protocol_Parameter_Read_Request(), TProtocol_ANVILEX_Over_UART::Terminal_Parameter_Read_Request(), and TProtocol_ANVILEX_Over_UART_V2::Terminal_Parameter_Read_Request().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Read_Value_As_Variant() [2/2]

BOOL TParameter_Base::Read_Value_As_Variant	(	TConOpSys_Variant *	object_Read_Value,
		U32	u32_Element_Index
	)

Read parameter value as variant value.

Note: None

Parameters

[out]	*object_Read_Value	- Pointer to the variant variable to read
[in]	*u32_Element_Index	- Element index

Returns: BOOL - Read status

Return values

false	- Read procedure failed
true	- Read procedure successed without any errors

Override: Not allowed

Attention: None

Todo:: ANVILEX KM: Test element index

References Get_Storage_Type(), Post_Read_Data_Processing(), Pre_Read_Data_Processing(), TConOpSys_Variant::Set_Type(), struct_Parameter_Descriptor, and TParameter_Descriptor::struct_Storage.

Here is the call graph for this function:

◆ Send_Information()

VOID TParameter_Base::Send_Information ( TProtocol_Base * object_Protocol )

Send parameter information over given protocol.

Note: Override this method if sendig of extended parameter information requered

Parameters

[in] *object_Protocol - Pointer to the protocol object

Returns: None

Override: Optional

Attention: None

Todo:: ANVILEX : ToDo : Compare to NULL is not requered

Todo:: ANVILEX : ToDo : Compare to NULL is not requered

Todo:: ANVILEX : ToDo : Compare to NULL is not requered

References TParameter_Descriptor::c8_Description, TParameter_Descriptor::c8_Group, TParameter_Descriptor::c8_Name, TParameter_Descriptor::c8_Unit, NULL, struct_Parameter_Descriptor, TProtocol_Base::Transmit_New_Line(), and TProtocol_Base::Transmit_String().

Referenced by TCommand_PARAMETERS::Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Set_Media_Storage_Index()

VOID TParameter_Base::Set_Media_Storage_Index ( U32 u32_New_Media_Storage_Index )

Set media storage index.

Note: None

Parameters

[in] u32_New_Media_Storage_Index - New media storage index

Override: Not allowed

Attention: None

References u32_Media_Storage_Index.

Referenced by TParameter_Manager::Media_Database_Write_Parameter(), and TParameter_Manager::Recall_Nonvolatile_Parameter_Values().

Here is the caller graph for this function:

◆ Set_Store_Request()

VOID TParameter_Base::Set_Store_Request ( )

Set parameter value store request.

Note: Calling this method mark parameter for flush into nonvolatile parameter memory

Override: Not allowed

Attention: Parameter flushing works only for volatile and quasivolaatile parameters

References TParameter_Status::Fields, struct_Status, and TParameter_Status::u32_Store_To_Media_Request.

◆ Set_Type()

VOID TParameter_Base::Set_Type ( TConOpSys_Variant_Data_Type enum_Type )

Set new parameter datatype.

Note: None

Parameters

[in] enum_Type - New parameter datatype

Override: Not allowed

Attention: Don't call this method directly to change parameter data type.

References TConOpSys_Variant::Set_Type(), and struct_Value.

Referenced by Connect(), TParameter_SCOPE_CHANNEL_DATA::Pre_Read_Data_Processing(), and TSignal_Recorder::Set_Trigger_Source().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Write_Value_As_BOOL()

BOOL TParameter_Base::Write_Value_As_BOOL ( BOOL bool_New_Value )

Write parameter value from boolean value.

Note: None

Parameters

[in] bool_New_Value - Boolean value to write

Returns: BOOL - Write status

Return values

false	- Write procedure failed
true	- Write procedure successed without any errors

Override: Not allowed

Attention: None

References TConOpSys_Variant::Get_Type(), TConOpSys_Variant::Set_Type(), TConOpSys_Variant::Set_Value_As_BOOL(), struct_Value, and Write_Value_As_Variant().

Referenced by TProtocol_MODBUS_Over_UART::Read_Write_Multiple_Registers(), TProtocol_CANopen_Slave_Over_CAN::SDO_Process(), TProtocol_MODBUS_Over_UART::Write_Multiple_Coils(), TProtocol_MODBUS_Over_UART::Write_Multiple_Registers(), and TProtocol_MODBUS_Over_UART::Write_Single_Coil().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Write_Value_As_F32()

BOOL TParameter_Base::Write_Value_As_F32 ( F32 f32_New_Value )

Write parameter value from F32 value.

Note: None

Parameters

[in] f32_New_Value - F32 value to write

Returns: BOOL - Write status

Return values

false	- Write procedure failed
true	- Write procedure successed without any errors

Override: Not allowed

Attention: None

References TConOpSys_Variant::Get_Type(), TConOpSys_Variant::Set_Type(), TConOpSys_Variant::Set_Value_As_F32(), struct_Value, and Write_Value_As_Variant().

Referenced by TProtocol_CANopen_Slave_Over_CAN::SDO_Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Write_Value_As_F64()

BOOL TParameter_Base::Write_Value_As_F64 ( F64 f64_New_Value )

Write parameter value from F64 value.

Note: None

Parameters

[in] f64_New_Value - F64 value to write

Returns: BOOL - Write status

Return values

false	- Write procedure failed
true	- Write procedure successed without any errors

Override: Not allowed

Attention: None

References TConOpSys_Variant::Get_Type(), TConOpSys_Variant::Set_Type(), TConOpSys_Variant::Set_Value_As_F64(), struct_Value, and Write_Value_As_Variant().

Here is the call graph for this function:

◆ Write_Value_As_Hex_String() [1/2]

BOOL TParameter_Base::Write_Value_As_Hex_String ( C8 * s8_New_Value )

Write parameter value from zero terminated hex string.

Note: None

Parameters

[in] *s8_New_Value - Pointer to the zero terminated hex string

Returns: BOOL - Write status

Return values

false	- Write procedure failed
true	- Write procedure successed without any errors

Override: Not allowed

Attention: None

Todo:: ANVILEX KM: Implement array support.

Todo:: ANVILEX KM: Implement array support.

Todo:: ANVILEX KM: Implement array support.

References TConOpSys_Variant::Get_Type(), TConOpSys_Variant::Set_Type(), TConOpSys_Variant::Set_Value_As_Hex_String(), struct_Value, and Write_Value_As_Variant().

Referenced by TProtocol_ANVILEX_Over_UART::Protocol_Parameter_Write_Request(), and TProtocol_ANVILEX_Over_UART_V2::Protocol_Parameter_Write_Request().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Write_Value_As_Hex_String() [2/2]

BOOL TParameter_Base::Write_Value_As_Hex_String	(	C8 *	s8_New_Value,
		U32	u32_Element_Index
	)

Write parameter element value from zero terminated hex string.

Note: None

Parameters

[in]	*s8_New_Value	- Pointer to the zero terminated hex string
[in]	u32_Element_Index	- Index of the element in array

Returns: BOOL - Write status

Return values

false	- Write procedure failed
true	- Write procedure successed without any errors

Override: Not allowed

Attention: None

References TConOpSys_Variant::Get_Storage_Type(), TConOpSys_Variant::Set_Type(), TConOpSys_Variant::Set_Value_As_Hex_String(), struct_Value, and Write_Value_As_Variant().

Here is the call graph for this function:

◆ Write_Value_As_I16()

BOOL TParameter_Base::Write_Value_As_I16 ( I16 i16_New_Value )

Write parameter value from I16 value.

Note: None

Parameters

[in] i16_New_Value - I16 value to write

Returns: BOOL - Write status

Return values

false	- Write procedure failed
true	- Write procedure successed without any errors

Override: Not allowed

Attention: None

References TConOpSys_Variant::Get_Type(), TConOpSys_Variant::Set_Type(), TConOpSys_Variant::Set_Value_As_I16(), struct_Value, and Write_Value_As_Variant().

Referenced by TProtocol_CANopen_Slave_Over_CAN::SDO_Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Write_Value_As_I32()

BOOL TParameter_Base::Write_Value_As_I32 ( I32 i32_New_Value )

Write parameter value from I32 value.

Note: None

Parameters

[in] i32_New_Value - I32 value to write

Returns: BOOL - Write status

Return values

false	- Write procedure failed
true	- Write procedure successed without any errors

Override: Not allowed

Attention: None

References TConOpSys_Variant::Get_Type(), TConOpSys_Variant::Set_Type(), TConOpSys_Variant::Set_Value_As_I32(), struct_Value, and Write_Value_As_Variant().

Referenced by TProtocol_CANopen_Slave_Over_CAN::SDO_Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Write_Value_As_I64()

BOOL TParameter_Base::Write_Value_As_I64 ( I64 i64_New_Value )

Write parameter value from I64 value.

Note: None

Parameters

[in] i64_New_Value - I64 value to write

Returns: BOOL - Write status

Return values

false	- Write procedure failed
true	- Write procedure successed without any errors

Override: Not allowed

Attention: None

References TConOpSys_Variant::Get_Type(), TConOpSys_Variant::Set_Type(), TConOpSys_Variant::Set_Value_As_I64(), struct_Value, and Write_Value_As_Variant().

Here is the call graph for this function:

◆ Write_Value_As_I8()

BOOL TParameter_Base::Write_Value_As_I8 ( I8 i8_New_Value )

Write parameter value from I8 value.

Note: None

Parameters

[in] i8_New_Value - I8 value to write

Returns: BOOL - Write status

Return values

false	- Write procedure failed
true	- Write procedure successed without any errors

Override: Not allowed

Attention: None

References TConOpSys_Variant::Get_Type(), TConOpSys_Variant::Set_Type(), TConOpSys_Variant::Set_Value_As_I8(), struct_Value, and Write_Value_As_Variant().

Referenced by TProtocol_CANopen_Slave_Over_CAN::SDO_Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Write_Value_As_String()

BOOL TParameter_Base::Write_Value_As_String ( C8 * s8_New_Value )

Write parameter value from zero terminated decimal string.

Note: None

Parameters

[in] *s8_New_Value - Pointer to the zero terminated decimal string

Returns: BOOL - Write status

Return values

false	- Write procedure failed
true	- Write procedure successed without any errors

Override: Not allowed

Attention: None

Todo:: ANVILEX KM: Implement array support.

Todo:: ANVILEX KM: Implement array support.

Todo:: ANVILEX KM: Investigate why boundary checking disabled.

References TConOpSys_Variant::Get_Type(), TConOpSys_Variant::Set_Type(), TConOpSys_Variant::Set_Value_As_Decimal_String(), struct_Value, and Write_Value_As_Variant().

Referenced by TProtocol_ANVILEX_Over_UART::Terminal_Parameter_Write_Request(), and TProtocol_ANVILEX_Over_UART_V2::Terminal_Parameter_Write_Request().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Write_Value_As_U16()

BOOL TParameter_Base::Write_Value_As_U16 ( U16 u16_New_Value )

Write parameter value from U16 value.

Note: None

Parameters

[in] u16_New_Value - U16 value to write

Returns: BOOL - Write status

Return values

false	- Write procedure failed
true	- Write procedure successed without any errors

Override: Not allowed

Attention: None

References TConOpSys_Variant::Get_Type(), TConOpSys_Variant::Set_Type(), TConOpSys_Variant::Set_Value_As_U16(), struct_Value, and Write_Value_As_Variant().

Referenced by TProtocol_CANopen_Slave_Over_CAN::SDO_Process(), and TProtocol_MODBUS_Over_UART::Write_Multiple_Registers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Write_Value_As_U32()

BOOL TParameter_Base::Write_Value_As_U32 ( U32 u32_New_Value )

Write parameter value from U32 value.

Note: None

Parameters

[in] u32_New_Value - U32 value to write

Returns: BOOL - Write status

Return values

false	- Write procedure failed
true	- Write procedure successed without any errors

Override: Not allowed

Attention: None

References TConOpSys_Variant::Get_Type(), TConOpSys_Variant::Set_Type(), TConOpSys_Variant::Set_Value_As_U32(), struct_Value, and Write_Value_As_Variant().

Referenced by TProtocol_CANopen_Slave_Over_CAN::SDO_Process(), and TProtocol_MODBUS_Over_UART::Write_Multiple_Registers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Write_Value_As_U64() [1/2]

BOOL TParameter_Base::Write_Value_As_U64 ( U64 u64_New_Value )

Write parameter value from U64 value.

Note: None

Parameters

[in] u64_New_Value - U64 value to write

Returns: BOOL - Write status

Return values

false	- Write procedure failed
true	- Write procedure successed without any errors

Override: Not allowed

Attention: None

References TConOpSys_Variant::Get_Type(), TConOpSys_Variant::Set_Type(), TConOpSys_Variant::Set_Value_As_U64(), struct_Value, and Write_Value_As_Variant().

Here is the call graph for this function:

◆ Write_Value_As_U64() [2/2]

BOOL TParameter_Base::Write_Value_As_U64	(	U64	u64_New_Value,
		U32	u32_Element_Index
	)

Write parameter value from U64 value.

Note: None

Parameters

[in]	u64_New_Value	- U64 value to write
[in]	u32_Element_Index	- Index of the element in array

Returns: BOOL - Write status

Return values

false	- Write procedure failed
true	- Write procedure successed without any errors

Override: Not allowed

Attention: None

Todo:: ANVILEX KM: Check index

References TConOpSys_Variant::Get_Type(), TConOpSys_Variant::Set_Type(), TConOpSys_Variant::Set_Value_As_U64(), struct_Value, and Write_Value_As_Variant().

Here is the call graph for this function:

◆ Write_Value_As_U8()

BOOL TParameter_Base::Write_Value_As_U8 ( U8 u8_New_Value )

Write parameter value from U8 value.

Note: None

Parameters

[in] u8_New_Value - U8 value to write

Returns: BOOL - Write status

Return values

false	- Write procedure failed
true	- Write procedure successed without any errors

Override: Not allowed

Attention: None

References TConOpSys_Variant::Get_Type(), TConOpSys_Variant::Set_Type(), TConOpSys_Variant::Set_Value_As_U8(), struct_Value, and Write_Value_As_Variant().

Referenced by TProtocol_CANopen_Slave_Over_CAN::SDO_Process(), and TProtocol_MODBUS_Over_UART::Write_Multiple_Registers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Write_Value_As_Variant() [1/2]

BOOL TParameter_Base::Write_Value_As_Variant ( TConOpSys_Variant * object_New_Value )

Write parameter value from variant value.

Note: None

Parameters

[in] *object_New_Value - Pointer to variant value to write

Returns: BOOL - Write status

Return values

false	- Write procedure failed
true	- Write procedure successed without any errors

Override: Not allowed

Attention: None

Todo:: ANVILEX: Enter cricical cection. Disable all interrupts

Todo:: ANVILEX: Exit critical section. Enable all interrupts

References TParameter_Descriptor::bool_Nonvolatile, Check_Limits(), false, TParameter_Status::Fields, TConOpSys_Variant::Get_Type(), Get_Type(), NULL, Post_Write_Data_Processing(), Pre_Write_Data_Processing(), struct_Parameter_Descriptor, struct_Status, struct_Value, true, and TParameter_Status::u32_Store_To_Media_Request.

Referenced by TProtocol_ANVILEX_Master_Over_UART::Execute(), TParameter_Manager::Recall_Nonvolatile_Parameter_Values(), Write_Value_As_BOOL(), Write_Value_As_F32(), Write_Value_As_F64(), Write_Value_As_Hex_String(), Write_Value_As_I16(), Write_Value_As_I32(), Write_Value_As_I64(), Write_Value_As_I8(), Write_Value_As_String(), Write_Value_As_U16(), Write_Value_As_U32(), Write_Value_As_U64(), and Write_Value_As_U8().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Write_Value_As_Variant() [2/2]

BOOL TParameter_Base::Write_Value_As_Variant	(	TConOpSys_Variant *	object_New_Value,
		U32	u32_Element_Index
	)

Write parameter element value from variant value.

Note: None

Parameters

[in]	*object_New_Value	- Pointer to variant value to write
[in]	u32_Element_Index	- Index of the element in array

Returns: BOOL - Write status

Return values

false	- Write procedure failed
true	- Write procedure successed without any errors

Override: Not allowed

Attention: None

Todo:: ANVILEX: Enter cricical cection. Disable all interrupts

Todo:: ANVILEX: Exit critical section. Enable all interrupts

References TParameter_Descriptor::bool_Nonvolatile, Check_Limits(), false, TParameter_Status::Fields, Get_Storage_Type(), TConOpSys_Variant::Get_Type(), Is_Element_Exists(), NULL, Post_Write_Data_Processing(), Pre_Write_Data_Processing(), TConOpSys_Variant::struct_Data, struct_Parameter_Descriptor, struct_Status, TParameter_Descriptor::struct_Storage, true, and TParameter_Status::u32_Store_To_Media_Request.

Here is the call graph for this function:

Member Data Documentation

◆ struct_Parameter_Descriptor

TParameter_Descriptor* TParameter_Base::struct_Parameter_Descriptor = (TParameter_Descriptor*)NULL

protected

◆ struct_Status

TParameter_Status TParameter_Base::struct_Status = { .u32_Status = (U32)0x00000000 }

private

Parameter status.

Referenced by Clear_Store_Request(), Configure(), Connect(), Initialise_Array(), Initialise_Element(), Initialise_From_Media(), Is_Default_Initialised(), Is_Initialised(), Is_Media_Initialised(), Is_Store_To_Media_Database(), operator=(), Set_Store_Request(), and Write_Value_As_Variant().

◆ struct_Value

TConOpSys_Variant TParameter_Base::struct_Value

Parameter value storage variable.

Todo:: Make struct_Value variable protected or private.

◆ u32_Media_Storage_Index

U32 TParameter_Base::u32_Media_Storage_Index = (U32)0xFFFFFFFF

private

Media storage index.

Referenced by Clear_Media_Storage_Index(), Get_Media_Storage_Index(), and Set_Media_Storage_Index().

The documentation for this class was generated from the following files:

ConOpSys/Parameters/Parameter_Base.h
ConOpSys/Parameters/Parameter_Base.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TParameter_Base()

Member Function Documentation

◆ Append_Hash_Data()

◆ Check_And_Fix_Out_Of_Limit_Value()

◆ Check_And_Fix_Parameter_Boundary_Processing()

◆ Check_Limits()

◆ Check_Parameter_Boundary_Processing()

◆ Clear_Media_Storage_Index()

◆ Clear_Store_Request()

◆ Clear_Value()

◆ Configure()

◆ Connect() [1/12]

◆ Connect() [2/12]

◆ Connect() [3/12]

◆ Connect() [4/12]

◆ Connect() [5/12]

◆ Connect() [6/12]

◆ Connect() [7/12]

◆ Connect() [8/12]

◆ Connect() [9/12]

◆ Connect() [10/12]

◆ Connect() [11/12]

◆ Connect() [12/12]

◆ Get_Access_Mode()

◆ Get_Default_Value()

◆ Get_Description()

◆ Get_Display_Format()

◆ Get_Element_Count()

◆ Get_Group_Name()

◆ Get_ID()

◆ Get_Limit_Check_Mode()

◆ Get_Maximum_Value()

◆ Get_Media_Storage_Index()

◆ Get_Minimum_Value()

◆ Get_Nonvolatile_Flag()

◆ Get_Parameter_Element_Count()

◆ Get_Parameter_Name()

◆ Get_Parameter_Properties()

◆ Get_PUUID_High()

◆ Get_PUUID_Low()

◆ Get_Size()

◆ Get_Storage_Type()

◆ Get_Type()

◆ Get_Unit_Name()

◆ Get_Value()

◆ Get_Variant_Data() [1/2]

◆ Get_Variant_Data() [2/2]

◆ Init()

◆ Init_Data_Processing()

◆ Initialise_Array()

◆ Initialise_Element()

◆ Initialise_From_Media() [1/2]

◆ Initialise_From_Media() [2/2]

◆ Initialise_Value()

◆ Is_Array()

◆ Is_Default_Initialised()

◆ Is_Element_Exists()

◆ Is_ID()

◆ Is_Initialised()

◆ Is_Media_Initialised()

◆ Is_Name()

◆ Is_Nonvolatile()

◆ Is_Pointer_Type()

◆ Is_Quasivolatile()

◆ Is_Readable()

◆ Is_Storage_Type()

◆ Is_Store_To_Media_Database()

◆ Is_Value_Valid()

◆ Is_Writable()

◆ operator=()

◆ Post_Read_Data_Processing()

◆ Post_Write_Data_Processing()