NTuple

References
[IoId("00000000-383b-45f5-af4a-69f0c397db09")] public sealed class NTuple : IStorable, IEquatable<NTuple>, IComparable<NTuple>
A combination of one or more named values.

Constructors

NTuple

#
public NTuple(IReader reader)
Parameters:
reader (IReader)

NTuple

#
public NTuple(params (string name, IPear pear)[] elements)
Parameters:
elements (params (string name, IPear pear)[])

Properties

Count

#
public int Count { get; }
Gets the number of elements.

Elements

#
public IEnumerable<(string name, IPear pear)> Elements { get; }
Enumerate over all elements.

Empty

#
public static NTuple Empty { get; }

Methods

CompareTo

#
public int CompareTo(NTuple other)
Parameters:
other (NTuple)

Equals

#
public bool Equals(NTuple other)
Parameters:
other (NTuple)

Equals

#
public override bool Equals(object obj)
Parameters:
obj (object)
Overrides: Object.Equals

Get<T>

#
public bool Get<T>(string name, StringComparison comparison, out T value)
Get the value if defined.
Parameters:
name (string)Name of value to retrieve.
comparison (StringComparison)Comparison to use.
value (out T)Value if defined.
Returns: True if value was defined.

GetHashCode

#
public override int GetHashCode()
Overrides: Object.GetHashCode

Grow

#
public NTuple Grow(string name, bool value)
Add a value to this tuple.
Parameters:
name (string)Name of value to add.
value (bool)Value to add.
Returns: Tuple with added value.

Grow

#
public NTuple Grow(string name, Colour value)
Add a value to this tuple.
Parameters:
name (string)Name of value to add.
value (Colour)Value to add.
Returns: Tuple with added value.

Grow

#
public NTuple Grow(string name, double value)
Add a value to this tuple.
Parameters:
name (string)Name of value to add.
value (double)Value to add.
Returns: Tuple with added value.

Grow

#
public NTuple Grow(string name, int value)
Add a value to this tuple.
Parameters:
name (string)Name of value to add.
value (int)Value to add.
Returns: Tuple with added value.

Grow

#
public NTuple Grow(string name, IPear pear)
Add a value to this tuple.
Parameters:
name (string)Name of value to add.
pear (IPear)Value to add.
Returns: Tuple with added value.

Grow

#
public NTuple Grow(string name, Plane value)
Add a value to this tuple.
Parameters:
name (string)Name of value to add.
value (Plane)Value to add.
Returns: Tuple with added value.

Grow

#
public NTuple Grow(string name, Point3d value)
Add a value to this tuple.
Parameters:
name (string)Name of value to add.
value (Point3d)Value to add.
Returns: Tuple with added value.

Grow

#
public NTuple Grow(string name, string value)
Add a value to this tuple.
Parameters:
name (string)Name of value to add.
value (string)Value to add.
Returns: Tuple with added value.

Grow

#
public NTuple Grow(string name, Vector3d value)
Add a value to this tuple.
Parameters:
name (string)Name of value to add.
value (Vector3d)Value to add.
Returns: Tuple with added value.

IndexOf

#
public int IndexOf(string name, StringComparison comparison = StringComparison.Ordinal)
Find the index of the element with the given name.
Parameters:
name (string)
comparison (StringComparison = StringComparison.Ordinal)

IsValidName

#
public static bool IsValidName(string proposedName, out string validName, out string[] reasons)
Validate the name for a tuple element. Names may not contain wildcard characters.
Parameters:
proposedName (string)
validName (out string)
reasons (out string[])

Name

#
public string Name(int index)
Gets the name of the element at the given index.
Parameters:
index (int)

Pare

#
public NTuple Pare(string name, StringComparison comparison)
Remove the elements from this tuple with the given name.
Parameters:
name (string)
comparison (StringComparison)

PareWildcard

#
public NTuple PareWildcard(string name)
Remove all elements from this tuple which match the given name pattern.
Parameters:
name (string)

Pear

#
public IPear Pear(int index)
Gets the name of the element at the given index.
Parameters:
index (int)

Store

#
public void Store(IWriter writer)
Parameters:
writer (IWriter)
Implements: Store

ToString

#
public override string ToString()
Overrides: Object.ToString

TryGet<T>

#
public bool TryGet<T>(string name, StringComparison comparison, ref T value)
Try and retrieve the value if defined.
Parameters:
name (string)Name of value to retrieve.
comparison (StringComparison)Comparison to use.
value (ref T)Value if defined.
Returns: True if value was defined.

Operators

OperationResultDescription
NTuple+(string name, bool value)NTuple
NTuple+(string name, Colour value)NTuple
NTuple+(string name, double value)NTuple
NTuple+(string name, int value)NTuple
NTuple+(string name, IPear value)NTuple
NTuple+(string name, Plane value)NTuple
NTuple+(string name, Point3d value)NTuple
NTuple+(string name, string value)NTuple
NTuple+(string name, Vector3d value)NTuple
NTuple-stringNTuple