#include <DetachedEncoderLowLevel.h>

Inherited by rev::detached::DetachedEncoder.

Classes
struct	FirmwareVersion

struct	PeriodicStatus0

struct	PeriodicStatus1

struct	PeriodicStatus2

struct	PeriodicStatus3

struct	PeriodicStatus4

Public Types
enum class	EncoderModel { kUnknown = 0 , kMAXSplineEncoder = 1 }

Public Member Functions
virtual	~DetachedEncoderLowLevel ()

int	GetDeviceId () const

EncoderModel	GetEncoderModel () const

FirmwareVersion	GetFirmwareVersion () const

PeriodicStatus0	GetPeriodicStatus0 () const

PeriodicStatus1	GetPeriodicStatus1 () const

PeriodicStatus2	GetPeriodicStatus2 () const

PeriodicStatus3	GetPeriodicStatus3 () const

PeriodicStatus4	GetPeriodicStatus4 () const

void	CreateSimFaultManager ()

Protected Member Functions
	DetachedEncoderLowLevel (int deviceID, EncoderModel model)

Protected Attributes
void *	m_detachedEncoderHandle {nullptr}

Member Enumeration Documentation

◆ EncoderModel

enum class rev::detached::DetachedEncoderLowLevel::EncoderModel

strong

Enumerator
kUnknown
kMAXSplineEncoder

Constructor & Destructor Documentation

◆ ~DetachedEncoderLowLevel()

DetachedEncoderLowLevel::~DetachedEncoderLowLevel ( )

virtual

Closes the Detached Encoder

◆ DetachedEncoderLowLevel()

DetachedEncoderLowLevel::DetachedEncoderLowLevel	(	int	deviceID,
		EncoderModel	model
	)

explicitprotected

Member Function Documentation

◆ GetDeviceId()

int DetachedEncoderLowLevel::GetDeviceId ( ) const

Get the configured Device ID of the Detached encoder.

Returns: int device ID

◆ GetEncoderModel()

DetachedEncoderLowLevel::EncoderModel DetachedEncoderLowLevel::GetEncoderModel ( ) const

Get the Model of this Detached Encoder Device. Useful for determining if this is a MAXSpline, or other device

Returns: the model of this encoder

◆ GetFirmwareVersion()

DetachedEncoderLowLevel::FirmwareVersion DetachedEncoderLowLevel::GetFirmwareVersion ( ) const

Get the firmware version of the detached encoder.

Returns: Firmware version object

◆ GetPeriodicStatus0()

DetachedEncoderLowLevel::PeriodicStatus0 DetachedEncoderLowLevel::GetPeriodicStatus0 ( ) const

Get Periodic Status 0 for the Detached Encoder.

Returns: PeriodicStatus0 Periodic status 0

◆ GetPeriodicStatus1()

DetachedEncoderLowLevel::PeriodicStatus1 DetachedEncoderLowLevel::GetPeriodicStatus1 ( ) const

Get Periodic Status 1 for the Detached Encoder.

Returns: PeriodicStatus1 Periodic status 1

◆ GetPeriodicStatus2()

DetachedEncoderLowLevel::PeriodicStatus2 DetachedEncoderLowLevel::GetPeriodicStatus2 ( ) const

Get Periodic Status 2 for the Detached Encoder.

Returns: PeriodicStatus2 Periodic status 2

◆ GetPeriodicStatus3()

DetachedEncoderLowLevel::PeriodicStatus3 DetachedEncoderLowLevel::GetPeriodicStatus3 ( ) const

Get Periodic Status 3 for the Detached Encoder.

Returns: PeriodicStatus3 Periodic status 3

◆ GetPeriodicStatus4()

DetachedEncoderLowLevel::PeriodicStatus4 DetachedEncoderLowLevel::GetPeriodicStatus4 ( ) const

Get Periodic Status 4 for the Detached Encoder.

Returns: PeriodicStatus4 Periodic status 4

◆ CreateSimFaultManager()

void DetachedEncoderLowLevel::CreateSimFaultManager ( )

Create the sim gui Fault Manager for this Detached Encoder device

Member Data Documentation

◆ m_detachedEncoderHandle

void* rev::detached::DetachedEncoderLowLevel::m_detachedEncoderHandle {nullptr}

protected

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

src/main/native/include/rev/DetachedEncoderLowLevel.h
src/main/native/cpp/DetachedEncoderLowLevel.cpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes