DC bus board P015.05 V1.0 class. More...

#include <KG3_DCBIO_V2.h>

Inheritance diagram for TKG3_DCBIO_V2:

Collaboration diagram for TKG3_DCBIO_V2:

Classes
union	TChannels
	Structure for bit parsing. More...

struct	TKG3_DCBIO_V2_Registers
	Register structure for generic access. More...

union	TStatus

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

	~TKG3_DCBIO_V2 ()
	Function block class desstructor method. More...

VOID	Map (TKG3_DCBIO_V2_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	Execute_Outputs ()
	Function block outputs execution method. More...

virtual VOID	Execute_Inputs ()
	Function block inputs execution method. More...

virtual VOID	Send_Information (TProtocol_Base *object_Protocol)
	Send information about 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_f32_Analog_Input_Full_Scale
	Analog input channel fill scale value. Also used for channel total gain adjustment. More...

TBlock_Input_Connector	object_f32_Analog_Input_Offset
	Analog input channel offset. More...

TBlock_Input_Connector	object_bool_Ballast_Control
	Ballast status. More...

TBlock_Input_Connector	object_f32_DC_BUS_Offset
	DC BUS offset. More...

TBlock_Input_Connector	object_f32_DC_BUS_GAIN
	DC BUS gain. More...

TBlock_Input_Connector	object_f32_Ballast_Setpoint_1
	Ballast setpoint 1. More...

TBlock_Input_Connector	object_f32_Ballast_Setpoint_2
	Ballast setpoint 2. More...

TBlock_Input_Connector	object_bool_Precharge_Enable
	Precharge enable. More...

TBlock_Input_Connector	object_bool_Emergency_Stop
	Precharge enable. More...

TBlock_Output_Connector	object_f32_Analog_Input_Data
	Analog input data block output connector. More...

TBlock_Output_Connector	object_bool_Hardware_Error
	Critical hardware error flag. More...

TBlock_Output_Connector	object_bool_Hardware_Limit_Error
	Hardware limit reached error flag. More...

TBlock_Output_Connector	object_bool_Software_Limit_Error
	Software limit reached error flag. More...

TBlock_Output_Connector	object_bool_Ballast_Error
	Ballast status signal. More...

TBlock_Output_Connector	object_f32_DC_BUS_Voltage
	DC BUS voltage. More...

TBlock_Output_Connector	object_bool_Precharge_Fault
	Precharge fault. More...

TBlock_Output_Connector	object_bool_Ballast_Fault_1
	Ballast fault 1. More...

TBlock_Output_Connector	object_bool_Ballast_Fault_2
	Ballast fault 2. More...

U16	u16_Analog_Input_Status
	Analog input status. More...

I16	i16_Analog_Input_Data
	Analog input data block output as I16. 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
volatile TKG3_DCBIO_V2_Registers *	struct_Registers
	Pointer to register in FPGA. More...

U16	u16_Status
	Status register. More...

U16	u16_Control
	Control register. More...

F32	f32_Gain
	Effective gain of the voltage measurement channel. More...

F32	f32_Offset
	Effective offset of the voltage measurement channel. 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

DC bus board P015.05 V1.0 class.

Constructor & Destructor Documentation

◆ TKG3_DCBIO_V2()

TKG3_DCBIO_V2::TKG3_DCBIO_V2 ( )

Function block class constructor method.

Note: None

Override: Not allowed

Attention: Don't call this method directly.

References f32_Gain, f32_Offset, false, i16_Analog_Input_Data, object_bool_Ballast_Control, object_bool_Ballast_Error, object_bool_Hardware_Error, object_bool_Hardware_Limit_Error, object_bool_Software_Limit_Error, object_f32_Analog_Input_Data, object_f32_Analog_Input_Full_Scale, object_f32_Analog_Input_Offset, TBlock_Connector::Set_Type_BOOL(), TBlock_Input_Connector::Set_Type_BOOL(), TBlock_Connector::Set_Type_F32(), TBlock_Input_Connector::Set_Type_F32(), and u16_Analog_Input_Status.

Here is the call graph for this function:

◆ ~TKG3_DCBIO_V2()

TKG3_DCBIO_V2::~TKG3_DCBIO_V2 ( )

Function block class desstructor method.

Note: None

Override: Not allowed

Attention: Don't call this method directly.

Member Function Documentation

◆ Execute()

VOID TKG3_DCBIO_V2::Execute ( )

virtual

Function block execution method.

Note: None

Override: Not allowed

Attention: None

Implements TFunction_Block_Base.

◆ Execute_Inputs()

VOID TKG3_DCBIO_V2::Execute_Inputs ( )

virtual

Function block inputs execution method.

Note: None

Override: Not allowed

Attention: None

References TConOpSys_Variant_Data::bool_Value, f32_Gain, f32_Offset, TConOpSys_Variant_Data::f32_Value, i16_Analog_Input_Data, object_bool_Ballast_Error, object_bool_Hardware_Error, object_f32_Analog_Input_Data, TBlock_Connector::object_Storage, TConOpSys_Variant::struct_Data, struct_Registers, and u16_Status.

◆ Execute_Outputs()

VOID TKG3_DCBIO_V2::Execute_Outputs ( )

virtual

Function block outputs execution method.

Note: None

Override: Not allowed

Attention: None

References object_bool_Ballast_Control, TBlock_Input_Connector::object_Pointer, TConOpSys_Variant_Data::pbool_Value, TConOpSys_Variant::struct_Data, struct_Registers, and u16_Control.

◆ Init()

VOID TKG3_DCBIO_V2::Init ( )

virtual

Function block initialisation method.

Note: None

Override: Not allowed

Attention: None

References f32_Gain, f32_Offset, object_f32_Analog_Input_Full_Scale, object_f32_Analog_Input_Offset, TBlock_Input_Connector::object_Pointer, TConOpSys_Variant_Data::pf32_Value, and TConOpSys_Variant::struct_Data.

◆ Map()

VOID TKG3_DCBIO_V2::Map ( TKG3_DCBIO_V2_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 TKG3_DCBIO_V2::Send_Information ( TProtocol_Base * object_Protocol )

virtual

Send information about driver over communication link protocol.

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

Parameters

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

Returns: None

Override: Not allowed

Attention: None

Reimplemented from TFunction_Block_Base.

References f32_Gain, TConOpSys_Variant_Data::f32_Value, object_bool_Ballast_Control, object_bool_Ballast_Error, object_f32_Analog_Input_Data, object_f32_Analog_Input_Full_Scale, object_f32_Analog_Input_Offset, TBlock_Connector::object_Storage, TConOpSys_Variant::struct_Data, struct_Registers, TProtocol_Base::Transmit_Connector_Value_As_Decimal(), TProtocol_Base::Transmit_F32_Value_As_Decimal(), TProtocol_Base::Transmit_I16_Value_As_Decimal(), TProtocol_Base::Transmit_I16_Value_As_Hex(), TProtocol_Base::Transmit_String(), and TProtocol_Base::Transmit_U16_Value_As_Hex().

Here is the call graph for this function:

Member Data Documentation

◆ f32_Gain

F32 TKG3_DCBIO_V2::f32_Gain

private

Effective gain of the voltage measurement channel.

Referenced by Execute_Inputs(), Init(), Send_Information(), and TKG3_DCBIO_V2().

◆ f32_Offset

F32 TKG3_DCBIO_V2::f32_Offset

private

Effective offset of the voltage measurement channel.

Referenced by Execute_Inputs(), Init(), and TKG3_DCBIO_V2().

◆ i16_Analog_Input_Data

I16 TKG3_DCBIO_V2::i16_Analog_Input_Data

Analog input data block output as I16.

Referenced by Execute_Inputs(), and TKG3_DCBIO_V2().

◆ object_bool_Ballast_Control

TBlock_Input_Connector TKG3_DCBIO_V2::object_bool_Ballast_Control

Ballast status.

Referenced by Execute_Outputs(), Send_Information(), and TKG3_DCBIO_V2().

◆ object_bool_Ballast_Error

TBlock_Output_Connector TKG3_DCBIO_V2::object_bool_Ballast_Error

Ballast status signal.

Referenced by Execute_Inputs(), Send_Information(), and TKG3_DCBIO_V2().

◆ object_bool_Ballast_Fault_1

TBlock_Output_Connector TKG3_DCBIO_V2::object_bool_Ballast_Fault_1

Ballast fault 1.

◆ object_bool_Ballast_Fault_2

TBlock_Output_Connector TKG3_DCBIO_V2::object_bool_Ballast_Fault_2

Ballast fault 2.

◆ object_bool_Emergency_Stop

TBlock_Input_Connector TKG3_DCBIO_V2::object_bool_Emergency_Stop

Precharge enable.

◆ object_bool_Hardware_Error

TBlock_Output_Connector TKG3_DCBIO_V2::object_bool_Hardware_Error

Critical hardware error flag.

Referenced by Execute_Inputs(), and TKG3_DCBIO_V2().

◆ object_bool_Hardware_Limit_Error

TBlock_Output_Connector TKG3_DCBIO_V2::object_bool_Hardware_Limit_Error

Hardware limit reached error flag.

Referenced by TKG3_DCBIO_V2().

◆ object_bool_Precharge_Enable

TBlock_Input_Connector TKG3_DCBIO_V2::object_bool_Precharge_Enable

Precharge enable.

◆ object_bool_Precharge_Fault

TBlock_Output_Connector TKG3_DCBIO_V2::object_bool_Precharge_Fault

Precharge fault.

◆ object_bool_Software_Limit_Error

TBlock_Output_Connector TKG3_DCBIO_V2::object_bool_Software_Limit_Error

Software limit reached error flag.

Referenced by TKG3_DCBIO_V2().

◆ object_f32_Analog_Input_Data

TBlock_Output_Connector TKG3_DCBIO_V2::object_f32_Analog_Input_Data

Analog input data block output connector.

Referenced by Execute_Inputs(), Send_Information(), and TKG3_DCBIO_V2().

◆ object_f32_Analog_Input_Full_Scale

TBlock_Input_Connector TKG3_DCBIO_V2::object_f32_Analog_Input_Full_Scale

Analog input channel fill scale value. Also used for channel total gain adjustment.

Referenced by Init(), Send_Information(), and TKG3_DCBIO_V2().

◆ object_f32_Analog_Input_Offset

TBlock_Input_Connector TKG3_DCBIO_V2::object_f32_Analog_Input_Offset

Analog input channel offset.

Referenced by Init(), Send_Information(), and TKG3_DCBIO_V2().

◆ object_f32_Ballast_Setpoint_1

TBlock_Input_Connector TKG3_DCBIO_V2::object_f32_Ballast_Setpoint_1

Ballast setpoint 1.

◆ object_f32_Ballast_Setpoint_2

TBlock_Input_Connector TKG3_DCBIO_V2::object_f32_Ballast_Setpoint_2

Ballast setpoint 2.

◆ object_f32_DC_BUS_GAIN

TBlock_Input_Connector TKG3_DCBIO_V2::object_f32_DC_BUS_GAIN

DC BUS gain.

◆ object_f32_DC_BUS_Offset

TBlock_Input_Connector TKG3_DCBIO_V2::object_f32_DC_BUS_Offset

DC BUS offset.

◆ object_f32_DC_BUS_Voltage

TBlock_Output_Connector TKG3_DCBIO_V2::object_f32_DC_BUS_Voltage

DC BUS voltage.

◆ struct_Registers

volatile TKG3_DCBIO_V2_Registers* TKG3_DCBIO_V2::struct_Registers

private

Pointer to register in FPGA.

Referenced by Execute_Inputs(), Execute_Outputs(), Map(), and Send_Information().

◆ u16_Analog_Input_Status

U16 TKG3_DCBIO_V2::u16_Analog_Input_Status

Analog input status.

Referenced by TKG3_DCBIO_V2().

◆ u16_Control

U16 TKG3_DCBIO_V2::u16_Control

private

Control register.

Referenced by Execute_Outputs().

◆ u16_Status

U16 TKG3_DCBIO_V2::u16_Status

private

Status register.

Referenced by Execute_Inputs().

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

ConOpSys/Hardware/KG3_DCBIO_V2/KG3_DCBIO_V2.h
ConOpSys/Hardware/KG3_DCBIO_V2/KG3_DCBIO_V2.cpp

Classes

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TKG3_DCBIO_V2()

◆ ~TKG3_DCBIO_V2()

Member Function Documentation

◆ Execute()

◆ Execute_Inputs()

◆ Execute_Outputs()

◆ Init()

◆ Map()

◆ Send_Information()

Member Data Documentation

◆ f32_Gain

◆ f32_Offset

◆ i16_Analog_Input_Data

◆ object_bool_Ballast_Control

◆ object_bool_Ballast_Error

◆ object_bool_Ballast_Fault_1

◆ object_bool_Ballast_Fault_2

◆ object_bool_Emergency_Stop

◆ object_bool_Hardware_Error

◆ object_bool_Hardware_Limit_Error

◆ object_bool_Precharge_Enable

◆ object_bool_Precharge_Fault

◆ object_bool_Software_Limit_Error

◆ object_f32_Analog_Input_Data

◆ object_f32_Analog_Input_Full_Scale

◆ object_f32_Analog_Input_Offset

◆ object_f32_Ballast_Setpoint_1

◆ object_f32_Ballast_Setpoint_2

◆ object_f32_DC_BUS_GAIN

◆ object_f32_DC_BUS_Offset

◆ object_f32_DC_BUS_Voltage

◆ struct_Registers

◆ u16_Analog_Input_Status

◆ u16_Control

◆ u16_Status