WPILibC++ 2024.1.1-beta-4
Public Types | Public Member Functions | List of all members
frc::DMASample Class Reference

#include <frc/DMASample.h>

Inheritance diagram for frc::DMASample:
HAL_DMASample

Public Types

enum class  DMAReadStatus { kOk = HAL_DMA_OK , kTimeout = HAL_DMA_TIMEOUT , kError = HAL_DMA_ERROR }
 

Public Member Functions

DMAReadStatus Update (const DMA *dma, units::second_t timeout, int32_t *remaining, int32_t *status)
 
uint64_t GetTime () const
 
units::second_t GetTimeStamp () const
 
int32_t GetEncoderRaw (const Encoder *encoder, int32_t *status) const
 
double GetEncoderDistance (const Encoder *encoder, int32_t *status) const
 
int32_t GetEncoderPeriodRaw (const Encoder *encoder, int32_t *status) const
 
int32_t GetCounter (const Counter *counter, int32_t *status) const
 
int32_t GetCounterPeriod (const Counter *counter, int32_t *status) const
 
bool GetDigitalSource (const DigitalSource *digitalSource, int32_t *status) const
 
int32_t GetAnalogInputRaw (const AnalogInput *analogInput, int32_t *status) const
 
double GetAnalogInputVoltage (const AnalogInput *analogInput, int32_t *status)
 
int32_t GetAveragedAnalogInputRaw (const AnalogInput *analogInput, int32_t *status) const
 
double GetAveragedAnalogInputVoltage (const AnalogInput *analogInput, int32_t *status)
 
void GetAnalogAccumulator (const AnalogInput *analogInput, int64_t *count, int64_t *value, int32_t *status) const
 
int32_t GetDutyCycleOutputRaw (const DutyCycle *dutyCycle, int32_t *status) const
 
double GetDutyCycleOutput (const DutyCycle *dutyCycle, int32_t *status)
 

Additional Inherited Members

- Public Attributes inherited from HAL_DMASample
uint32_t readBuffer [74]
 
int32_t channelOffsets [22]
 
uint64_t timeStamp
 
uint32_t captureSize
 
uint8_t triggerChannels
 

Member Enumeration Documentation

◆ DMAReadStatus

enum class frc::DMASample::DMAReadStatus
strong
Enumerator
kOk 
kTimeout 
kError 

Member Function Documentation

◆ GetAnalogAccumulator()

void frc::DMASample::GetAnalogAccumulator ( const AnalogInput *  analogInput,
int64_t *  count,
int64_t *  value,
int32_t *  status 
) const
inline

◆ GetAnalogInputRaw()

int32_t frc::DMASample::GetAnalogInputRaw ( const AnalogInput *  analogInput,
int32_t *  status 
) const
inline

◆ GetAnalogInputVoltage()

double frc::DMASample::GetAnalogInputVoltage ( const AnalogInput *  analogInput,
int32_t *  status 
)
inline

◆ GetAveragedAnalogInputRaw()

int32_t frc::DMASample::GetAveragedAnalogInputRaw ( const AnalogInput *  analogInput,
int32_t *  status 
) const
inline

◆ GetAveragedAnalogInputVoltage()

double frc::DMASample::GetAveragedAnalogInputVoltage ( const AnalogInput *  analogInput,
int32_t *  status 
)
inline

◆ GetCounter()

int32_t frc::DMASample::GetCounter ( const Counter *  counter,
int32_t *  status 
) const
inline

◆ GetCounterPeriod()

int32_t frc::DMASample::GetCounterPeriod ( const Counter *  counter,
int32_t *  status 
) const
inline

◆ GetDigitalSource()

bool frc::DMASample::GetDigitalSource ( const DigitalSource *  digitalSource,
int32_t *  status 
) const
inline

◆ GetDutyCycleOutput()

double frc::DMASample::GetDutyCycleOutput ( const DutyCycle *  dutyCycle,
int32_t *  status 
)
inline

◆ GetDutyCycleOutputRaw()

int32_t frc::DMASample::GetDutyCycleOutputRaw ( const DutyCycle *  dutyCycle,
int32_t *  status 
) const
inline

◆ GetEncoderDistance()

double frc::DMASample::GetEncoderDistance ( const Encoder *  encoder,
int32_t *  status 
) const
inline

◆ GetEncoderPeriodRaw()

int32_t frc::DMASample::GetEncoderPeriodRaw ( const Encoder *  encoder,
int32_t *  status 
) const
inline

◆ GetEncoderRaw()

int32_t frc::DMASample::GetEncoderRaw ( const Encoder *  encoder,
int32_t *  status 
) const
inline

◆ GetTime()

uint64_t frc::DMASample::GetTime ( ) const
inline

◆ GetTimeStamp()

units::second_t frc::DMASample::GetTimeStamp ( ) const
inline

◆ Update()

DMAReadStatus frc::DMASample::Update ( const DMA *  dma,
units::second_t  timeout,
int32_t *  remaining,
int32_t *  status 
)
inline
The documentation for this class was generated from the following file: