Class StatusSignal<T>

Namespace

CTRE.Phoenix6

Assembly

Phoenix6.Hardware.dll

Represents a status signal with data of type T, and operations available to retrieve information about the signal.

public class StatusSignal<T> : BaseStatusSignal, ICloneable

Type Parameters

T

Underlying type of signal to get

Inheritance

object

BaseStatusSignal

StatusSignal<T>

Implements

ICloneable

Inherited Members

BaseStatusSignal.localRef

BaseStatusSignal.Name

BaseStatusSignal.ValueAsDouble

BaseStatusSignal.Units

BaseStatusSignal.AllTimestamps

BaseStatusSignal.Timestamp

BaseStatusSignal.Status

BaseStatusSignal.HasUpdated

BaseStatusSignal.SetUpdateFrequency(double, double)

BaseStatusSignal.GetAppliedUpdateFrequency()

BaseStatusSignal.GetLatencyCompensatedValue(StatusSignal<double>, StatusSignal<double>, double)

BaseStatusSignal.WaitForAll(double, params IReadOnlyList<BaseStatusSignal>)

BaseStatusSignal.RefreshAll(params IReadOnlyList<BaseStatusSignal>)

BaseStatusSignal.IsAllGood(params IReadOnlyList<BaseStatusSignal>)

BaseStatusSignal.SetUpdateFrequencyForAll(double, params IReadOnlyList<BaseStatusSignal>)

BaseStatusSignal.UpdateUnits(ushort)

BaseStatusSignal.RefreshValue(bool, double, bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Properties

Supplier

Returns a lambda that calls Refresh and gets the value on this object.

public Func<T> Supplier { get; }

Property Value

Func<T>

Lambda that refreshes this signal and returns it

Value

Gets the cached value from this status signal.

To make sure the value is up-to-date, call Refresh(bool) or WaitForUpdate(double, bool).

public T Value { get; }

Property Value

T

Methods

Clone()

Clone this object to get a copy of itself

public StatusSignal<T> Clone()

Returns

StatusSignal<T>

Copy of this object

GetDataCopy()

Get a basic data-only container with a copy of the current signal data.

Note if looking for Phoenix 6 logging features, see the SignalLogger class instead.

public SignalMeasurement<T> GetDataCopy()

Returns

SignalMeasurement<T>

Basic structure with all relevant information

Refresh(bool)

Refreshes the value of this status signal.

If the user application caches this StatusSignal object instead of periodically fetching it from the hardware device, this function must be called to fetch fresh data.

This performs a non-blocking refresh operation. If you want to wait until you receive the signal, call WaitForUpdate(double, bool) instead.

public StatusSignal<T> Refresh(bool reportError = true)

Parameters

reportError bool

Whether to report any errors to the console. Defaults true

Returns

StatusSignal<T>

Reference to itself

ToString()

Gets the string representation of this object.

Includes the value of the signal and the units associated with this signal.

public override string ToString()

Returns

string

WaitForUpdate(double, bool)

Waits up to timeoutSec to get the up-to-date status signal value.

This performs a blocking refresh operation. If you want to non-blocking refresh the signal, call Refresh(bool) instead.

public StatusSignal<T> WaitForUpdate(double timeoutSec, bool reportError = true)

Parameters

timeoutSec double

Maximum time to wait for the signal to update

reportError bool

Whether to report any errors to the console. Defaults true

Returns

StatusSignal<T>

Reference to itself