Struct RefNetworkTableValue

Inherited Members

Namespace: NetworkTables

Assembly: FRC.NetworkTables.dll

Syntax

public struct RefNetworkTableValue

Fields

| Improve this Doc View Source

Value

Declaration

public readonly RefManagedValue Value

Field Value

Type	Description
RefManagedValue

Properties

| Improve this Doc View Source

IsValid

Declaration

public bool IsValid { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

Type

Declaration

public NtType Type { get; }

Property Value

Type	Description
NtType

Methods

| Improve this Doc View Source

Equals(RefNetworkTableValue)

Declaration

public bool Equals(RefNetworkTableValue other)

Parameters

Type	Name	Description
RefNetworkTableValue	other

Returns

Type	Description
Boolean

| Improve this Doc View Source

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

ValueType.Equals(Object)

| Improve this Doc View Source

GetBoolean()

Gets the boolean value from the type

Declaration

public bool GetBoolean()

Returns

Type	Description
Boolean	boolean contained in type

Exceptions

Type	Condition
InvalidCastException	Thrown if type is not boolean.

| Improve this Doc View Source

GetBooleanArray()

Gets the boolean array value from the type

Declaration

public ReadOnlySpan<bool> GetBooleanArray()

Returns

Type	Description
System.ReadOnlySpan<Boolean>	boolean array contained in type

Exceptions

Type	Condition
InvalidCastException	Thrown if type is not boolean array.

| Improve this Doc View Source

GetDouble()

Gets the double value from the type

Declaration

public double GetDouble()

Returns

Type	Description
Double	double contained in type

Exceptions

Type	Condition
InvalidCastException	Thrown if type is not double.

| Improve this Doc View Source

GetDoubleArray()

Gets the double array value from the type

Declaration

public ReadOnlySpan<double> GetDoubleArray()

Returns

Type	Description
System.ReadOnlySpan<Double>	double array contained in type

Exceptions

Type	Condition
InvalidCastException	Thrown if type is not double array.

| Improve this Doc View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

ValueType.GetHashCode()

| Improve this Doc View Source

GetRaw()

Gets the raw value from the type

Declaration

public ReadOnlySpan<byte> GetRaw()

Returns

Type	Description
System.ReadOnlySpan<Byte>	raw byte array contained in type

Exceptions

Type	Condition
InvalidCastException	Thrown if type is not raw.

| Improve this Doc View Source

GetRpc()

Gets the rpc value from the type

Declaration

public ReadOnlySpan<byte> GetRpc()

Returns

Type	Description
System.ReadOnlySpan<Byte>	rpc byte array contained in type

Exceptions

Type	Condition
InvalidCastException	Thrown if type is not rpc.

| Improve this Doc View Source

GetString()

Gets the string value from the type

Declaration

public ReadOnlySpan<char> GetString()

Returns

Type	Description
System.ReadOnlySpan<Char>	string contained in type

Exceptions

Type	Condition
InvalidCastException	Thrown if type is not string.

| Improve this Doc View Source

GetStringArray()

Gets the string array value from the type

Declaration

public ReadOnlySpan<string> GetStringArray()

Returns

Type	Description
System.ReadOnlySpan<String>	string array contained in type

Exceptions

Type	Condition
InvalidCastException	Thrown if type is not string arrya.

| Improve this Doc View Source

IsBoolean()

Gets if the type is boolean

Declaration

public bool IsBoolean()

Returns

Type	Description
Boolean	True if the type is boolean

| Improve this Doc View Source

IsBooleanArray()

Gets if the type is boolean array

Declaration

public bool IsBooleanArray()

Returns

Type	Description
Boolean	True if the type is a boolean array

| Improve this Doc View Source

IsDouble()

Gets if the type is double

Declaration

public bool IsDouble()

Returns

Type	Description
Boolean	True if the type is double

| Improve this Doc View Source

IsDoubleArray()

Gets if the type is double array

Declaration

public bool IsDoubleArray()

Returns

Type	Description
Boolean	True if the type is a double array

| Improve this Doc View Source

IsRaw()

Gets if the type is raw

Declaration

public bool IsRaw()

Returns

Type	Description
Boolean	True if the type is raw

| Improve this Doc View Source

IsRpc()

Gets if the type is Rpc

Declaration

public bool IsRpc()

Returns

Type	Description
Boolean	True if the type is Rpc

| Improve this Doc View Source

IsString()

Gets if the type is string

Declaration

public bool IsString()

Returns

Type	Description
Boolean	True if the type is string

| Improve this Doc View Source

IsStringArray()

Gets if the type is string array

Declaration

public bool IsStringArray()

Returns

Type	Description
Boolean	True if the type is a string array

| Improve this Doc View Source

MakeBoolean(Boolean)

Declaration

public static RefNetworkTableValue MakeBoolean(bool value)

Parameters

Type	Name	Description
Boolean	value

Returns

Type	Description
RefNetworkTableValue

| Improve this Doc View Source

MakeBooleanArray(ReadOnlySpan<Boolean>)

Declaration

public static RefNetworkTableValue MakeBooleanArray(ReadOnlySpan<bool> value)

Parameters

Type	Name	Description
System.ReadOnlySpan<Boolean>	value

Returns

Type	Description
RefNetworkTableValue

| Improve this Doc View Source

MakeDouble(Double)

Declaration

public static RefNetworkTableValue MakeDouble(double value)

Parameters

Type	Name	Description
Double	value

Returns

Type	Description
RefNetworkTableValue

| Improve this Doc View Source

MakeDoubleArray(ReadOnlySpan<Double>)

Declaration

public static RefNetworkTableValue MakeDoubleArray(ReadOnlySpan<double> value)

Parameters

Type	Name	Description
System.ReadOnlySpan<Double>	value

Returns

Type	Description
RefNetworkTableValue

| Improve this Doc View Source

MakeRaw(ReadOnlySpan<Byte>)

Declaration

public static RefNetworkTableValue MakeRaw(ReadOnlySpan<byte> value)

Parameters

Type	Name	Description
System.ReadOnlySpan<Byte>	value

Returns

Type	Description
RefNetworkTableValue

| Improve this Doc View Source

MakeRpc(ReadOnlySpan<Byte>)

Declaration

public static RefNetworkTableValue MakeRpc(ReadOnlySpan<byte> value)

Parameters

Type	Name	Description
System.ReadOnlySpan<Byte>	value

Returns

Type	Description
RefNetworkTableValue

| Improve this Doc View Source

MakeString(ReadOnlySpan<Char>)

Declaration

public static RefNetworkTableValue MakeString(ReadOnlySpan<char> value)

Parameters

Type	Name	Description
System.ReadOnlySpan<Char>	value

Returns

Type	Description
RefNetworkTableValue

| Improve this Doc View Source

MakeString(String)

Declaration

public static RefNetworkTableValue MakeString(string value)

Parameters

Type	Name	Description
String	value

Returns

Type	Description
RefNetworkTableValue

| Improve this Doc View Source

MakeStringArray(ReadOnlySpan<String>)

Declaration

public static RefNetworkTableValue MakeStringArray(ReadOnlySpan<string> value)

Parameters

Type	Name	Description
System.ReadOnlySpan<String>	value

Returns

Type	Description
RefNetworkTableValue

| Improve this Doc View Source

ToValue()

Declaration

public NetworkTableValue ToValue()

Returns

Type	Description
NetworkTableValue

Operators

| Improve this Doc View Source

Equality(RefNetworkTableValue, RefNetworkTableValue)

Declaration

public static bool operator ==(RefNetworkTableValue lhs, RefNetworkTableValue rhs)

Parameters

Type	Name	Description
RefNetworkTableValue	lhs
RefNetworkTableValue	rhs

Returns

Type	Description
Boolean

| Improve this Doc View Source

Inequality(RefNetworkTableValue, RefNetworkTableValue)

Declaration

public static bool operator !=(RefNetworkTableValue lhs, RefNetworkTableValue rhs)

Parameters

Type	Name	Description
RefNetworkTableValue	lhs
RefNetworkTableValue	rhs

Returns

Type	Description
Boolean