Extern analog input board P018.20 class. More...

#include <P018_20_KG3_EXT_VI.h>

Inheritance diagram for TP018_20_KG3_EXT_VI:

Collaboration diagram for TP018_20_KG3_EXT_VI:

Classes
struct	TP018_20_KG3_EXT_VI_Registers

union	TStatus

Public Member Functions
	TP018_20_KG3_EXT_VI ()
	Constructor method. More...

	~TP018_20_KG3_EXT_VI ()
	Destructor method. More...

VOID	Map (TP018_20_KG3_EXT_VI_Registers *struct_Registers_Base_Address)
	Analog input board P017.42 KG3 AI memory map. More...

virtual VOID	Init ()
	Analog input board P018.20 object initialization. More...

virtual VOID	Execute ()
	Analog input board P017.42 KG3 AI execute method. More...

virtual VOID	Send_Information (TProtocol_Base *object_Protocol)
	Send detailed information about functional block. More...

Public Attributes
TBlock_Input_Connector	object_f32_Analog_Input_Full_Scale_1
	Analog input channel 1 fill scale value. Also used for channel total gain adjustment. More...

TBlock_Input_Connector	object_f32_Analog_Input_Full_Scale_2
	Analog input channel 2 fill scale value. Also used for channel total gain adjustment. More...

TBlock_Input_Connector	object_f32_Analog_Input_Full_Scale_3
	Analog input channel 3 fill scale value. Also used for channel total gain adjustment. More...

TBlock_Input_Connector	object_f32_Analog_Input_Offset_1
	Analog input channel 1 offset. More...

TBlock_Input_Connector	object_f32_Analog_Input_Offset_2
	Analog input channel 2 offset. More...

TBlock_Input_Connector	object_f32_Analog_Input_Offset_3
	Analog input channel 3 offset. More...

TBlock_Input_Connector	object_bool_Negate
	Negate input analog signal value. More...

TBlock_Input_Connector	object_f32_Software_Overcurrent_Level
	Software defined overcurrent level. More...

U16	u16_Analog_Input_Status
	Analog input status. More...

I16	i16_Analog_Input_Data_1
	Analog input channel 1 block output as I16. More...

I16	i16_Analog_Input_Data_2
	Analog input channel 2 block output as I16. More...

I16	i16_Analog_Input_Data_3
	Analog input channel 3 block output as I16. More...

TBlock_Output_Connector	object_f32_Analog_Input_Data_1
	Analog input channel 1 block output. More...

TBlock_Output_Connector	object_f32_Analog_Input_Data_2
	Analog input channel 2 block output. More...

TBlock_Output_Connector	object_f32_Analog_Input_Data_3
	Analog input channel 3 block output. More...

TBlock_Output_Connector	object_f32_Analog_Input_Data_DC
	Analog input channels DC offset. More...

TBlock_Output_Connector	object_bool_Hardware_Error
	Critical hardware error flag. More...

TBlock_Output_Connector	object_bool_Symmenty_Error
	Signal symmery error flag. More...

TBlock_Output_Connector	object_bool_Magnitude_Hardware_Level_Error
	Hardware overcurrent limit. More...

TBlock_Output_Connector	object_bool_Software_Overcurrent

Private Attributes
volatile TP018_20_KG3_EXT_VI_Registers *	struct_Registers
	Hardware mapped registers. More...

F32	f32_Gain_1
	Effective gain of the channel 1. More...

F32	f32_Gain_2
	Effective gain of the channel 2. More...

F32	f32_Gain_3
	Effective gain of the channel 3. More...

F32	f32_Offset_1
	Effective offset of the channel 1. More...

F32	f32_Offset_2
	Effective offset of the channel 2. More...

F32	f32_Offset_3
	Effective offset of the channel 3. More...

Detailed Description

Extern analog input board P018.20 class.

Constructor & Destructor Documentation

◆ TP018_20_KG3_EXT_VI()

TP018_20_KG3_EXT_VI::TP018_20_KG3_EXT_VI ( )

Constructor method.

Analog input board P018.20 object conctructor.

Returns: Pointer to the object

Note: None

References f32_Gain_1, f32_Gain_2, f32_Gain_3, f32_Offset_1, f32_Offset_2, f32_Offset_3, i16_Analog_Input_Data_1, i16_Analog_Input_Data_2, i16_Analog_Input_Data_3, object_bool_Hardware_Error, object_bool_Magnitude_Hardware_Level_Error, object_bool_Negate, object_bool_Software_Overcurrent, object_bool_Symmenty_Error, object_f32_Analog_Input_Data_1, object_f32_Analog_Input_Data_2, object_f32_Analog_Input_Data_3, object_f32_Analog_Input_Data_DC, object_f32_Analog_Input_Full_Scale_1, object_f32_Analog_Input_Full_Scale_2, object_f32_Analog_Input_Full_Scale_3, object_f32_Analog_Input_Offset_1, object_f32_Analog_Input_Offset_2, object_f32_Analog_Input_Offset_3, object_f32_Software_Overcurrent_Level, TBlock_Connector::Set_Type(), TBlock_Input_Connector::Set_Type(), and u16_Analog_Input_Status.

Here is the call graph for this function:

◆ ~TP018_20_KG3_EXT_VI()

TP018_20_KG3_EXT_VI::~TP018_20_KG3_EXT_VI ( )

Destructor method.

Analog input board P018.20 object destructor.

Returns: None

Note: None

Member Function Documentation

◆ Execute()

__forceinline VOID TP018_20_KG3_EXT_VI::Execute ( )

virtual

Analog input board P017.42 KG3 AI execute method.

Returns: None

Note: None

References TConOpSys_Variant_Data::bool_Value, f32_Gain_1, f32_Gain_2, f32_Gain_3, f32_Offset_1, f32_Offset_2, f32_Offset_3, TConOpSys_Variant_Data::f32_Value, TP018_20_KG3_EXT_VI::TP018_20_KG3_EXT_VI_Registers::i16_Analog_Input_Data_1, i16_Analog_Input_Data_1, TP018_20_KG3_EXT_VI::TP018_20_KG3_EXT_VI_Registers::i16_Analog_Input_Data_2, i16_Analog_Input_Data_2, TP018_20_KG3_EXT_VI::TP018_20_KG3_EXT_VI_Registers::i16_Analog_Input_Data_3, i16_Analog_Input_Data_3, object_bool_Software_Overcurrent, object_f32_Analog_Input_Data_1, object_f32_Analog_Input_Data_2, object_f32_Analog_Input_Data_3, object_f32_Analog_Input_Data_DC, object_f32_Software_Overcurrent_Level, TBlock_Input_Connector::object_Pointer, TBlock_Connector::object_Storage, TConOpSys_Variant_Data::pf32_Value, TConOpSys_Variant::struct_Data, struct_Registers, u16_Analog_Input_Status, and TP018_20_KG3_EXT_VI::TP018_20_KG3_EXT_VI_Registers::u16_Status.

◆ Init()

VOID TP018_20_KG3_EXT_VI::Init ( )

virtual

Analog input board P018.20 object initialization.

Returns: None

Note: None

References f32_Gain_1, f32_Gain_2, f32_Gain_3, f32_Offset_1, f32_Offset_2, f32_Offset_3, false, object_bool_Negate, object_f32_Analog_Input_Full_Scale_1, object_f32_Analog_Input_Full_Scale_2, object_f32_Analog_Input_Full_Scale_3, object_f32_Analog_Input_Offset_1, object_f32_Analog_Input_Offset_2, object_f32_Analog_Input_Offset_3, TBlock_Input_Connector::object_Pointer, TConOpSys_Variant_Data::pbool_Value, TConOpSys_Variant_Data::pf32_Value, and TConOpSys_Variant::struct_Data.

◆ Map()

VOID TP018_20_KG3_EXT_VI::Map ( TP018_20_KG3_EXT_VI_Registers * struct_Registers_Base_Address )

Analog input board P017.42 KG3 AI memory map.

Parameters

[in] struct_Registers_Base_Address Base address within FPGA address space

Returns: None

Note: None

References struct_Registers.

◆ Send_Information()

VOID TP018_20_KG3_EXT_VI::Send_Information ( TProtocol_Base * object_Protocol )

virtual

Send detailed information about functional block.

Parameters

[in] object_Protocol Pointer to the communication protocol object

Returns: None

Note: None

References TConOpSys_Variant_Data::f32_Value, i16_Analog_Input_Data_1, i16_Analog_Input_Data_2, i16_Analog_Input_Data_3, TP018_20_KG3_EXT_VI::TP018_20_KG3_EXT_VI_Registers::i16_Analog_Input_Filtered_Data_1, TP018_20_KG3_EXT_VI::TP018_20_KG3_EXT_VI_Registers::i16_Analog_Input_Filtered_Data_2, TP018_20_KG3_EXT_VI::TP018_20_KG3_EXT_VI_Registers::i16_Analog_Input_Filtered_Data_3, object_f32_Analog_Input_Data_1, object_f32_Analog_Input_Data_2, object_f32_Analog_Input_Data_3, object_f32_Analog_Input_Data_DC, TBlock_Connector::object_Storage, TConOpSys_Variant::struct_Data, struct_Registers, 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(), TProtocol_Base::Transmit_U16_Value_As_Hex(), u16_Analog_Input_Status, and TP018_20_KG3_EXT_VI::TP018_20_KG3_EXT_VI_Registers::u16_Module_ID.

Here is the call graph for this function:

Member Data Documentation

◆ f32_Gain_1

F32 TP018_20_KG3_EXT_VI::f32_Gain_1

private

Effective gain of the channel 1.

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

◆ f32_Gain_2

F32 TP018_20_KG3_EXT_VI::f32_Gain_2

private

Effective gain of the channel 2.

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

◆ f32_Gain_3

F32 TP018_20_KG3_EXT_VI::f32_Gain_3

private

Effective gain of the channel 3.

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

◆ f32_Offset_1

F32 TP018_20_KG3_EXT_VI::f32_Offset_1

private

Effective offset of the channel 1.

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

◆ f32_Offset_2

F32 TP018_20_KG3_EXT_VI::f32_Offset_2

private

Effective offset of the channel 2.

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

◆ f32_Offset_3

F32 TP018_20_KG3_EXT_VI::f32_Offset_3

private

Effective offset of the channel 3.

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

◆ i16_Analog_Input_Data_1

I16 TP018_20_KG3_EXT_VI::i16_Analog_Input_Data_1

Analog input channel 1 block output as I16.

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

◆ i16_Analog_Input_Data_2

I16 TP018_20_KG3_EXT_VI::i16_Analog_Input_Data_2

Analog input channel 2 block output as I16.

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

◆ i16_Analog_Input_Data_3

I16 TP018_20_KG3_EXT_VI::i16_Analog_Input_Data_3

Analog input channel 3 block output as I16.

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

◆ object_bool_Hardware_Error

TBlock_Output_Connector TP018_20_KG3_EXT_VI::object_bool_Hardware_Error

Critical hardware error flag.

Referenced by TP018_20_KG3_EXT_VI().

◆ object_bool_Magnitude_Hardware_Level_Error

TBlock_Output_Connector TP018_20_KG3_EXT_VI::object_bool_Magnitude_Hardware_Level_Error

Hardware overcurrent limit.

Referenced by TP018_20_KG3_EXT_VI().

◆ object_bool_Negate

TBlock_Input_Connector TP018_20_KG3_EXT_VI::object_bool_Negate

Negate input analog signal value.

Referenced by Init(), and TP018_20_KG3_EXT_VI().

◆ object_bool_Software_Overcurrent

TBlock_Output_Connector TP018_20_KG3_EXT_VI::object_bool_Software_Overcurrent

Referenced by Execute(), and TP018_20_KG3_EXT_VI().

◆ object_bool_Symmenty_Error

TBlock_Output_Connector TP018_20_KG3_EXT_VI::object_bool_Symmenty_Error

Signal symmery error flag.

Referenced by TP018_20_KG3_EXT_VI().

◆ object_f32_Analog_Input_Data_1

TBlock_Output_Connector TP018_20_KG3_EXT_VI::object_f32_Analog_Input_Data_1

Analog input channel 1 block output.

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

◆ object_f32_Analog_Input_Data_2

TBlock_Output_Connector TP018_20_KG3_EXT_VI::object_f32_Analog_Input_Data_2

Analog input channel 2 block output.

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

◆ object_f32_Analog_Input_Data_3

TBlock_Output_Connector TP018_20_KG3_EXT_VI::object_f32_Analog_Input_Data_3

Analog input channel 3 block output.

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

◆ object_f32_Analog_Input_Data_DC

TBlock_Output_Connector TP018_20_KG3_EXT_VI::object_f32_Analog_Input_Data_DC

Analog input channels DC offset.

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

◆ object_f32_Analog_Input_Full_Scale_1

TBlock_Input_Connector TP018_20_KG3_EXT_VI::object_f32_Analog_Input_Full_Scale_1

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

Referenced by Init(), and TP018_20_KG3_EXT_VI().

◆ object_f32_Analog_Input_Full_Scale_2

TBlock_Input_Connector TP018_20_KG3_EXT_VI::object_f32_Analog_Input_Full_Scale_2

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

Referenced by Init(), and TP018_20_KG3_EXT_VI().

◆ object_f32_Analog_Input_Full_Scale_3

TBlock_Input_Connector TP018_20_KG3_EXT_VI::object_f32_Analog_Input_Full_Scale_3

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

Referenced by Init(), and TP018_20_KG3_EXT_VI().

◆ object_f32_Analog_Input_Offset_1

TBlock_Input_Connector TP018_20_KG3_EXT_VI::object_f32_Analog_Input_Offset_1

Analog input channel 1 offset.

Referenced by Init(), and TP018_20_KG3_EXT_VI().

◆ object_f32_Analog_Input_Offset_2

TBlock_Input_Connector TP018_20_KG3_EXT_VI::object_f32_Analog_Input_Offset_2

Analog input channel 2 offset.

Referenced by Init(), and TP018_20_KG3_EXT_VI().

◆ object_f32_Analog_Input_Offset_3

TBlock_Input_Connector TP018_20_KG3_EXT_VI::object_f32_Analog_Input_Offset_3

Analog input channel 3 offset.

Referenced by Init(), and TP018_20_KG3_EXT_VI().

◆ object_f32_Software_Overcurrent_Level

TBlock_Input_Connector TP018_20_KG3_EXT_VI::object_f32_Software_Overcurrent_Level

Software defined overcurrent level.

Referenced by Execute(), and TP018_20_KG3_EXT_VI().

◆ struct_Registers

volatile TP018_20_KG3_EXT_VI_Registers* TP018_20_KG3_EXT_VI::struct_Registers

private

Hardware mapped registers.

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

◆ u16_Analog_Input_Status

U16 TP018_20_KG3_EXT_VI::u16_Analog_Input_Status

Analog input status.

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

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

ConOpSys/Hardware/P018_20_KG3_EXT_VI/P018_20_KG3_EXT_VI.h
ConOpSys/Hardware/P018_20_KG3_EXT_VI/P018_20_KG3_EXT_VI.cpp

Classes

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TP018_20_KG3_EXT_VI()

◆ ~TP018_20_KG3_EXT_VI()

Member Function Documentation

◆ Execute()

◆ Init()

◆ Map()

◆ Send_Information()

Member Data Documentation

◆ f32_Gain_1

◆ f32_Gain_2

◆ f32_Gain_3

◆ f32_Offset_1

◆ f32_Offset_2

◆ f32_Offset_3

◆ i16_Analog_Input_Data_1

◆ i16_Analog_Input_Data_2

◆ i16_Analog_Input_Data_3

◆ object_bool_Hardware_Error

◆ object_bool_Magnitude_Hardware_Level_Error

◆ object_bool_Negate

◆ object_bool_Software_Overcurrent

◆ object_bool_Symmenty_Error

◆ object_f32_Analog_Input_Data_1

◆ object_f32_Analog_Input_Data_2

◆ object_f32_Analog_Input_Data_3

◆ object_f32_Analog_Input_Data_DC

◆ object_f32_Analog_Input_Full_Scale_1

◆ object_f32_Analog_Input_Full_Scale_2

◆ object_f32_Analog_Input_Full_Scale_3

◆ object_f32_Analog_Input_Offset_1

◆ object_f32_Analog_Input_Offset_2

◆ object_f32_Analog_Input_Offset_3

◆ object_f32_Software_Overcurrent_Level

◆ struct_Registers

◆ u16_Analog_Input_Status