redux::canand::CANBus Class Reference

#include <CANBus.h>

Public Member Functions
	CANBus (uint8_t descriptorId)
uint8_t	GetDescriptor ()
bool	Equals (CANBus other)

Detailed Description

Class representing CAN buses that may exist on a robot.

Currently, only the Rio's onboard CAN bus is supported.

Constructor & Destructor Documentation

CANBus()

redux::canand::CANBus::CANBus ( uint8_t  descriptorId )

inline

Constructs a new CAN bus from a descriptor value. 0 is the Rio's onboard bus.

Parameters

descriptorId

the CAN bus descriptor value.

Member Function Documentation

Equals()

bool redux::canand::CANBus::Equals ( CANBus  other )

inline

Returns whether two CANBus objects refer to the same bus.

Parameters

other

other CANBus object to compare against

Returns

whether or not they refer to the same bus

GetDescriptor()

uint8_t redux::canand::CANBus::GetDescriptor ( )

inline

Returns the descriptor ID associated with the CAN bus object. Generally not needed to be used directly.

Returns

the descriptor ID.

---

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

• src/main/native/include/redux/canand/CANBus.h