CTRE_Phoenix  5.19.4
ctre::phoenix::motion::BufferedTrajectoryPointStream Class Reference

#include <BufferedTrajectoryPointStream.h>

Public Member Functions

 BufferedTrajectoryPointStream (const BufferedTrajectoryPointStream &)=delete
 
BufferedTrajectoryPointStreamoperator= (const BufferedTrajectoryPointStream &)=delete
 
ctre::phoenix::ErrorCode Clear ()
 Clear all trajectory points. More...
 
ctre::phoenix::ErrorCode Write (const TrajectoryPoint &trajPt)
 Write a single trajectory point into the buffer. More...
 
ctre::phoenix::ErrorCode Write (const TrajectoryPoint *trajPts, uint32_t trajPtCount)
 Writes an array of trajectory point into the buffer. More...
 
void * GetHandle ()
 

Detailed Description

Stream of trajectory points for Talon/Victor motion profiling.

Member Function Documentation

◆ Clear()

ctre::phoenix::ErrorCode ctre::phoenix::motion::BufferedTrajectoryPointStream::Clear ( )

Clear all trajectory points.

Returns
nonzero error code if operation fails.

◆ GetHandle()

void* ctre::phoenix::motion::BufferedTrajectoryPointStream::GetHandle ( )
inline
Returns
raw handle for resource management.

◆ Write() [1/2]

ctre::phoenix::ErrorCode ctre::phoenix::motion::BufferedTrajectoryPointStream::Write ( const TrajectoryPoint trajPt)

Write a single trajectory point into the buffer.

Returns
nonzero error code if operation fails.

◆ Write() [2/2]

ctre::phoenix::ErrorCode ctre::phoenix::motion::BufferedTrajectoryPointStream::Write ( const TrajectoryPoint trajPts,
uint32_t  trajPtCount 
)

Writes an array of trajectory point into the buffer.

Returns
nonzero error code if operation fails.

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