Extention board driver block P019.11 (KG3 MOD) class definition. More...

#include <P019_11_KG3_MOD.h>

Inheritance diagram for TP019_11_KG3_MOD:

Collaboration diagram for TP019_11_KG3_MOD:

Classes
union	TControl_Register
	Control register structure. More...

struct	TP019_11_KG3_MOD_Registers
	Register structure for I/O access. More...

struct	TStatus_Register
	Status register structure. More...

Public Member Functions
	TP019_11_KG3_MOD ()
	Function block class constructor method. More...

virtual	~TP019_11_KG3_MOD ()
	Function block class desstructor method. More...

VOID	Map (TP019_11_KG3_MOD_Registers *struct_Registers_Base_Address)
	Hardware mapping method. More...

virtual VOID	Init ()
	Function block initialisation method. More...

virtual VOID	Execute ()
	Function block execution method. More...

virtual VOID	Send_Information (TProtocol_Base *object_Protocol)
	Send information about modulator board driver over communication link protocol. More...

Public Member Functions inherited from TFunction_Block_Base
	TFunction_Block_Base (U32 u32_Function_ID)
	Class constructor method. More...

virtual	~TFunction_Block_Base ()
	Class destructor method. More...

VOID	Connect ()
	Function block connect method. More...

VOID	Init ()
	Function block initialisation method. More...

virtual VOID	Done ()
	Function block finalisation method. More...

virtual VOID	Update ()
	Update parameters at runtime method. More...

virtual VOID	Trip ()
	Function block trip method. More...

U32	Get_Function_Block_ID ()
	Get function block dentifier. More...

VOID	Set_Initialisation_Error ()
	Set function block initialisation error. More...

BOOL	Is_Initialisation_Error ()
	Return function block initialisation error status. More...

VOID	Append_Connected_Status (BOOL *bool_Connected_Status)
	Append interconnection status of the function block. More...

BOOL	Is_Connected ()
	Returns status of the function block interconnection. More...

BOOL	Is_Initialised ()
	Returns status of the function block interconnection. More...

BOOL	Get_Input_Connector (U32 u32_Connector_Index, TBlock_Input_Connector **object_Input_Connector)
	Get pointer to the input connector. More...

BOOL	Get_Output_Connector (U32 u32_Connector_Index, TBlock_Output_Connector **object_Output_Connector)
	Get pointer to the output connector. More...

TFunction_Block_Status	Get_Status ()
	Get function block status method. More...

__fastcall	TBlock_Template (TComponent Owner, TList Storage)

__fastcall	~TBlock_Template ()

void __fastcall	CreateBlock ()

virtual void __fastcall	Paint ()

virtual bool __fastcall	PropertiesDialog ()

virtual void __fastcall	SaveToProjectFile (TMemIniFile *ProjectFile, AnsiString ParentSection)

virtual void __fastcall	LoadFromProjectFile (TMemIniFile *ProjectFile, AnsiString ParentSection)

virtual void __fastcall	SwapBlocks ()

virtual void __fastcall	RepaintAllBlocks ()

VOID __fastcall	Load_Block_From_List (TStringList object_File_Source_CPP, TStringList object_File_Source_H)

VOID __fastcall	Get_SQL_Queries (TStringList *object_SQL_Queries)

Public Attributes
TBlock_Input_Connector	object_bool_Enable
	Enable modulator. More...

TBlock_Input_Connector	object_u16_Dead_Time
	Modulator dead time. More...

TBlock_Input_Connector	object_f32_Frequency
	Frequency setpoint. More...

TBlock_Input_Connector	object_f32_Duty
	Duty setpoint. More...

TBlock_Input_Connector	object_f32_Temperature_Gain
	Temperature gain calibration. More...

TBlock_Input_Connector	object_f32_Temperature_Offset
	Temperature offset calibration. More...

TBlock_Input_Connector	object_f32_Positive_Current_Magnitude

TBlock_Input_Connector	object_f32_Negative_Current_Magnitude

TBlock_Output_Connector	object_u16_Temperature_Raw_Data
	Actual modulator temperature as raw data. More...

TBlock_Output_Connector	object_f32_Temperature
	Actual modulator temperature in gradus celsius. More...

Public Attributes inherited from TFunction_Block_Base
TList *	StorageOfBlocks = (TList*)NULL

int	BlockID

int	InputConnectorsCount

int	OutputConnectorsCount

TList *	StorageOfInputConnectors

TList *	StorageOfOutputConnectors

TCore_Template *	Core

TFooter_Template *	Footer

TParameters_Template *	Parameters

bool	AutoSize

Graphics::TBitmap *	Icon

__property TNotifyEvent	OnInputConnectorSelected = { read = FOnInputConnectorSelected, write = FOnInputConnectorSelected }

__property TNotifyEvent	OnOutputConnectorSelected = { read = FOnOutputConnectorSelected, write = FOnOutputConnectorSelected }

__property TNotifyEvent	OnCoreSelected = { read = FOnCoreSelected, write = FOnCoreSelected }

__property TNotifyEvent	OnModified = { read = FModified, write = FModified }

__property TNotifyEvent	OnNeedToUpdate = { read = FNeedToUpdate, write = FNeedToUpdate }

__property TResolveConnectorAddressEvent	OnResolveConnectorAddress = { read = FOnResolveConnectorAddress, write = FOnResolveConnectorAddress }

__property AnsiString	Label = { read = FLabel, write = FLabel }

__property BOOL	Border = { read = FBorder, write = FBorder, default = true }

__property BOOL	Selected = { read = FSelected, write = SetSelectedFlag, default = false }

__property BOOL	Flipped = { read = FFlipped, write = SetFlippedFlag, default = false }

Private Attributes
TNTC	object_NTC
	NTC sensor object. More...

volatile TP019_11_KG3_MOD_Registers *	struct_Registers
	FPGA mapped registers. More...

F64	f64_Cycles
	Clock cycle per period as float point number. More...

F64	f64_On_Cycles
	Clock cycle per on state as float point number. More...

F64	f64_Off_Cycles
	Clock cycle per off state as float point number. More...

U32	u32_Cycles

U32	u32_On_Cycles

U16	u16_On_Cycles_L

U16	u16_On_Cycles_H

U32	u32_Off_Cycles

U16	u16_Off_Cycles_L

U16	u16_Off_Cycles_H

F32	f32_Temperature
	Temperature value. More...

Additional Inherited Members
Protected Member Functions inherited from TFunction_Block_Base
VOID	Update_Connected_Status (BOOL bool_New_Connected_Status)
	Updates function block interconnection status. More...

VOID	Create_Event (U32 u32_Event_ID)
	Create event method. More...

void __fastcall	SetSelectedFlag (bool Value)

void __fastcall	SetFlippedFlag (bool Value)

virtual void __fastcall	SetNamesOfConnectors ()

void __fastcall	CorePaint (TObject *Sender)

Protected Attributes inherited from TFunction_Block_Base
TNotifyEvent	FModified

TNotifyEvent	FNeedToUpdate

TNotifyEvent	FOnInputConnectorSelected

TNotifyEvent	FOnOutputConnectorSelected

TNotifyEvent	FOnCoreSelected

TResolveConnectorAddressEvent	FOnResolveConnectorAddress

AnsiString	FLabel = ""
	Function block label of the core string. More...

BOOL	FBorder = (BOOL)true
	Function block border status. More...

BOOL	FSelected = (BOOL)false
	Function block seleted status. More...

BOOL	FFlipped = (BOOL)false
	Function block flipped status. More...

BOOL	LockedMode = (BOOL)false

BOOL	DobbleClicked = (BOOL)false

U32	u32_Locked_Position_X = (U32)0

U32	u32_Locked_Position_Y = (U32)0

Detailed Description

Extention board driver block P019.11 (KG3 MOD) class definition.

Constructor & Destructor Documentation

◆ TP019_11_KG3_MOD()

TP019_11_KG3_MOD::TP019_11_KG3_MOD ( )

Function block class constructor method.

Note: None

Override: Not allowed

Attention: Don't call this method directly.

References false, NULL, object_bool_Enable, object_f32_Duty, object_f32_Frequency, object_f32_Negative_Current_Magnitude, object_f32_Positive_Current_Magnitude, object_f32_Temperature, object_f32_Temperature_Gain, object_f32_Temperature_Offset, object_u16_Dead_Time, object_u16_Temperature_Raw_Data, TBlock_Input_Connector::Set_Type_BOOL(), TBlock_Connector::Set_Type_F32(), TBlock_Input_Connector::Set_Type_F32(), TBlock_Connector::Set_Type_U16(), TBlock_Input_Connector::Set_Type_U16(), and struct_Registers.

Here is the call graph for this function:

◆ ~TP019_11_KG3_MOD()

TP019_11_KG3_MOD::~TP019_11_KG3_MOD ( )

virtual

Function block class desstructor method.

Note: None

Override: Not allowed

Attention: Don't call this method directly.

Member Function Documentation

◆ Execute()

VOID TP019_11_KG3_MOD::Execute ( )

virtual

Function block execution method.

Note: None

Override: Not allowed

Attention: None

Implements TFunction_Block_Base.

References TP019_11_KG3_MOD::TControl_Register::bit1_Enable_Driver, TP019_11_KG3_MOD::TControl_Register::bit1_Enable_Modulator, TP019_11_KG3_MOD::TControl_Register::bit1_Enable_Output_T1, TP019_11_KG3_MOD::TControl_Register::bit1_Enable_Output_T2, TP019_11_KG3_MOD::TControl_Register::bit1_Enable_Output_T3, TP019_11_KG3_MOD::TControl_Register::bit1_Enable_Output_T4, TNTC::enum_10000_Ohm, TNTC::enum_B25_100_3988, f32_Temperature, TConOpSys_Variant_Data::f32_Value, f64_Cycles, f64_Off_Cycles, f64_On_Cycles, object_bool_Enable, object_f32_Duty, object_f32_Frequency, object_f32_Negative_Current_Magnitude, object_f32_Positive_Current_Magnitude, object_f32_Temperature, object_f32_Temperature_Gain, object_f32_Temperature_Offset, object_NTC, TBlock_Input_Connector::object_Pointer, TBlock_Connector::object_Storage, object_u16_Dead_Time, object_u16_Temperature_Raw_Data, TConOpSys_Variant_Data::pbool_Value, TConOpSys_Variant_Data::pf32_Value, TConOpSys_Variant_Data::pu16_Value, Split_U32(), TConOpSys_Variant::struct_Data, struct_Registers, TNTC::Time_To_Temperature(), true, TP019_11_KG3_MOD::TP019_11_KG3_MOD_Registers::u16_Control_Register, TP019_11_KG3_MOD::TP019_11_KG3_MOD_Registers::u16_Dead_Time, TP019_11_KG3_MOD::TP019_11_KG3_MOD_Registers::u16_Off_Cycles_H, u16_Off_Cycles_H, TP019_11_KG3_MOD::TP019_11_KG3_MOD_Registers::u16_Off_Cycles_L, u16_Off_Cycles_L, TP019_11_KG3_MOD::TP019_11_KG3_MOD_Registers::u16_On_Cycles_H, u16_On_Cycles_H, TP019_11_KG3_MOD::TP019_11_KG3_MOD_Registers::u16_On_Cycles_L, u16_On_Cycles_L, TP019_11_KG3_MOD::TControl_Register::u16_Raw_Data, TP019_11_KG3_MOD::TP019_11_KG3_MOD_Registers::u16_Temperature, TConOpSys_Variant_Data::u16_Value, u32_Cycles, U32_MAX, u32_Off_Cycles, and u32_On_Cycles.

Here is the call graph for this function:

◆ Init()

VOID TP019_11_KG3_MOD::Init ( )

virtual

Function block initialisation method.

Note: None

Override: Not allowed

Attention: None

References TBlock_Input_Connector::Append_Connected_Status(), object_bool_Enable, object_f32_Duty, object_f32_Frequency, object_f32_Negative_Current_Magnitude, object_f32_Positive_Current_Magnitude, object_f32_Temperature_Gain, object_f32_Temperature_Offset, object_u16_Dead_Time, struct_Registers, TP019_11_KG3_MOD::TP019_11_KG3_MOD_Registers::u16_Control_Register, TP019_11_KG3_MOD::TP019_11_KG3_MOD_Registers::u16_Dead_Time, TP019_11_KG3_MOD::TP019_11_KG3_MOD_Registers::u16_Off_Cycles_H, TP019_11_KG3_MOD::TP019_11_KG3_MOD_Registers::u16_Off_Cycles_L, TP019_11_KG3_MOD::TP019_11_KG3_MOD_Registers::u16_On_Cycles_H, TP019_11_KG3_MOD::TP019_11_KG3_MOD_Registers::u16_On_Cycles_L, and TFunction_Block_Base::Update_Connected_Status().

Here is the call graph for this function:

◆ Map()

VOID TP019_11_KG3_MOD::Map ( TP019_11_KG3_MOD_Registers * struct_Registers_Base_Address )

Hardware mapping method.

Note: None

Parameters

[in] *struct_Registers_Base_Address - Base adress to register structure mapping

Override: Not allowed

Attention: none

References struct_Registers.

◆ Send_Information()

VOID TP019_11_KG3_MOD::Send_Information ( TProtocol_Base * object_Protocol )

virtual

Send information about modulator board driver over communication link protocol.

Note: This method sends information about modulator board driver over specified communication link protocol.

Parameters

[in] *object_Protocol - Pointer to the communication link protocol

Returns: None

Override: Optional

Attention: None

Reimplemented from TFunction_Block_Base.

References f64_Cycles, object_bool_Enable, object_f32_Duty, object_f32_Frequency, object_f32_Temperature, object_u16_Dead_Time, object_u16_Temperature_Raw_Data, struct_Registers, TProtocol_Base::Transmit_Connector_Value_As_Boolean(), TProtocol_Base::Transmit_Connector_Value_As_Decimal(), TProtocol_Base::Transmit_Connector_Value_As_Hex(), TProtocol_Base::Transmit_F64_Value_As_Decimal(), TProtocol_Base::Transmit_String(), TProtocol_Base::Transmit_U16_Value_As_Hex(), TProtocol_Base::Transmit_U32_Value_As_Hex(), u16_Off_Cycles_H, u16_Off_Cycles_L, u16_On_Cycles_H, u16_On_Cycles_L, TP019_11_KG3_MOD::TP019_11_KG3_MOD_Registers::u16_Unit_ID_H, TP019_11_KG3_MOD::TP019_11_KG3_MOD_Registers::u16_Unit_ID_L, u32_Cycles, u32_Off_Cycles, and u32_On_Cycles.

Here is the call graph for this function:

Member Data Documentation

◆ f32_Temperature

F32 TP019_11_KG3_MOD::f32_Temperature

private

Temperature value.

Referenced by Execute().

◆ f64_Cycles

F64 TP019_11_KG3_MOD::f64_Cycles

private

Clock cycle per period as float point number.

Referenced by Execute(), and Send_Information().

◆ f64_Off_Cycles

F64 TP019_11_KG3_MOD::f64_Off_Cycles

private

Clock cycle per off state as float point number.

Referenced by Execute().

◆ f64_On_Cycles

F64 TP019_11_KG3_MOD::f64_On_Cycles

private

Clock cycle per on state as float point number.

Referenced by Execute().

◆ object_bool_Enable

TBlock_Input_Connector TP019_11_KG3_MOD::object_bool_Enable

Enable modulator.

Referenced by Execute(), Init(), Send_Information(), and TP019_11_KG3_MOD().

◆ object_f32_Duty

TBlock_Input_Connector TP019_11_KG3_MOD::object_f32_Duty

Duty setpoint.

Referenced by Execute(), Init(), Send_Information(), and TP019_11_KG3_MOD().

◆ object_f32_Frequency

TBlock_Input_Connector TP019_11_KG3_MOD::object_f32_Frequency

Frequency setpoint.

Referenced by Execute(), Init(), Send_Information(), and TP019_11_KG3_MOD().

◆ object_f32_Negative_Current_Magnitude

TBlock_Input_Connector TP019_11_KG3_MOD::object_f32_Negative_Current_Magnitude

Referenced by Execute(), Init(), and TP019_11_KG3_MOD().

◆ object_f32_Positive_Current_Magnitude

TBlock_Input_Connector TP019_11_KG3_MOD::object_f32_Positive_Current_Magnitude

Referenced by Execute(), Init(), and TP019_11_KG3_MOD().

◆ object_f32_Temperature

TBlock_Output_Connector TP019_11_KG3_MOD::object_f32_Temperature

Actual modulator temperature in gradus celsius.

Referenced by Execute(), Send_Information(), and TP019_11_KG3_MOD().

◆ object_f32_Temperature_Gain

TBlock_Input_Connector TP019_11_KG3_MOD::object_f32_Temperature_Gain

Temperature gain calibration.

Referenced by Execute(), Init(), and TP019_11_KG3_MOD().

◆ object_f32_Temperature_Offset

TBlock_Input_Connector TP019_11_KG3_MOD::object_f32_Temperature_Offset

Temperature offset calibration.

Referenced by Execute(), Init(), and TP019_11_KG3_MOD().

◆ object_NTC

TNTC TP019_11_KG3_MOD::object_NTC

private

NTC sensor object.

Referenced by Execute().

◆ object_u16_Dead_Time

TBlock_Input_Connector TP019_11_KG3_MOD::object_u16_Dead_Time

Modulator dead time.

Referenced by Execute(), Init(), Send_Information(), and TP019_11_KG3_MOD().

◆ object_u16_Temperature_Raw_Data

TBlock_Output_Connector TP019_11_KG3_MOD::object_u16_Temperature_Raw_Data

Actual modulator temperature as raw data.

Referenced by Execute(), Send_Information(), and TP019_11_KG3_MOD().

◆ struct_Registers

volatile TP019_11_KG3_MOD_Registers* TP019_11_KG3_MOD::struct_Registers

private

FPGA mapped registers.

Referenced by Execute(), Init(), Map(), Send_Information(), and TP019_11_KG3_MOD().

◆ u16_Off_Cycles_H

U16 TP019_11_KG3_MOD::u16_Off_Cycles_H

private

Referenced by Execute(), and Send_Information().

◆ u16_Off_Cycles_L

U16 TP019_11_KG3_MOD::u16_Off_Cycles_L

private

Referenced by Execute(), and Send_Information().

◆ u16_On_Cycles_H

U16 TP019_11_KG3_MOD::u16_On_Cycles_H

private

Referenced by Execute(), and Send_Information().

◆ u16_On_Cycles_L

U16 TP019_11_KG3_MOD::u16_On_Cycles_L

private

Referenced by Execute(), and Send_Information().

◆ u32_Cycles

U32 TP019_11_KG3_MOD::u32_Cycles

private

Referenced by Execute(), and Send_Information().

◆ u32_Off_Cycles

U32 TP019_11_KG3_MOD::u32_Off_Cycles

private

Referenced by Execute(), and Send_Information().

◆ u32_On_Cycles

U32 TP019_11_KG3_MOD::u32_On_Cycles

private

Referenced by Execute(), and Send_Information().

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

ConOpSys/Hardware/P019_11_KG3_MOD/P019_11_KG3_MOD.h
ConOpSys/Hardware/P019_11_KG3_MOD/P019_11_KG3_MOD.cpp

Classes

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TP019_11_KG3_MOD()

◆ ~TP019_11_KG3_MOD()

Member Function Documentation

◆ Execute()

◆ Init()

◆ Map()

◆ Send_Information()

Member Data Documentation

◆ f32_Temperature

◆ f64_Cycles

◆ f64_Off_Cycles

◆ f64_On_Cycles

◆ object_bool_Enable

◆ object_f32_Duty

◆ object_f32_Frequency

◆ object_f32_Negative_Current_Magnitude

◆ object_f32_Positive_Current_Magnitude

◆ object_f32_Temperature

◆ object_f32_Temperature_Gain

◆ object_f32_Temperature_Offset

◆ object_NTC

◆ object_u16_Dead_Time

◆ object_u16_Temperature_Raw_Data

◆ struct_Registers

◆ u16_Off_Cycles_H

◆ u16_Off_Cycles_L

◆ u16_On_Cycles_H

◆ u16_On_Cycles_L

◆ u32_Cycles

◆ u32_Off_Cycles

◆ u32_On_Cycles