A class that associates a NAME parameter with a value of that parameter. More...

#include <can_NAME_filter.hpp>

Public Member Functions
	NAMEFilter (NAME::NAMEParameters nameParameter, std::uint32_t parameterMatchValue)
	Constructor for the NAMEFilter.

NAME::NAMEParameters	get_parameter () const
	Returns the parameter data associated with this filter.

std::uint32_t	get_value () const
	Returns the value associated with this filter.

bool	check_name_matches_filter (const NAME &nameToCompare) const
	Returns true if a NAME matches this filter class's components.

Private Attributes
NAME::NAMEParameters	parameter
	The NAME component to filter against.

std::uint32_t	value
	The value of the data associated with the filter component.

Detailed Description

A class that associates a NAME parameter with a value of that parameter.

This class is used to match a partner control function with specific criteria that defines it. Use these to define what device you want to talk to.

Definition at line 25 of file can_NAME_filter.hpp.

Constructor & Destructor Documentation

◆ NAMEFilter()

isobus::NAMEFilter::NAMEFilter	(	NAME::NAMEParameters	nameParameter,
		std::uint32_t	parameterMatchValue )

Constructor for the NAMEFilter.

Parameters

[in]	nameParameter	The component of the NAME to filter on
[in]	parameterMatchValue	The value to match with the nameParameter

Definition at line 14 of file can_NAME_filter.cpp.

Member Function Documentation

◆ check_name_matches_filter()

bool isobus::NAMEFilter::check_name_matches_filter ( const NAME & nameToCompare ) const

Returns true if a NAME matches this filter class's components.

Parameters

[in] nameToCompare A NAME to compare against this filter

Returns: true if a NAME matches this filter class's components

Definition at line 30 of file can_NAME_filter.cpp.

Here is the call graph for this function:

◆ get_parameter()

NAME::NAMEParameters isobus::NAMEFilter::get_parameter ( ) const

Returns the parameter data associated with this filter.

Returns: The parameter/NAME component associated with this filter

Definition at line 20 of file can_NAME_filter.cpp.

◆ get_value()

std::uint32_t isobus::NAMEFilter::get_value ( ) const

Returns the value associated with this filter.

Returns: The data associated with this filter component

Definition at line 25 of file can_NAME_filter.cpp.

Member Data Documentation

◆ parameter

NAME::NAMEParameters isobus::NAMEFilter::parameter

private

The NAME component to filter against.

Definition at line 47 of file can_NAME_filter.hpp.

◆ value

std::uint32_t isobus::NAMEFilter::value

private

The value of the data associated with the filter component.

Definition at line 48 of file can_NAME_filter.hpp.

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

isobus/include/isobus/isobus/can_NAME_filter.hpp
isobus/src/can_NAME_filter.cpp

Public Member Functions

Private Attributes