AgIsoStack++
A control-function-focused implementation of the major ISOBUS and J1939 protocols
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
isobus::ParameterGroupNumberRequestProtocol::PGNRequestCallbackInfo Class Reference

A storage class for holding PGN callbacks and their associated PGN. More...

Public Member Functions

 PGNRequestCallbackInfo (PGNRequestCallback callback, std::uint32_t parameterGroupNumber, void *parentPointer)
 Constructor for PGNRequestCallbackInfo.
 
bool operator== (const PGNRequestCallbackInfo &obj) const
 A utility function for determining if the data in the object is equal to another object.
 

Public Attributes

PGNRequestCallback callbackFunction
 The actual callback.
 
std::uint32_t pgn
 The PGN associated with the callback.
 
void * parent
 Pointer to the class that registered the callback, or nullptr
 

Detailed Description

A storage class for holding PGN callbacks and their associated PGN.

Definition at line 100 of file can_parameter_group_number_request_protocol.hpp.

Constructor & Destructor Documentation

◆ PGNRequestCallbackInfo()

isobus::ParameterGroupNumberRequestProtocol::PGNRequestCallbackInfo::PGNRequestCallbackInfo ( PGNRequestCallback callback,
std::uint32_t parameterGroupNumber,
void * parentPointer )

Constructor for PGNRequestCallbackInfo.

Parameters
[in]callbackA PGNRequestCallback
[in]parameterGroupNumberThe PGN associated with the callback
[in]parentPointerPointer to the class that registered the callback, or nullptr

Definition at line 141 of file can_parameter_group_number_request_protocol.cpp.

Member Function Documentation

◆ operator==()

bool isobus::ParameterGroupNumberRequestProtocol::PGNRequestCallbackInfo::operator== ( const PGNRequestCallbackInfo & obj) const

A utility function for determining if the data in the object is equal to another object.

The objects are the same if the pgn and callbackFunction both match

Parameters
[in]objThe object to compare against
Returns
true if the objects have identical data

Definition at line 155 of file can_parameter_group_number_request_protocol.cpp.

Member Data Documentation

◆ callbackFunction

PGNRequestCallback isobus::ParameterGroupNumberRequestProtocol::PGNRequestCallbackInfo::callbackFunction

The actual callback.

Definition at line 115 of file can_parameter_group_number_request_protocol.hpp.

◆ parent

void* isobus::ParameterGroupNumberRequestProtocol::PGNRequestCallbackInfo::parent

Pointer to the class that registered the callback, or nullptr

Definition at line 117 of file can_parameter_group_number_request_protocol.hpp.

◆ pgn

std::uint32_t isobus::ParameterGroupNumberRequestProtocol::PGNRequestCallbackInfo::pgn

The PGN associated with the callback.

Definition at line 116 of file can_parameter_group_number_request_protocol.hpp.


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