IGadgeteerUartClient Class Reference

Interface for uart gadgeteer devices. More...

#include <ctre/phoenix/core/GadgeteerUartClient.h>

Classes
struct	GadgeteerUartStatus
	The status of the gadgeteer device. More...

Public Types
enum	GadgeteerProxyType { General = 0 , Pigeon = 1 , PC_HERO = 2 }
	Device connected to gadgeteer. More...
enum	GadgeteerConnection { NotConnected = 0 , Connecting = 1 , Connected = 2 }
	Method of connection to gadgeteer. More...

Public Member Functions
	IGadgeteerUartClient ()
virtual	~IGadgeteerUartClient ()
virtual int	GetGadgeteerStatus (GadgeteerUartStatus &status)=0
	Gets gadgeteer status. More...

Static Public Member Functions
static std::string	ToString (IGadgeteerUartClient::GadgeteerProxyType gpt)
	Gets the string representation of GadgeteerProxyType. More...
static std::string	ToString (IGadgeteerUartClient::GadgeteerConnection gc)
	Gets the string representation of GadgeteerConnection. More...

Detailed Description

Interface for uart gadgeteer devices.

Member Enumeration Documentation

GadgeteerConnection

enum IGadgeteerUartClient::GadgeteerConnection

Method of connection to gadgeteer.

Enumerator
NotConnected	Device not connected.
Connecting	Device in process of connecting.
Connected	Device is connected.

GadgeteerProxyType

enum IGadgeteerUartClient::GadgeteerProxyType

Device connected to gadgeteer.

Enumerator
General	General Gadgeteer Proxy.
Pigeon	Pigeon connected to gadgeteer.
PC_HERO	HERO connected to gadgeteer.

Constructor & Destructor Documentation

IGadgeteerUartClient()

IGadgeteerUartClient::IGadgeteerUartClient ( )

inline

~IGadgeteerUartClient()

virtual IGadgeteerUartClient::~IGadgeteerUartClient ( )

inlinevirtual

Member Function Documentation

GetGadgeteerStatus()

virtual int IGadgeteerUartClient::GetGadgeteerStatus ( GadgeteerUartStatus &  status )

pure virtual

Gets gadgeteer status.

Parameters

status

status object to fill

Returns

ErrorCode

ToString() [1/2]

static std::string IGadgeteerUartClient::ToString ( IGadgeteerUartClient::GadgeteerConnection  gc )

inlinestatic

Gets the string representation of GadgeteerConnection.

Parameters

gc	GadgeteerConnection to get the string of

Returns

strnig representation of GadgeteerConnection

ToString() [2/2]

static std::string IGadgeteerUartClient::ToString ( IGadgeteerUartClient::GadgeteerProxyType  gpt )

inlinestatic

Gets the string representation of GadgeteerProxyType.

Parameters

gpt	GadgeteerProxyType to get the string of

Returns

strnig representation of GadgeteerProxyType

---

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

• ctre/phoenix/core/GadgeteerUartClient.h