studica::TitanSmall Class Reference

TitanSmall class testing c++ documentation. More...

#include <TitanSmall.h>

Inheritance diagram for studica::TitanSmall:

Public Member Functions
	TitanSmall (int deviceID, int frequency)
	TitanSmall (int deviceID)
	~TitanSmall ()
int	GetID ()
int	GetFrequency ()
std::string	GetFirmwareVersion ()
std::string	GetHardwareVersion ()
void	Set (double speed) override
double	Get () const override
void	SetInverted (bool isInverted) override
bool	GetInverted () const override
void	Disable () override
void	StopMotor () override
double	GetCurrent ()
void	SetMotorSpeed (double speed)
void	SetCurrentLimit ()
double	GetLimitSwitch (bool direction)
int	GetFaults ()
void	ClearFaults ()
bool	EnableSoftLimit ()
std::string	GetSerialNumber ()

Friends
class	TitanSmallEncoder

Detailed Description

TitanSmall class testing c++ documentation.

Author

Studica Limited

Date

April 2020

Constructor & Destructor Documentation

TitanSmall() [1/2]

studica::TitanSmall::TitanSmall	(	int	deviceID,
		int	frequency
	)

Creates a new Titan.

Parameters

deviceID	- Initializes the device ID
frequency	- Defining the Titan's frequency

TitanSmall() [2/2]

studica::TitanSmall::TitanSmall

(

int

deviceID

)

Constructor for Titan Motor Controller

Parameters

deviceID

- Device id for the controller

~TitanSmall()

studica::TitanSmall::~TitanSmall

(

)

Closes Titan.

Member Function Documentation

ClearFaults()

void studica::TitanSmall::ClearFaults

(

)

clear faults

EnableSoftLimit()

bool studica::TitanSmall::EnableSoftLimit

(

)

enable soft limit

Returns

enabled or disabled

GetCurrent()

double studica::TitanSmall::GetCurrent

(

)

Gets the current of the specified motor.

Returns

The current of the specified motor.

GetFaults()

int studica::TitanSmall::GetFaults

(

)

Get faults

Returns

faults

GetFirmwareVersion()

std::string studica::TitanSmall::GetFirmwareVersion

(

)

Gets the current firmware version of the Titan.

Returns

Firmware verion of the Titan in string format.

GetFrequency()

int studica::TitanSmall::GetFrequency

(

)

Gets the current frequency of the Titan.

Returns

Frequency of the Titan.

GetHardwareVersion()

std::string studica::TitanSmall::GetHardwareVersion

(

)

Gets the current hardware version of the Titan.

Returns

Hardware version of the Titan in string format.

GetID()

int studica::TitanSmall::GetID

(

)

Gets the current device ID of the Titan.

Returns

Device ID of the Titan.

GetLimitSwitch()

double studica::TitanSmall::GetLimitSwitch

(

bool

direction

)

Get limit switch

Parameters

direction

- forward or reverse

Returns

limit switch

GetSerialNumber()

std::string studica::TitanSmall::GetSerialNumber

(

)

Get serial number

Returns

serial number

Set()

void studica::TitanSmall::Set ( double  speed )

override

Configures the specified motor. Disables the specified motor Common interface for setting the speed of a speed controller.

Parameters

speed

The speed to set. Value should be between -1.0 and 1.0.

SetCurrentLimit()

void studica::TitanSmall::SetCurrentLimit

(

)

Set current limit

SetMotorSpeed()

void studica::TitanSmall::SetMotorSpeed

(

double

speed

)

Sets the speed of the specified motor.

Parameters

speed

- The speed to control the motor.

---

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

• C:/Users/Studica/Studica/Studica/src/main/native/include/studica/TitanSmall.h