Class declaration description. More...

#include <Function_Block_Ballast_Control.h>

Inheritance diagram for TFunction_Block_Ballast_Control:

Collaboration diagram for TFunction_Block_Ballast_Control:

Public Member Functions
	TFunction_Block_Ballast_Control ()
	Class constructor method. More...

virtual	~TFunction_Block_Ballast_Control ()
	Class destructor 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 Function block 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_Sample_Time
	Sample time given in seconds parameter More...

TBlock_Input_Connector	object_f32_On_Level
	Ballast activation level in volt. More...

TBlock_Input_Connector	object_f32_Off_Level
	Ballast deactivation level in volt. More...

TBlock_Input_Connector	object_f32_R_Ballast
	Ballast active resistance in ohm. More...

TBlock_Input_Connector	object_f32_Energy_Warning_Limit
	Energy warning level for ballast unit, value given in Ws. More...

TBlock_Input_Connector	object_f32_Energy_Alarm_Limit
	Energy alarm level for ballast unit, value given in Ws. More...

TBlock_Input_Connector	object_f32_Energy_Trip_Limit
	Energy trip level for ballast unit, value given in Ws. More...

TBlock_Input_Connector	object_f32_Cooling_Time_Constant
	Ballast unit cooling time constant, value given in seconds. More...

TBlock_Input_Connector	object_f32_Test_Mode_On_Delay
	Test mode on delay, value given in seconds. More...

TBlock_Input_Connector	object_f32_Test_Mode_Off_Delay
	Test mode off delay, value given in seconds. More...

TBlock_Input_Connector	object_f32_DC_Bus_Voltage
	d.c. bus voltage input, value givven in volts More...

TBlock_Input_Connector	object_bool_Test_Mode_Enable
	Test mode enable input, value given in volts. More...

TBlock_Input_Connector	object_bool_Self_Test_Enable
	Enable self test : Not implementet. More...

TBlock_Input_Connector	object_bool_Force_Operation
	Force ballast operation. More...

TBlock_Output_Connector	object_bool_Control
	Ballast control output. More...

TBlock_Output_Connector	object_bool_Overload_Warning
	Ballast unit overload warning. More...

TBlock_Output_Connector	object_bool_Overload_Alarm
	Ballast unit overload alarm. More...

TBlock_Output_Connector	object_bool_Overload_Trip
	Ballast unit overload trip. More...

TBlock_Output_Connector	object_f32_Energy
	Stored energy in ballast unit. 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 Types
enum	TGlobal_FSM_State { enum_Deactivated , enum_Activated , enum_Test_Mode_Activated , enum_Test_Mode_Deactivated , enum_Forced_Operation }

Private Attributes
TGlobal_FSM_State	enum_FSM_State
	FSM state. More...

F32	f32_1_Div_R

BOOL	bool_State
	Ballast state. More...

F32	f32_Ki_Cooling
	Ballast cooling constant. More...

F32	f32_Energy_Integral_Limit
	Energy integral limit. More...

F32	f32_Energy_Integral
	Stored energy integral. More...

U32	u32_Active_Cycle_Counter
	Ballast active control cycle counter. More...

U32	u32_Test_Mode_On_Delay
	Test mode on time delay More...

U32	u32_Test_Mode_Off_Delay
	Test mode off time delay. More...

U32	u32_Timeout_Counter
	Timeout counter. 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

Class declaration description.

Member Enumeration Documentation

◆ TGlobal_FSM_State

enum TFunction_Block_Ballast_Control::TGlobal_FSM_State

private

Enumerator
enum_Deactivated
enum_Activated
enum_Test_Mode_Activated
enum_Test_Mode_Deactivated
enum_Forced_Operation

Constructor & Destructor Documentation

◆ TFunction_Block_Ballast_Control()

TFunction_Block_Ballast_Control::TFunction_Block_Ballast_Control ( )

Class constructor method.

Object conctructor.

Note: None

Override: Not allowed

Attention: Don't call this method directly.

Returns: Pointer to the object

Note: None

References bool_State, enum_BOOL, enum_Deactivated, enum_F32, enum_FSM_State, f32_1_Div_R, f32_Energy_Integral, f32_Energy_Integral_Limit, f32_Ki_Cooling, object_bool_Control, object_bool_Force_Operation, object_bool_Overload_Alarm, object_bool_Overload_Trip, object_bool_Overload_Warning, object_bool_Self_Test_Enable, object_bool_Test_Mode_Enable, object_f32_Cooling_Time_Constant, object_f32_DC_Bus_Voltage, object_f32_Energy, object_f32_Energy_Alarm_Limit, object_f32_Energy_Trip_Limit, object_f32_Energy_Warning_Limit, object_f32_Off_Level, object_f32_On_Level, object_f32_R_Ballast, object_f32_Sample_Time, object_f32_Test_Mode_Off_Delay, object_f32_Test_Mode_On_Delay, TBlock_Connector::Set_Type(), TBlock_Input_Connector::Set_Type(), u32_Active_Cycle_Counter, u32_Test_Mode_Off_Delay, u32_Test_Mode_On_Delay, and u32_Timeout_Counter.

Here is the call graph for this function:

◆ ~TFunction_Block_Ballast_Control()

TFunction_Block_Ballast_Control::~TFunction_Block_Ballast_Control ( )

virtual

Class destructor method.

Object destructor.

Note: None

Override: Not allowed

Attention: Don't call this method directly.

Returns: None

Note: None

Member Function Documentation

◆ Execute()

VOID TFunction_Block_Ballast_Control::Execute ( )

virtual

Function block execution method.

Function block processing method.

Note: None

Override: Not allowed

Attention: None

Returns: None

Note: None

Implements TFunction_Block_Base.

References bool_State, TConOpSys_Variant_Data::bool_Value, enum_Activated, enum_Deactivated, enum_Forced_Operation, enum_FSM_State, enum_Test_Mode_Activated, enum_Test_Mode_Deactivated, f32_1_Div_R, f32_Energy_Integral, f32_Energy_Integral_Limit, f32_Ki_Cooling, TConOpSys_Variant_Data::f32_Value, object_bool_Control, object_bool_Overload_Alarm, object_bool_Overload_Trip, object_bool_Overload_Warning, object_bool_Test_Mode_Enable, object_f32_DC_Bus_Voltage, object_f32_Energy, object_f32_Energy_Alarm_Limit, object_f32_Energy_Warning_Limit, object_f32_Off_Level, object_f32_On_Level, object_f32_Sample_Time, TBlock_Input_Connector::object_Pointer, TBlock_Connector::object_Storage, TConOpSys_Variant_Data::pbool_Value, TConOpSys_Variant_Data::pf32_Value, TConOpSys_Variant::struct_Data, true, u32_Active_Cycle_Counter, u32_Test_Mode_Off_Delay, u32_Test_Mode_On_Delay, and u32_Timeout_Counter.

◆ Init()

VOID TFunction_Block_Ballast_Control::Init ( )

virtual

Function block initialisation method.

Function block initialisation.

Note: None

Override: Not allowed

Attention: Don't call this method directly.

Returns: None

Note: None

References f32_1_Div_R, f32_Energy_Integral_Limit, f32_Ki_Cooling, object_f32_Cooling_Time_Constant, object_f32_Energy_Alarm_Limit, object_f32_Energy_Trip_Limit, object_f32_Energy_Warning_Limit, object_f32_R_Ballast, object_f32_Sample_Time, object_f32_Test_Mode_Off_Delay, object_f32_Test_Mode_On_Delay, TBlock_Input_Connector::object_Pointer, TConOpSys_Variant_Data::pf32_Value, TConOpSys_Variant::struct_Data, u32_Test_Mode_Off_Delay, and u32_Test_Mode_On_Delay.

◆ Send_Information()

VOID TFunction_Block_Ballast_Control::Send_Information ( TProtocol_Base * object_Protocol )

virtual

Send information about Function block over communication link protocol.

Send detailed information about ballast control unit.

Note: This method sends information about Function block over specified communication link protocol.

Parameters

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

Returns: None

Override: Not allowed

Attention: None

Parameters

[in] object_Protocol Pointer to the communication protocol object

Returns: None

Note: None

Reimplemented from TFunction_Block_Base.

References bool_State, f32_Energy_Integral, object_bool_Control, object_bool_Force_Operation, object_bool_Overload_Alarm, object_bool_Overload_Trip, object_bool_Overload_Warning, object_bool_Self_Test_Enable, object_bool_Test_Mode_Enable, object_f32_Cooling_Time_Constant, object_f32_DC_Bus_Voltage, object_f32_Energy_Alarm_Limit, object_f32_Energy_Trip_Limit, object_f32_Energy_Warning_Limit, object_f32_Off_Level, object_f32_On_Level, object_f32_R_Ballast, object_f32_Sample_Time, object_f32_Test_Mode_Off_Delay, object_f32_Test_Mode_On_Delay, TProtocol_Base::Transmit_BOOL_Value_As_Decimal(), TProtocol_Base::Transmit_Connector_Value_As_Decimal(), TProtocol_Base::Transmit_F32_Value_As_Decimal(), TProtocol_Base::Transmit_String(), TProtocol_Base::Transmit_U32_Value_As_Decimal(), u32_Active_Cycle_Counter, u32_Test_Mode_Off_Delay, and u32_Test_Mode_On_Delay.

Here is the call graph for this function:

Member Data Documentation

◆ bool_State

BOOL TFunction_Block_Ballast_Control::bool_State

private

Ballast state.

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

◆ enum_FSM_State

TGlobal_FSM_State TFunction_Block_Ballast_Control::enum_FSM_State

private

FSM state.

Referenced by Execute(), and TFunction_Block_Ballast_Control().

◆ f32_1_Div_R

F32 TFunction_Block_Ballast_Control::f32_1_Div_R

private

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

◆ f32_Energy_Integral

F32 TFunction_Block_Ballast_Control::f32_Energy_Integral

private

Stored energy integral.

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

◆ f32_Energy_Integral_Limit

F32 TFunction_Block_Ballast_Control::f32_Energy_Integral_Limit

private

Energy integral limit.

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

◆ f32_Ki_Cooling

F32 TFunction_Block_Ballast_Control::f32_Ki_Cooling

private

Ballast cooling constant.

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

◆ object_bool_Control

TBlock_Output_Connector TFunction_Block_Ballast_Control::object_bool_Control

Ballast control output.

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

◆ object_bool_Force_Operation

TBlock_Input_Connector TFunction_Block_Ballast_Control::object_bool_Force_Operation

Force ballast operation.

Referenced by Send_Information(), and TFunction_Block_Ballast_Control().

◆ object_bool_Overload_Alarm

TBlock_Output_Connector TFunction_Block_Ballast_Control::object_bool_Overload_Alarm

Ballast unit overload alarm.

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

◆ object_bool_Overload_Trip

TBlock_Output_Connector TFunction_Block_Ballast_Control::object_bool_Overload_Trip

Ballast unit overload trip.

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

◆ object_bool_Overload_Warning

TBlock_Output_Connector TFunction_Block_Ballast_Control::object_bool_Overload_Warning

Ballast unit overload warning.

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

◆ object_bool_Self_Test_Enable

TBlock_Input_Connector TFunction_Block_Ballast_Control::object_bool_Self_Test_Enable

Enable self test : Not implementet.

Referenced by Send_Information(), and TFunction_Block_Ballast_Control().

◆ object_bool_Test_Mode_Enable

TBlock_Input_Connector TFunction_Block_Ballast_Control::object_bool_Test_Mode_Enable

Test mode enable input, value given in volts.

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

◆ object_f32_Cooling_Time_Constant

TBlock_Input_Connector TFunction_Block_Ballast_Control::object_f32_Cooling_Time_Constant

Ballast unit cooling time constant, value given in seconds.

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

◆ object_f32_DC_Bus_Voltage

TBlock_Input_Connector TFunction_Block_Ballast_Control::object_f32_DC_Bus_Voltage

d.c. bus voltage input, value givven in volts

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

◆ object_f32_Energy

TBlock_Output_Connector TFunction_Block_Ballast_Control::object_f32_Energy

Stored energy in ballast unit.

Referenced by Execute(), and TFunction_Block_Ballast_Control().

◆ object_f32_Energy_Alarm_Limit

TBlock_Input_Connector TFunction_Block_Ballast_Control::object_f32_Energy_Alarm_Limit

Energy alarm level for ballast unit, value given in Ws.

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

◆ object_f32_Energy_Trip_Limit

TBlock_Input_Connector TFunction_Block_Ballast_Control::object_f32_Energy_Trip_Limit

Energy trip level for ballast unit, value given in Ws.

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

◆ object_f32_Energy_Warning_Limit

TBlock_Input_Connector TFunction_Block_Ballast_Control::object_f32_Energy_Warning_Limit

Energy warning level for ballast unit, value given in Ws.

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

◆ object_f32_Off_Level

TBlock_Input_Connector TFunction_Block_Ballast_Control::object_f32_Off_Level

Ballast deactivation level in volt.

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

◆ object_f32_On_Level

TBlock_Input_Connector TFunction_Block_Ballast_Control::object_f32_On_Level

Ballast activation level in volt.

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

◆ object_f32_R_Ballast

TBlock_Input_Connector TFunction_Block_Ballast_Control::object_f32_R_Ballast

Ballast active resistance in ohm.

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

◆ object_f32_Sample_Time

TBlock_Input_Connector TFunction_Block_Ballast_Control::object_f32_Sample_Time

Sample time given in seconds parameter

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

◆ object_f32_Test_Mode_Off_Delay

TBlock_Input_Connector TFunction_Block_Ballast_Control::object_f32_Test_Mode_Off_Delay

Test mode off delay, value given in seconds.

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

◆ object_f32_Test_Mode_On_Delay

TBlock_Input_Connector TFunction_Block_Ballast_Control::object_f32_Test_Mode_On_Delay

Test mode on delay, value given in seconds.

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

◆ u32_Active_Cycle_Counter

U32 TFunction_Block_Ballast_Control::u32_Active_Cycle_Counter

private

Ballast active control cycle counter.

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

◆ u32_Test_Mode_Off_Delay

U32 TFunction_Block_Ballast_Control::u32_Test_Mode_Off_Delay

private

Test mode off time delay.

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

◆ u32_Test_Mode_On_Delay

U32 TFunction_Block_Ballast_Control::u32_Test_Mode_On_Delay

private

Test mode on time delay

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

◆ u32_Timeout_Counter

U32 TFunction_Block_Ballast_Control::u32_Timeout_Counter

private

Timeout counter.

Referenced by Execute(), and TFunction_Block_Ballast_Control().

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

ConOpSys/Blocks/Function_Block_Ballast_Control.h
ConOpSys/Blocks/Function_Block_Ballast_Control.cpp

Public Member Functions

Public Attributes

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TGlobal_FSM_State

Constructor & Destructor Documentation

◆ TFunction_Block_Ballast_Control()

◆ ~TFunction_Block_Ballast_Control()

Member Function Documentation

◆ Execute()

◆ Init()

◆ Send_Information()

Member Data Documentation

◆ bool_State

◆ enum_FSM_State

◆ f32_1_Div_R

◆ f32_Energy_Integral

◆ f32_Energy_Integral_Limit

◆ f32_Ki_Cooling

◆ object_bool_Control

◆ object_bool_Force_Operation

◆ object_bool_Overload_Alarm

◆ object_bool_Overload_Trip

◆ object_bool_Overload_Warning

◆ object_bool_Self_Test_Enable

◆ object_bool_Test_Mode_Enable

◆ object_f32_Cooling_Time_Constant

◆ object_f32_DC_Bus_Voltage

◆ object_f32_Energy

◆ object_f32_Energy_Alarm_Limit

◆ object_f32_Energy_Trip_Limit

◆ object_f32_Energy_Warning_Limit

◆ object_f32_Off_Level

◆ object_f32_On_Level

◆ object_f32_R_Ballast

◆ object_f32_Sample_Time

◆ object_f32_Test_Mode_Off_Delay

◆ object_f32_Test_Mode_On_Delay

◆ u32_Active_Cycle_Counter

◆ u32_Test_Mode_Off_Delay

◆ u32_Test_Mode_On_Delay

◆ u32_Timeout_Counter