TP015_09_V1_0_Encoder Class Reference

Encoder board P015.09 V1.0 class. More...

#include <P015_09_V1_0_Encoder.h>

Inheritance diagram for TP015_09_V1_0_Encoder:

Collaboration diagram for TP015_09_V1_0_Encoder:

Classes
struct	TP015_09_V1_0_Encoder_Registers

Public Member Functions
	TP015_09_V1_0_Encoder ()
	Constructor method. More...
virtual	~TP015_09_V1_0_Encoder ()
	Destructor method. More...
VOID	Map (TP015_09_V1_0_Encoder_Registers *struct_Registers_Base_Address)
	Encoder board P015.09 V1.0 memory map. More...
virtual VOID	Init ()
	Initialisation method. More...
virtual VOID	Execute ()
	Execute method. More...
virtual VOID	Send_Information (TProtocol_Base *object_Protocol)
	Send information about functional block. 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_u32_Pulse
	[-] Encoder pulse per revolution More...
TBlock_Input_Connector	object_f32_Counter_Clock_Frequency
	[Hz] Counter clock frequency More...
TBlock_Input_Connector	object_f32_Max_Omega_Change_Rate
	[rad/s] Maximal omega change rate More...
TBlock_Output_Connector	object_f32_Counter
	Encoder counter. More...
TBlock_Output_Connector	object_f32_Theta
	[rad] Rotor theta More...
TBlock_Output_Connector	object_f32_Omega
	[rad/s] Rotor speed More...
TBlock_Output_Connector	object_bool_Error
	Error flag. 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 TP015_09_V1_0_Encoder_Registers *	struct_Registers
	Hardware mapped registers. More...
U32	u32_Error_Counter
	Error counter. More...
F32	f32_Theta_Gain
	Internal variable. More...
F32	f32_Omega_Gain
	Internal variable. More...
F32	f32_Omega_Magnitude_Storage
	Omega magnitude storage. More...
F32	f32_Max_Omega_Change_Rate
	Maximal omega change rate. More...
BOOL	bool_First_Iteration
	First iteration flag. 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

Encoder board P015.09 V1.0 class.

Constructor & Destructor Documentation

TP015_09_V1_0_Encoder()

TP015_09_V1_0_Encoder::TP015_09_V1_0_Encoder

(

)

Constructor method.

Encoder board P015.09 V1.0 object conctructor.

Returns

Pointer to the object

Note

None

References bool_First_Iteration, f32_Max_Omega_Change_Rate, f32_Omega_Gain, f32_Omega_Magnitude_Storage, f32_Theta_Gain, false, NULL, object_bool_Error, object_f32_Counter, object_f32_Counter_Clock_Frequency, object_f32_Max_Omega_Change_Rate, object_f32_Omega, object_f32_Theta, object_u32_Pulse, TBlock_Connector::Set_Type_BOOL(), TBlock_Connector::Set_Type_F32(), TBlock_Input_Connector::Set_Type_F32(), TBlock_Input_Connector::Set_Type_U32(), struct_Registers, and u32_Error_Counter.

Here is the call graph for this function:

~TP015_09_V1_0_Encoder()

TP015_09_V1_0_Encoder::~TP015_09_V1_0_Encoder ( )

virtual

Destructor method.

Encoder board P015.03 V1.0 object destructor.

Returns

None

Note

None

Member Function Documentation

Execute()

VOID TP015_09_V1_0_Encoder::Execute ( )

virtual

Execute method.

Encoder board P015.09 V1.0 execute method.

Returns

None

Note

None

Implements TFunction_Block_Base.

References bool_First_Iteration, TConOpSys_Variant_Data::bool_Value, f32_Max_Omega_Change_Rate, f32_Omega_Gain, f32_Omega_Magnitude_Storage, f32_Theta_Gain, TConOpSys_Variant_Data::f32_Value, object_bool_Error, object_f32_Counter, object_f32_Omega, object_f32_Theta, TBlock_Connector::object_Storage, TConOpSys_Variant::struct_Data, struct_Registers, true, TP015_09_V1_0_Encoder::TP015_09_V1_0_Encoder_Registers::u16_Counter_Latch, TP015_09_V1_0_Encoder::TP015_09_V1_0_Encoder_Registers::u16_Period, TP015_09_V1_0_Encoder::TP015_09_V1_0_Encoder_Registers::u16_Status, and u32_Error_Counter.

Init()

VOID TP015_09_V1_0_Encoder::Init ( )

virtual

Initialisation method.

Encoder board P015.09 V1.0 object initialization.

Returns

None

Note

None

References f32_Omega_Gain, f32_Pi_MUL_2, f32_Theta_Gain, object_f32_Counter_Clock_Frequency, TBlock_Input_Connector::object_Pointer, object_u32_Pulse, TConOpSys_Variant_Data::pf32_Value, TConOpSys_Variant_Data::pu32_Value, and TConOpSys_Variant::struct_Data.

Map()

VOID TP015_09_V1_0_Encoder::Map

(

TP015_09_V1_0_Encoder_Registers *

struct_Registers_Base_Address

)

Encoder board P015.09 V1.0 memory map.

Parameters

[in]

struct_Registers_Base_Address

Base address within FPGA address space

Returns

None

Note

None

References struct_Registers.

Send_Information()

VOID TP015_09_V1_0_Encoder::Send_Information ( TProtocol_Base *  object_Protocol )

virtual

Send information about functional block.

Send detailed information about functional block.

Parameters

[in]

object_Protocol

Pointer to the communication protocol object

Returns

None

Note

None

Reimplemented from TFunction_Block_Base.

References f32_Omega_Gain, f32_Theta_Gain, object_bool_Error, object_f32_Counter, object_f32_Counter_Clock_Frequency, object_f32_Max_Omega_Change_Rate, object_f32_Omega, object_f32_Theta, object_u32_Pulse, struct_Registers, TProtocol_Base::Transmit_Connector_Value_As_Decimal(), TProtocol_Base::Transmit_F32_Value_As_Decimal(), TProtocol_Base::Transmit_String(), TProtocol_Base::Transmit_U16_Value_As_Decimal(), TProtocol_Base::Transmit_U16_Value_As_Hex(), TProtocol_Base::Transmit_U32_Value_As_Decimal(), TP015_09_V1_0_Encoder::TP015_09_V1_0_Encoder_Registers::u16_Counter, TP015_09_V1_0_Encoder::TP015_09_V1_0_Encoder_Registers::u16_Counter_Latch, TP015_09_V1_0_Encoder::TP015_09_V1_0_Encoder_Registers::u16_Period, TP015_09_V1_0_Encoder::TP015_09_V1_0_Encoder_Registers::u16_Status, and u32_Error_Counter.

Here is the call graph for this function:

Member Data Documentation

bool_First_Iteration

BOOL TP015_09_V1_0_Encoder::bool_First_Iteration

private

First iteration flag.

Referenced by Execute(), and TP015_09_V1_0_Encoder().

f32_Max_Omega_Change_Rate

F32 TP015_09_V1_0_Encoder::f32_Max_Omega_Change_Rate

private

Maximal omega change rate.

Referenced by Execute(), and TP015_09_V1_0_Encoder().

f32_Omega_Gain

F32 TP015_09_V1_0_Encoder::f32_Omega_Gain

private

Internal variable.

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

f32_Omega_Magnitude_Storage

F32 TP015_09_V1_0_Encoder::f32_Omega_Magnitude_Storage

private

Omega magnitude storage.

Referenced by Execute(), and TP015_09_V1_0_Encoder().

f32_Theta_Gain

F32 TP015_09_V1_0_Encoder::f32_Theta_Gain

private

Internal variable.

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

object_bool_Error

TBlock_Output_Connector TP015_09_V1_0_Encoder::object_bool_Error

Error flag.

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

object_f32_Counter

TBlock_Output_Connector TP015_09_V1_0_Encoder::object_f32_Counter

Encoder counter.

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

object_f32_Counter_Clock_Frequency

TBlock_Input_Connector TP015_09_V1_0_Encoder::object_f32_Counter_Clock_Frequency

[Hz] Counter clock frequency

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

object_f32_Max_Omega_Change_Rate

TBlock_Input_Connector TP015_09_V1_0_Encoder::object_f32_Max_Omega_Change_Rate

[rad/s] Maximal omega change rate

Referenced by Send_Information(), and TP015_09_V1_0_Encoder().

object_f32_Omega

TBlock_Output_Connector TP015_09_V1_0_Encoder::object_f32_Omega

[rad/s] Rotor speed

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

object_f32_Theta

TBlock_Output_Connector TP015_09_V1_0_Encoder::object_f32_Theta

[rad] Rotor theta

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

object_u32_Pulse

TBlock_Input_Connector TP015_09_V1_0_Encoder::object_u32_Pulse

[-] Encoder pulse per revolution

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

struct_Registers

volatile TP015_09_V1_0_Encoder_Registers* TP015_09_V1_0_Encoder::struct_Registers

private

Hardware mapped registers.

Referenced by Execute(), Map(), Send_Information(), and TP015_09_V1_0_Encoder().

u32_Error_Counter

U32 TP015_09_V1_0_Encoder::u32_Error_Counter

private

Error counter.

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

---

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

• ConOpSys/Hardware/P015_09_V1_0/P015_09_V1_0_Encoder.h
• ConOpSys/Hardware/P015_09_V1_0/P015_09_V1_0_Encoder.cpp