isobus::VirtualTerminalClient::AssignedAuxiliaryFunction Class Reference

A struct for storing information of a function assigned to an auxiliary input. More...

#include <isobus_virtual_terminal_client.hpp>

Public Member Functions
	AssignedAuxiliaryFunction (std::uint16_t functionObjectID, std::uint16_t inputObjectID, AuxiliaryTypeTwoFunctionType functionType)
	Constructs a AssignedAuxiliaryFunction, sets default values.
bool	operator== (const AssignedAuxiliaryFunction &other) const
	Allows easy comparison of two AssignedAuxiliaryFunction objects.

Public Attributes
std::uint16_t	functionObjectID
	The object ID of the function present in our object pool.
std::uint16_t	inputObjectID
	The object ID assigned on the auxiliary inputs end.
AuxiliaryTypeTwoFunctionType	functionType
	The type of function.

Detailed Description

A struct for storing information of a function assigned to an auxiliary input.

Definition at line 356 of file isobus_virtual_terminal_client.hpp.

Constructor & Destructor Documentation

AssignedAuxiliaryFunction()

isobus::VirtualTerminalClient::AssignedAuxiliaryFunction::AssignedAuxiliaryFunction	(	std::uint16_t	functionObjectID,
		std::uint16_t	inputObjectID,
		AuxiliaryTypeTwoFunctionType	functionType )

Constructs a AssignedAuxiliaryFunction, sets default values.

Parameters

[in]	functionObjectID	the object ID of the function present in our object pool
[in]	inputObjectID	the object ID assigned on the auxiliary inputs end
[in]	functionType	the type of function

Definition at line 256 of file isobus_virtual_terminal_client.cpp.

Member Function Documentation

operator==()

bool isobus::VirtualTerminalClient::AssignedAuxiliaryFunction::operator==

(

const AssignedAuxiliaryFunction &

other

)

const

Allows easy comparison of two AssignedAuxiliaryFunction objects.

Parameters

[in]

other

the object to compare against

Returns

true if the objects are equal, false otherwise

Definition at line 261 of file isobus_virtual_terminal_client.cpp.

Member Data Documentation

functionObjectID

std::uint16_t isobus::VirtualTerminalClient::AssignedAuxiliaryFunction::functionObjectID

The object ID of the function present in our object pool.

Definition at line 370 of file isobus_virtual_terminal_client.hpp.

functionType

AuxiliaryTypeTwoFunctionType isobus::VirtualTerminalClient::AssignedAuxiliaryFunction::functionType

The type of function.

Definition at line 372 of file isobus_virtual_terminal_client.hpp.

inputObjectID

std::uint16_t isobus::VirtualTerminalClient::AssignedAuxiliaryFunction::inputObjectID

The object ID assigned on the auxiliary inputs end.

Definition at line 371 of file isobus_virtual_terminal_client.hpp.

---

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

• isobus/include/isobus/isobus/isobus_virtual_terminal_client.hpp
• isobus/src/isobus_virtual_terminal_client.cpp