ctre::phoenix::platform Namespace Reference

Namespaces
namespace	can

Enumerations
enum	DeviceType { kDeviceTypeListInitializer }
	Enumeration of all supported device types. More...
enum	FrcUsageType {   TalonSRX , PigeonIMU , CANifier , VictorSPX ,   CANcoder , TalonFX , CANdle , CANivore ,   Pigeon2 , TalonFXS , CANdi , CANrange ,   API_Swerve , API_LegacySwerve }

Functions
CTREXPORT void	EnableConsoleUTF8Output ()
	Enables UTF-8 console output.
CTREXPORT void	ReportError (int isError, int32_t errorCode, int isLVCode, const char *details, const char *location, const char *callStack)
static void	SleepUs (int timeUs)
std::chrono::steady_clock::duration	CurrentTimeRaw ()
	The raw current time source.
template<typename DURATION = std::chrono::microseconds>
static auto	CurrentTime ()
	Returns the current time of the system, converted to the given duration.
template<typename DURATION = std::chrono::microseconds>
static auto	SystemTime ()
	Returns the monotonic time of the system, converted to the given duration.
CTREXPORT int	FRC_Report (int resource, int instanceNumber, std::string const &canbus="", int callerIdx=0, int context=0, const char *feature=nullptr)
CTREXPORT int	FRC_Report (std::string const &model, int instanceNumber, std::string const &canbus="", int callerIdx=0, int context=0, const char *feature=nullptr)
CTREXPORT std::string	GetStackTrace (int offset)
	Get a stack trace, ignoring the first "offset" symbols.
CTREXPORT int32_t	SimCreate (DeviceType type, int id)
CTREXPORT int32_t	SimDestroy (DeviceType type, int id)
CTREXPORT int32_t	SimDestroyAll ()
CTREXPORT int32_t	SimSetPhysicsInput (DeviceType type, int id, std::string_view physicsType, double value)
CTREXPORT int32_t	SimGetPhysicsValue (DeviceType type, int id, std::string_view physicsType, double &value)
CTREXPORT int32_t	SimGetLastError (DeviceType type, int id)
CTREXPORT int32_t	ReplayLoadFile (char const *filepath)
CTREXPORT void	ReplayCloseFile ()
CTREXPORT bool	ReplayIsFileLoaded ()
CTREXPORT int32_t	ReplayPlay ()
CTREXPORT int32_t	ReplayPause ()
CTREXPORT int32_t	ReplayStop ()
CTREXPORT bool	ReplayIsRunning (uint16_t timeoutMs)
CTREXPORT void	ReplaySetSpeed (double speed)
CTREXPORT int32_t	ReplayStepTiming (double stepTimeSeconds)

Enumeration Type Documentation

DeviceType

enum ctre::phoenix::platform::DeviceType

Enumeration of all supported device types.

Enumerator
kDeviceTypeListInitializer

FrcUsageType

enum ctre::phoenix::platform::FrcUsageType

Enumerator
TalonSRX
PigeonIMU
CANifier
VictorSPX
CANcoder
TalonFX
CANdle
CANivore
Pigeon2
TalonFXS
CANdi
CANrange
API_Swerve
API_LegacySwerve

Function Documentation

CurrentTime()

template<typename DURATION = std::chrono::microseconds>

static auto ctre::phoenix::platform::CurrentTime ( )

inlinestatic

Returns the current time of the system, converted to the given duration.

The default duration is in microseconds.

This time source is typically continuous and monotonic. However, it may be overridden in simulation to use a non-monotonic, non-continuous source.

CurrentTimeRaw()

std::chrono::steady_clock::duration ctre::phoenix::platform::CurrentTimeRaw

(

)

The raw current time source.

EnableConsoleUTF8Output()

CTREXPORT void ctre::phoenix::platform::EnableConsoleUTF8Output

(

)

Enables UTF-8 console output.

FRC_Report() [1/2]

CTREXPORT int ctre::phoenix::platform::FRC_Report	(	int	resource,
		int	instanceNumber,
		std::string const &	canbus = "",
		int	callerIdx = 0,
		int	context = 0,
		const char *	feature = nullptr )

FRC_Report() [2/2]

CTREXPORT int ctre::phoenix::platform::FRC_Report	(	std::string const &	model,
		int	instanceNumber,
		std::string const &	canbus = "",
		int	callerIdx = 0,
		int	context = 0,
		const char *	feature = nullptr )

GetStackTrace()

CTREXPORT std::string ctre::phoenix::platform::GetStackTrace

(

int

offset

)

Get a stack trace, ignoring the first "offset" symbols.

Parameters

offset

The number of symbols at the top of the stack to ignore

ReplayCloseFile()

CTREXPORT void ctre::phoenix::platform::ReplayCloseFile

(

)

ReplayIsFileLoaded()

CTREXPORT bool ctre::phoenix::platform::ReplayIsFileLoaded

(

)

ReplayIsRunning()

CTREXPORT bool ctre::phoenix::platform::ReplayIsRunning

(

uint16_t

timeoutMs

)

ReplayLoadFile()

CTREXPORT int32_t ctre::phoenix::platform::ReplayLoadFile

(

char const *

filepath

)

ReplayPause()

CTREXPORT int32_t ctre::phoenix::platform::ReplayPause

(

)

ReplayPlay()

CTREXPORT int32_t ctre::phoenix::platform::ReplayPlay

(

)

ReplaySetSpeed()

CTREXPORT void ctre::phoenix::platform::ReplaySetSpeed

(

double

speed

)

ReplayStepTiming()

CTREXPORT int32_t ctre::phoenix::platform::ReplayStepTiming

(

double

stepTimeSeconds

)

ReplayStop()

CTREXPORT int32_t ctre::phoenix::platform::ReplayStop

(

)

ReportError()

CTREXPORT void ctre::phoenix::platform::ReportError	(	int	isError,
		int32_t	errorCode,
		int	isLVCode,
		const char *	details,
		const char *	location,
		const char *	callStack )

SimCreate()

CTREXPORT int32_t ctre::phoenix::platform::SimCreate	(	DeviceType	type,
		int	id )

SimDestroy()

CTREXPORT int32_t ctre::phoenix::platform::SimDestroy	(	DeviceType	type,
		int	id )

SimDestroyAll()

CTREXPORT int32_t ctre::phoenix::platform::SimDestroyAll

(

)

SimGetLastError()

CTREXPORT int32_t ctre::phoenix::platform::SimGetLastError	(	DeviceType	type,
		int	id )

SimGetPhysicsValue()

CTREXPORT int32_t ctre::phoenix::platform::SimGetPhysicsValue	(	DeviceType	type,
		int	id,
		std::string_view	physicsType,
		double &	value )

SimSetPhysicsInput()

CTREXPORT int32_t ctre::phoenix::platform::SimSetPhysicsInput	(	DeviceType	type,
		int	id,
		std::string_view	physicsType,
		double	value )

SleepUs()

static void ctre::phoenix::platform::SleepUs ( int timeUs )

inlinestatic

Parameters

timeUs

How long to yield current thread in microseconds (us). If platform cannot honor us resolution, round up to nearest value that platform can honor.

SystemTime()

template<typename DURATION = std::chrono::microseconds>

static auto ctre::phoenix::platform::SystemTime ( )

inlinestatic

Returns the monotonic time of the system, converted to the given duration.

The default duration is in microseconds.

This time source is guaranteed to be continuous and monotonic.