Collapse All Expand All | Language Filter: C#Language Filter: Visual Basic Language Filter: Visual C++ C# Visual Basic Visual C++ | Members | See Also
StreamBase Client API
Tuple Class

An interface that represents a Tuple of Data. The DataType of each Field must be appropriate for the get and set methods invoked on the Field. For example: GetDouble() only works on double fields.

Caution:
This class is not thread safe. If instances of this class are accessed from multiple threads, access must be synchronized.

Namespace: StreamBase.SB
Assembly: StreamBase.SB.Client (in StreamBase.SB.Client.dll) Version: 10.3.0.0

# Syntax

| C# |  |  | Visual Basic |  |  | Visual C++ |

    public abstract class Tuple : ICloneable,
    	IDisposable

    Public MustInherit Class Tuple _
    	Implements ICloneable, IDisposable

    public ref class Tuple abstract : ICloneable,
    	IDisposable

# Members

| All Members |  |  | Constructors |  |  | Fields |  |  | Properties |  |  | Methods |

Public Protected | Instance Static | Declared Inherited | XNA Framework Only .NET Compact Framework Only |

| Member | Description
--- | --- | ---
| Tuple()()()() | Create a null (invalid) Tuple.
| Clear()()()() | Zero out all the bytes in this tuple and set fields to Null
| Clone()()()() | Clone this Tuple
| CreateWritableTuple()()()() | Return a copy of this tuple that is guaranteed to be writable.
| Equals(Object) | Return true if the given Tuple is equivalent to this one. Two Tuples are considered equivalent if their Schemas match and if each individual Field has the same value in both Tuples. (Overrides Object..::..Equals(Object).)
| GetBlobBuffer(Int32) | Return the value of the blob field at index nFieldIndex, as a ByteArrayView.
| GetBlobBuffer(String) | Return the value of a blob field as a ByteArrayView, given its name.
| GetBlobBuffer(Schema..::..Field) | Return the value of a blob field as a ByteArrayView. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| GetBoolean(Int32) | Return the value of a Boolean field at index nFieldIndex.
| GetBoolean(String) | Return the value of a Boolean field, given its name
| GetBoolean(Schema..::..Field) | Return the value of a Boolean field. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| GetDouble(Int32) | Return the value of a double field at index nFieldIndex.
| GetDouble(String) | Return the value of a double field, given its name
| GetDouble(Schema..::..Field) | Return the value of a double field. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| GetField(Int32) | Return an object containing the value of the field at the specified index. This is a String, Integer, Double, Boolean, Timestamp, Byte[] or Tuple depending on the field type.
| GetField(String) | Return an object containing the value of the Field with the specified name. This is a String, Integer, Double, Boolean, Timestamp, Byte[] or Tuple depending on the field type.
| GetField(Schema..::..Field) | Return an object containing the value of the given field. This is a String, Integer, Double, Boolean, Timestamp, Byte[] or Tuple depending on the field type. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| GetFunction(Int32) | Return the value of the function field at index nFieldIndex, as a Function.
| GetFunction(String) | Return the value of a function field as a Function, given its name.
| GetFunction(Schema..::..Field) | Return the value of a function field as a Function The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| GetHashCode()()()() | Return the hash code for this Tuple. (Overrides Object..::..GetHashCode()()()().)
| GetInt(Int32) | Return the value of an int field at index nFieldIndex.
| GetInt(String) | Return the value of an int field, given its name
| GetInt(Schema..::..Field) | Return the value of an int field. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| GetList(Int32) | Return the value of the list field at index nFieldIndex/>.
| GetList(String) | Return the value of a list field, given its name.
| GetList(Schema..::..Field) | Return the value of a list field/> The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| GetLong(Int32) | Return the value of a long field at index nFieldIndex.
| GetLong(String) | Return the value of a long field, given its name
| GetLong(Schema..::..Field) | Return the value of a long field. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| GetSchema()()()() | Return the schema of this tuple.
| GetString(Int32) | Return the value of a string field at index nFieldIndex.
| GetString(String) | Return the value of a string field, given its name
| GetString(Schema..::..Field) | Return the value of a string field. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| GetTimestamp(Int32) | Return the value of a Timestamp field at index nFieldIndex.
| GetTimestamp(String) | Return the value of a Timestamp field, given its name.
| GetTimestamp(Schema..::..Field) | Return the value of a Timestamp field. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| GetTuple(Int32) | Return the value of the tuple field at index nFieldIndex, as a Tuple.
| GetTuple(String) | Return the value of a tuple field as a Tuple, given its name.
| GetTuple(Schema..::..Field) | Return the value of a tuple field as a Tuple The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| GetTupleLength()()()() | Calculate (exact) length of this tuple's serialization in bytes.
| GetType()()()() | Gets the Type of the current instance. (Inherited from Object.)
| IsNull(Int32) | Test the null setting for the nFieldIndex'th field
| IsNull(String) | Test the null setting for field sFieldName
| IsNull(Schema..::..Field) | Test the null setting for the given field The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| IsReadOnly()()()() | Returns true if this is a read only tuple (read only tuples throw an UnsupportedOperationException when setter methods are called).
| NULL_STRING | The default String representation of a null valued field (value "null")
| Schema | Gets the Schema used to define the Fields of this Tuple.
| Serialize(ByteOrder) |
| Serialize(Stream, ByteOrder) |
| SetBlobBuffer(Int32, ByteArrayView) | Set the value of the blob field at index nFieldIndex.
| SetBlobBuffer(Int32, array<Byte>[]()[][]) | Set the value of the blob field at index nFieldIndex.
| SetBlobBuffer(String, ByteArrayView) | Sets the value of a blob field, given its name.
| SetBlobBuffer(String, array<Byte>[]()[][]) | Sets the value of a blob field, given its name.
| SetBlobBuffer(Schema..::..Field, ByteArrayView) | Sets the value of a blob field. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| SetBlobBuffer(Schema..::..Field, array<Byte>[]()[][]) | Sets the value of a blob field. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| SetBoolean(Int32, Boolean) | Set the value of a Boolean field at index nFieldIndex.
| SetBoolean(String, Boolean) | Sets the value of a Boolean field, given its name
| SetBoolean(Schema..::..Field, Boolean) | Sets the value of a Boolean field. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| SetDouble(Int32, Double) | Set the value of a double field at index nFieldIndex. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| SetDouble(String, Double) | Sets the value of a double field, given its name
| SetDouble(Schema..::..Field, Double) | Sets the value of a double field.
| SetField(Int32, Object) | Set the field at the given index to the given value. The value is parsed according to the field type.
| SetField(String, Object) | Set the field with the given name to the given value. The value is parsed according to the field type.
| SetField(Schema..::..Field, Object) | Set the given field to the given value. The value is parsed according to the field type. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| SetFunction(Int32, Function) | Set the value of a Function field at index nFieldIndex.
| SetFunction(String, Function) | Sets the value of a Function field, given its name.
| SetFunction(Schema..::..Field, Function) | Sets the value of a Function field. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| SetInt(Int32, Int32) | Set the value of an int field at index nFieldIndex.
| SetInt(String, Int32) | Sets the value of an int field, given its name
| SetInt(Schema..::..Field, Int32) | Sets the value of an int field. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| SetList(Int32, IList<(Of <<'(Object>)>>)) | Set the value of a List<(Of <(<'T>)>)> field at index nFieldIndex.
| SetList(String, IList<(Of <<'(Object>)>>)) | Sets the value of a List<(Of <(<'T>)>)> field, given its name.
| SetList(Schema..::..Field, IList<(Of <<'(Object>)>>)) | Sets the value of a List<(Of <(<'T>)>)> field. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| SetLong(Int32, Int64) | Set the value of a long field at index nFieldIndex.
| SetLong(String, Int64) | Sets the value of a long field, given its name
| SetLong(Schema..::..Field, Int64) | Sets the value of a long field. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| SetNull(Int32) | Set the field located at nFieldIndex to null
| SetNull(String) | Set the field named sName to null
| SetNull(Schema..::..Field) | Set the field to null The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| SetString(Int32, String) |
| SetString(String, String) |
| SetString(Schema..::..Field, String) | Sets the value of a string field. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| SetTimestamp(Int32, Timestamp) | Set the value of a Timestamp field at index nFieldIndex.
| SetTimestamp(String, Timestamp) | Sets the value of a Timestamp field, given its name.
| SetTimestamp(Schema..::..Field, Timestamp) | Sets the value of a Timestamp field. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| SetTuple(Int32, Tuple) | Set the value of a Tuple field at index nFieldIndex.
| SetTuple(String, Tuple) | Sets the value of a Tuple field, given its name.
| SetTuple(Schema..::..Field, Tuple) | Sets the value of a Tuple field. The Schema.Field objects used to set and get Tuple field values must be obtained via the Tuple's Schema object. A Schema.Field object that has been created by the user or retrieved from a different Schema may not work.
| ToDelimitedString(String) | Return a string value representing this tuple, separated by the given delimiter.
| ToObservableTuple(Tuple, Int64) | Constructs an IObservableTuple from this instance. (Inherited from StreamBaseAPIExtensions.)
| ToString()()()() | Return a human-readable string value representing this tuple in its entirety (including all header values, if applicable). (Overrides Object..::..ToString()()()().)
| ToString(Char, Char) | Return a string representation of this Tuple.
| ToString(Char, Char, String) | Return a string representation of this Tuple.
| ToString(Char, Char, String, Boolean) | Return a string representation of this Tuple.
| Verify()()()() | Verify that the tuple is valid

# Inheritance Hierarchy

System..::..Object
StreamBase.SB..::..Tuple

# See Also

StreamBase.SB Namespace