Class declaration description. More...

#include <Function_Block_PID_Regulator.h>

Inheritance diagram for TFunction_Block_PID_Regulator:

Collaboration diagram for TFunction_Block_PID_Regulator:

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

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

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

virtual VOID	Execute ()
	Function block execution method. 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...

virtual VOID	Send_Information (TProtocol_Base *object_Protocol)
	Send information about Function block over communication link protocol. 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_Kd
	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_Reference
	Reference signal. More...

TBlock_Input_Connector	object_f32_Feedback
	Reference signal. More...

TBlock_Input_Connector	object_bool_Enable
	Enable signal. More...

TBlock_Input_Connector	object_bool_Reset
	Reset signal. More...

TBlock_Output_Connector	object_f32_Output
	PI block output. More...

F32	f32_Proportional

F32	f32_Integral

F32	f32_Differential

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 }

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_PID_Regulator()

TFunction_Block_PID_Regulator::TFunction_Block_PID_Regulator ( )

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 f32_Differential, f32_Integral, object_bool_Enable, object_bool_Reset, object_f32_Feedback, object_f32_Integrator_Negative_Limit, object_f32_Integrator_Positive_Limit, object_f32_Kd, object_f32_Ki, object_f32_Kp, object_f32_Output, object_f32_Output_Negative_Limit, object_f32_Output_Positive_Limit, object_f32_Reference, object_f32_Sample_Time, TBlock_Connector::Set_Type(), and TBlock_Input_Connector::Set_Type().

Here is the call graph for this function:

◆ ~TFunction_Block_PID_Regulator()

TFunction_Block_PID_Regulator::~TFunction_Block_PID_Regulator ( )

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_PID_Regulator::Execute ( )

virtual

Function block execution method.

Functional block processing method.

Note: None

Override: Not allowed

Attention: None

Returns: None

Note: None

Implements TFunction_Block_Base.

References f32_Differential, f32_Integral, f32_Proportional, TConOpSys_Variant_Data::f32_Value, object_bool_Enable, 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_Reference, object_f32_Sample_Time, 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_PID_Regulator::Init ( )

virtual

Function block initialisation method.

Functional block initialization.

Note: None

Override: Not allowed

Attention: Don't call this method directly.

Returns: None

Note: None

Member Data Documentation

◆ f32_Differential

F32 TFunction_Block_PID_Regulator::f32_Differential

Referenced by Execute(), and TFunction_Block_PID_Regulator().

◆ f32_Integral

F32 TFunction_Block_PID_Regulator::f32_Integral

Referenced by Execute(), and TFunction_Block_PID_Regulator().

◆ f32_Proportional

F32 TFunction_Block_PID_Regulator::f32_Proportional

Referenced by Execute().

◆ object_bool_Enable

TBlock_Input_Connector TFunction_Block_PID_Regulator::object_bool_Enable

Enable signal.

Referenced by Execute(), and TFunction_Block_PID_Regulator().

◆ object_bool_Reset

TBlock_Input_Connector TFunction_Block_PID_Regulator::object_bool_Reset

Reset signal.

Referenced by TFunction_Block_PID_Regulator().

◆ object_f32_Feedback

TBlock_Input_Connector TFunction_Block_PID_Regulator::object_f32_Feedback

Reference signal.

Referenced by Execute(), and TFunction_Block_PID_Regulator().

◆ object_f32_Integrator_Negative_Limit

TBlock_Input_Connector TFunction_Block_PID_Regulator::object_f32_Integrator_Negative_Limit

Integrator negative limit parameter.

Referenced by Execute(), and TFunction_Block_PID_Regulator().

◆ object_f32_Integrator_Positive_Limit

TBlock_Input_Connector TFunction_Block_PID_Regulator::object_f32_Integrator_Positive_Limit

Integrator positive limit parameter.

Referenced by Execute(), and TFunction_Block_PID_Regulator().

◆ object_f32_Kd

TBlock_Input_Connector TFunction_Block_PID_Regulator::object_f32_Kd

Integral gain parameter.

Referenced by TFunction_Block_PID_Regulator().

◆ object_f32_Ki

TBlock_Input_Connector TFunction_Block_PID_Regulator::object_f32_Ki

Integral gain parameter.

Referenced by Execute(), and TFunction_Block_PID_Regulator().

◆ object_f32_Kp

TBlock_Input_Connector TFunction_Block_PID_Regulator::object_f32_Kp

Propotrional gain parameter.

Referenced by Execute(), and TFunction_Block_PID_Regulator().

◆ object_f32_Output

TBlock_Output_Connector TFunction_Block_PID_Regulator::object_f32_Output

PI block output.

Referenced by Execute(), and TFunction_Block_PID_Regulator().

◆ object_f32_Output_Negative_Limit

TBlock_Input_Connector TFunction_Block_PID_Regulator::object_f32_Output_Negative_Limit

Output negative limit parameter.

Referenced by Execute(), and TFunction_Block_PID_Regulator().

◆ object_f32_Output_Positive_Limit

TBlock_Input_Connector TFunction_Block_PID_Regulator::object_f32_Output_Positive_Limit

Output positive limit parameter.

Referenced by Execute(), and TFunction_Block_PID_Regulator().

◆ object_f32_Reference

TBlock_Input_Connector TFunction_Block_PID_Regulator::object_f32_Reference

Reference signal.

Referenced by Execute(), and TFunction_Block_PID_Regulator().

◆ object_f32_Sample_Time

TBlock_Input_Connector TFunction_Block_PID_Regulator::object_f32_Sample_Time

Sample time parameter.

Referenced by Execute(), and TFunction_Block_PID_Regulator().

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

ConOpSys/Blocks/Function_Block_PID_Regulator.h
ConOpSys/Blocks/Function_Block_PID_Regulator.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TFunction_Block_PID_Regulator()

◆ ~TFunction_Block_PID_Regulator()

Member Function Documentation

◆ Execute()

◆ Init()

Member Data Documentation

◆ f32_Differential

◆ f32_Integral

◆ f32_Proportional

◆ object_bool_Enable

◆ object_bool_Reset

◆ object_f32_Feedback

◆ object_f32_Integrator_Negative_Limit

◆ object_f32_Integrator_Positive_Limit

◆ object_f32_Kd

◆ object_f32_Ki

◆ object_f32_Kp

◆ object_f32_Output

◆ object_f32_Output_Negative_Limit

◆ object_f32_Output_Positive_Limit

◆ object_f32_Reference

◆ object_f32_Sample_Time