Class Encoder

Inheritance
Object
Encoder
Inherited Members
Namespace: Hal
Assembly: FRC.Hal.dll
Syntax
[NativeInterface(typeof(IEncoder))]
public static class Encoder

Methods

| Improve this Doc View Source

Free(Int32)

Declaration
public static void Free(int encoderHandle)
Parameters
Type Name Description
Int32 encoderHandle
| Improve this Doc View Source

Get(Int32)

Declaration
public static int Get(int encoderHandle)
Parameters
Type Name Description
Int32 encoderHandle
Returns
Type Description
Int32
| Improve this Doc View Source

GetDecodingScaleFactor(Int32)

Declaration
public static double GetDecodingScaleFactor(int encoderHandle)
Parameters
Type Name Description
Int32 encoderHandle
Returns
Type Description
Double
| Improve this Doc View Source

GetDirection(Int32)

Declaration
public static int GetDirection(int encoderHandle)
Parameters
Type Name Description
Int32 encoderHandle
Returns
Type Description
Int32
| Improve this Doc View Source

GetDistance(Int32)

Declaration
public static double GetDistance(int encoderHandle)
Parameters
Type Name Description
Int32 encoderHandle
Returns
Type Description
Double
| Improve this Doc View Source

GetDistancePerPulse(Int32)

Declaration
public static double GetDistancePerPulse(int encoderHandle)
Parameters
Type Name Description
Int32 encoderHandle
Returns
Type Description
Double
| Improve this Doc View Source

GetEncodingScale(Int32)

Declaration
public static int GetEncodingScale(int encoderHandle)
Parameters
Type Name Description
Int32 encoderHandle
Returns
Type Description
Int32
| Improve this Doc View Source

GetEncodingType(Int32)

Declaration
public static EncoderEncodingType GetEncodingType(int encoderHandle)
Parameters
Type Name Description
Int32 encoderHandle
Returns
Type Description
EncoderEncodingType
| Improve this Doc View Source

GetFPGAIndex(Int32)

Declaration
public static int GetFPGAIndex(int encoderHandle)
Parameters
Type Name Description
Int32 encoderHandle
Returns
Type Description
Int32
| Improve this Doc View Source

GetPeriod(Int32)

Declaration
public static double GetPeriod(int encoderHandle)
Parameters
Type Name Description
Int32 encoderHandle
Returns
Type Description
Double
| Improve this Doc View Source

GetRate(Int32)

Declaration
public static double GetRate(int encoderHandle)
Parameters
Type Name Description
Int32 encoderHandle
Returns
Type Description
Double
| Improve this Doc View Source

GetRaw(Int32)

Declaration
public static int GetRaw(int encoderHandle)
Parameters
Type Name Description
Int32 encoderHandle
Returns
Type Description
Int32
| Improve this Doc View Source

GetSamplesToAverage(Int32)

Declaration
public static int GetSamplesToAverage(int encoderHandle)
Parameters
Type Name Description
Int32 encoderHandle
Returns
Type Description
Int32
| Improve this Doc View Source

Initialize(Int32, AnalogTriggerType, Int32, AnalogTriggerType, Int32, EncoderEncodingType)

Declaration
public static int Initialize(int digitalSourceHandleA, AnalogTriggerType analogTriggerTypeA, int digitalSourceHandleB, AnalogTriggerType analogTriggerTypeB, int reverseDirection, EncoderEncodingType encodingType)
Parameters
Type Name Description
Int32 digitalSourceHandleA
AnalogTriggerType analogTriggerTypeA
Int32 digitalSourceHandleB
AnalogTriggerType analogTriggerTypeB
Int32 reverseDirection
EncoderEncodingType encodingType
Returns
Type Description
Int32
| Improve this Doc View Source

Reset(Int32)

Declaration
public static void Reset(int encoderHandle)
Parameters
Type Name Description
Int32 encoderHandle
| Improve this Doc View Source

SetIndexSource(Int32, Int32, AnalogTriggerType, EncoderIndexingType)

Declaration
public static void SetIndexSource(int encoderHandle, int digitalSourceHandle, AnalogTriggerType analogTriggerType, EncoderIndexingType type)
Parameters
Type Name Description
Int32 encoderHandle
Int32 digitalSourceHandle
AnalogTriggerType analogTriggerType
EncoderIndexingType type
| Improve this Doc View Source

SetMaxPeriod(Int32, Double)

Declaration
public static void SetMaxPeriod(int encoderHandle, double maxPeriod)
Parameters
Type Name Description
Int32 encoderHandle
Double maxPeriod
| Improve this Doc View Source

SetMinRate(Int32, Double)

Declaration
public static void SetMinRate(int encoderHandle, double minRate)
Parameters
Type Name Description
Int32 encoderHandle
Double minRate
| Improve this Doc View Source

SetReverseDirection(Int32, Int32)

Declaration
public static void SetReverseDirection(int encoderHandle, int reverseDirection)
Parameters
Type Name Description
Int32 encoderHandle
Int32 reverseDirection
| Improve this Doc View Source

SetSamplesToAverage(Int32, Int32)

Declaration
public static void SetSamplesToAverage(int encoderHandle, int samplesToAverage)
Parameters
Type Name Description
Int32 encoderHandle
Int32 samplesToAverage
| Improve this Doc View Source

SetSimDevice(Int32, Int32)

Declaration
public static void SetSimDevice(int handle, int device)
Parameters
Type Name Description
Int32 handle
Int32 device