TFunction_Block_PI_Regulator_F32_T3 Class Reference

Class declaration description. More...

#include <Function_Block_PI_Regulator_F32_T3.h>

Inheritance diagram for TFunction_Block_PI_Regulator_F32_T3:

Collaboration diagram for TFunction_Block_PI_Regulator_F32_T3:

Public Member Functions
	TFunction_Block_PI_Regulator_F32_T3 ()
	Class constructor method. More...
virtual	~TFunction_Block_PI_Regulator_F32_T3 ()
	Class destructor method. More...
VOID	Init ()
	Function block initialisation method. More...
virtual VOID	Execute ()
	Function block cyclic 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_Kp
	Propotrional gain parameter. More...
TBlock_Input_Connector	object_f32_Ki
	Integral gain parameter. More...
TBlock_Input_Connector	object_f32_Integrator_Positive_Limit
	Integrator positive limit parameter. More...
TBlock_Input_Connector	object_f32_Integrator_Negative_Limit
	Integrator negative limit parameter. More...
TBlock_Input_Connector	object_f32_Output_Positive_Limit
	Output positive limit parameter. More...
TBlock_Input_Connector	object_f32_Output_Negative_Limit
	Output negative limit parameter. More...
TBlock_Input_Connector	object_f32_Sample_Time
	Sample time parameter. More...
TBlock_Input_Connector	object_f32_Setpoint
	Setpoint signal input. More...
TBlock_Input_Connector	object_f32_Feedback
	Feedback signal input. More...
TBlock_Input_Connector	object_f32_Integral_Preset
	Integrator initialisation signal input. More...
TBlock_Input_Connector	object_bool_Enable
	Enable signal input. More...
TBlock_Input_Connector	object_bool_Reset
	Reset signal input. More...
TBlock_Output_Connector	object_f32_Error
	PI regulator error output. More...
TBlock_Output_Connector	object_f32_Output
	PI regulator block output. 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
F32	f32_Proportional = (F32)0.0f
	Proportional part. More...
F32	f32_Integral = (F32)0.0f
	Integral part. 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.

Constructor & Destructor Documentation

TFunction_Block_PI_Regulator_F32_T3()

TFunction_Block_PI_Regulator_F32_T3::TFunction_Block_PI_Regulator_F32_T3

(

)

Class constructor method.

---

Note

None

Override

Not allowed

Attention

Don't call this method directly.

References f32_Integral, f32_Proportional, false, object_bool_Enable, object_bool_Reset, object_f32_Error, object_f32_Feedback, object_f32_Integral_Preset, object_f32_Integrator_Negative_Limit, object_f32_Integrator_Positive_Limit, object_f32_Ki, object_f32_Kp, object_f32_Output, object_f32_Output_Negative_Limit, object_f32_Output_Positive_Limit, object_f32_Sample_Time, object_f32_Setpoint, TBlock_Input_Connector::Set_Type_BOOL(), TBlock_Connector::Set_Type_F32(), TBlock_Input_Connector::Set_Type_F32(), and true.

Here is the call graph for this function:

~TFunction_Block_PI_Regulator_F32_T3()

TFunction_Block_PI_Regulator_F32_T3::~TFunction_Block_PI_Regulator_F32_T3 ( )

virtual

Class destructor method.

---

Note

None

Override

Not allowed

Attention

Don't call this method directly.

Member Function Documentation

Execute()

VOID TFunction_Block_PI_Regulator_F32_T3::Execute ( )

virtual

Function block cyclic execution method.

---

Note

None

Override

Not allowed

Attention

Don't call this method directly.

Implements TFunction_Block_Base.

References f32_Integral, f32_Proportional, TConOpSys_Variant_Data::f32_Value, object_bool_Enable, object_f32_Error, object_f32_Feedback, object_f32_Integral_Preset, object_f32_Integrator_Negative_Limit, object_f32_Integrator_Positive_Limit, object_f32_Ki, object_f32_Kp, object_f32_Output, object_f32_Output_Negative_Limit, object_f32_Output_Positive_Limit, object_f32_Sample_Time, object_f32_Setpoint, TBlock_Input_Connector::object_Pointer, TBlock_Connector::object_Storage, TConOpSys_Variant_Data::pbool_Value, TConOpSys_Variant_Data::pf32_Value, and TConOpSys_Variant::struct_Data.

Init()

VOID TFunction_Block_PI_Regulator_F32_T3::Init

(

)

Function block initialisation method.

---

Note

None

Override

Not allowed

Attention

Don't call this method directly.

References TBlock_Input_Connector::Append_Connected_Status(), object_bool_Enable, object_bool_Reset, object_f32_Feedback, object_f32_Integral_Preset, object_f32_Integrator_Negative_Limit, object_f32_Integrator_Positive_Limit, object_f32_Ki, object_f32_Kp, object_f32_Output_Negative_Limit, object_f32_Output_Positive_Limit, object_f32_Sample_Time, object_f32_Setpoint, and TFunction_Block_Base::Update_Connected_Status().

Here is the call graph for this function:

Send_Information()

VOID TFunction_Block_PI_Regulator_F32_T3::Send_Information ( TProtocol_Base *  object_Protocol )

virtual

Send information about Function block over communication link protocol.

---

Note

This method sends information about Function block 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_Integral, f32_Proportional, object_bool_Enable, object_bool_Reset, object_f32_Error, object_f32_Feedback, object_f32_Integrator_Negative_Limit, object_f32_Integrator_Positive_Limit, object_f32_Ki, object_f32_Kp, object_f32_Output, object_f32_Output_Negative_Limit, object_f32_Output_Positive_Limit, object_f32_Sample_Time, object_f32_Setpoint, TProtocol_Base::Transmit_Connector_Value_As_Decimal(), TProtocol_Base::Transmit_F32_Value_As_Decimal(), and TProtocol_Base::Transmit_String().

Here is the call graph for this function:

Member Data Documentation

f32_Integral

F32 TFunction_Block_PI_Regulator_F32_T3::f32_Integral = (F32)0.0f

private

Integral part.

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

f32_Proportional

F32 TFunction_Block_PI_Regulator_F32_T3::f32_Proportional = (F32)0.0f

private

Proportional part.

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

object_bool_Enable

TBlock_Input_Connector TFunction_Block_PI_Regulator_F32_T3::object_bool_Enable

Enable signal input.

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

object_bool_Reset

TBlock_Input_Connector TFunction_Block_PI_Regulator_F32_T3::object_bool_Reset

Reset signal input.

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

object_f32_Error

TBlock_Output_Connector TFunction_Block_PI_Regulator_F32_T3::object_f32_Error

PI regulator error output.

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

object_f32_Feedback

TBlock_Input_Connector TFunction_Block_PI_Regulator_F32_T3::object_f32_Feedback

Feedback signal input.

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

object_f32_Integral_Preset

TBlock_Input_Connector TFunction_Block_PI_Regulator_F32_T3::object_f32_Integral_Preset

Integrator initialisation signal input.

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

object_f32_Integrator_Negative_Limit

TBlock_Input_Connector TFunction_Block_PI_Regulator_F32_T3::object_f32_Integrator_Negative_Limit

Integrator negative limit parameter.

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

object_f32_Integrator_Positive_Limit

TBlock_Input_Connector TFunction_Block_PI_Regulator_F32_T3::object_f32_Integrator_Positive_Limit

Integrator positive limit parameter.

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

object_f32_Ki

TBlock_Input_Connector TFunction_Block_PI_Regulator_F32_T3::object_f32_Ki

Integral gain parameter.

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

object_f32_Kp

TBlock_Input_Connector TFunction_Block_PI_Regulator_F32_T3::object_f32_Kp

Propotrional gain parameter.

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

object_f32_Output

TBlock_Output_Connector TFunction_Block_PI_Regulator_F32_T3::object_f32_Output

PI regulator block output.

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

object_f32_Output_Negative_Limit

TBlock_Input_Connector TFunction_Block_PI_Regulator_F32_T3::object_f32_Output_Negative_Limit

Output negative limit parameter.

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

object_f32_Output_Positive_Limit

TBlock_Input_Connector TFunction_Block_PI_Regulator_F32_T3::object_f32_Output_Positive_Limit

Output positive limit parameter.

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

object_f32_Sample_Time

TBlock_Input_Connector TFunction_Block_PI_Regulator_F32_T3::object_f32_Sample_Time

Sample time parameter.

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

object_f32_Setpoint

TBlock_Input_Connector TFunction_Block_PI_Regulator_F32_T3::object_f32_Setpoint

Setpoint signal input.

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

---

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

• ConOpSys/Blocks/Function_Block_PI_Regulator_F32_T3.h
• ConOpSys/Blocks/Function_Block_PI_Regulator_F32_T3.cpp