FilteringCriterion Structure

Represents a criterion for filtering CAN messages.

Definition

Namespace: Peak.Can.Basic
Assembly: PCANBasic.NET (in PCANBasic.NET.dll) Version: 5.1.0

C#

public struct FilteringCriterion

VB

Public Structure FilteringCriterion

C++

public value class FilteringCriterion

FilteringCriterion(MessageType, FilterBehavior)	Initializes a filtering criterion for checking the type of a CAN message.
FilteringCriterion(MessageTypeXL, FilterBehavior)	Initializes a filtering criterion for checking the type of a CAN XL message.
FilteringCriterion(UInt32, FilterMode, FilterBehavior)	Initializes a filtering criterion for a CAN messages using an specific identifier.
FilteringCriterion(UInt32, UInt32, FilterMode, Boolean, FilterBehavior)	Initializes a filtering criterion for accepting a range of CAN identifiers, or for matching a mask/code acceptance value filtering.

AcceptanceCode	Indicates the value of the acceptance code of an acceptance mask/code pair (MaskAndCode).
AcceptanceMask	Indicates the value of the acceptance mask of an acceptance mask/code pair (MaskAndCode).
Behavior	Indicates the operation to perform when a CAN message matches this criterion.
FrameType	Indicates a CAN frame type flags value (MessageType).
FromId	Indicates the begin of a message id range (IdRange).
Kind	Indicates the CAN message related data used for filtering.
Mode	Indicates the type of CAN identifier used for verification (not used when Kind equals MessageType).
SingleId	Indicates a single CAN identifier (SingleId).
ToId	Indicates the end of a message id range (IdRange).

Equals	Indicates whether this instance and a specified object are equal. (Overrides ValueTypeEquals(Object))
GetHashCode	Calculates the hash code for this instance. (Overrides ValueTypeGetHashCode)
GetType	Gets the Type of the current instance. (Inherited from Object)
SetIdRange	Configures this instance to do CAN identifier range filtering.
SetMaskAndCode	Configures this instance for using a mask/code acceptance values filtering
SetMessageType	Configures this instance to do a CAN message type filtering.
SetSingleId	Configures this instance to do single CAN identifier filtering.
ToString	Converts the value of this instance to its equivalent string representation. (Overrides ValueTypeToString)

Equality(FilteringCriterion, FilteringCriterion)	Checks if two FilteringCriterion instances are equal.
Inequality(FilteringCriterion, FilteringCriterion)	Checks if two FilteringCriterion instances are not equal.