SCOPE_ID parameter class. More...
#include <Parameter_SCOPE_ID.h>
Inheritance diagram for TParameter_SCOPE_ID:
Collaboration diagram for TParameter_SCOPE_ID:
Public Member Functions | |
| virtual BOOL | Init () |
| Parameter initialisation. More... | |
 Public Member Functions inherited from TParameter_Base | |
| TParameter_Base () | |
| Parameter base class constructor 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... | |
Additional Inherited Members | |
| Public Attributes inherited from TParameter_Base | |
| TConOpSys_Variant | struct_Value |
| Parameter value storage variable. More... | |
| Protected Member Functions inherited from TParameter_Base | |
| 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 inherited from TParameter_Base | |
| TParameter_Descriptor * | struct_Parameter_Descriptor = (TParameter_Descriptor*)NULL |
| Pointer to the parameter descriptor structure. More... | |
Detailed Description
SCOPE_ID parameter class.
Member Function Documentation
◆ Init()
|
virtual |
Parameter initialisation.
- Returns
- Status code
- Return values
-
true Success false Error
- Note
- None
Implements TParameter_Base.
References TParameter_Base::Configure(), TParameter_Base::Initialise_Value(), and struct_Parameter_Descriptor_SCOPE_ID.
Here is the call graph for this function:
The documentation for this class was generated from the following files:
- ConOpSys/Parameters/Scope/Parameter_SCOPE_ID.h
- ConOpSys/Parameters/Scope/Parameter_SCOPE_ID.cpp
