Struct LongCellValue
A DataTableBase System.Int64 cell reference.
Namespace: GDX.DataTables.CellValues
Syntax
[Serializable]
public struct LongCellValue
Constructors
| Improve this Doc View SourceLongCellValue(DataTableBase, Int32, Int32)
Creates a LongCellValue.
Declaration
public LongCellValue(DataTableBase dataTable, int rowIdentifier, int columnIdentifier)
Parameters
| Type | Name | Description |
|---|---|---|
| DataTableBase | dataTable | The referenced DataTableBase. |
| System.Int32 | rowIdentifier | The unique row identifier to use when polling the |
| System.Int32 | columnIdentifier | The unique column identifier to use when polling the |
Fields
| Improve this Doc View SourceColumnIdentifier
The unique column identifier used when accessing the DataTable.
Declaration
public int ColumnIdentifier
Field Value
| Type | Description |
|---|---|
| System.Int32 |
DataTable
The DataTableBase polled for cell data.
Declaration
public DataTableBase DataTable
Field Value
| Type | Description |
|---|---|
| DataTableBase |
RowIdentifier
The unique row identifier used when accessing the DataTable.
Declaration
public int RowIdentifier
Field Value
| Type | Description |
|---|---|
| System.Int32 |
Methods
| Improve this Doc View SourceGet()
Get the System.Int64 value referenced from the DataTableBase.
Declaration
public long Get()
Returns
| Type | Description |
|---|---|
| System.Int64 | A System.Int64 value. |
Remarks
This will evaluate if the version of the table matches the internally cached version, and will update the cached reference if necessary.
GetDataVersion()
Get the internally cached version of the DataTableBase's data version.
Declaration
public ulong GetDataVersion()
Returns
| Type | Description |
|---|---|
| System.UInt64 | A version number. |
GetSupportedType()
Get the Serializable.SerializableTypes which this struct supports.
Declaration
public static Serializable.SerializableTypes GetSupportedType()
Returns
| Type | Description |
|---|---|
| Serializable.SerializableTypes |
GetUnsafe()
Get the cached value without a version check.
Declaration
public long GetUnsafe()
Returns
| Type | Description |
|---|---|
| System.Int64 | A System.Int64 value. |
Remarks
This can respond with a default value if a Get() call has not been made yet to populate the internally cached value.
Set(Int64, Boolean)
Sets the cached value of the struct and by default, updates the associated DataTableBase.
Declaration
public void Set(long newValue, bool updateTable = true)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | newValue | A System.Int64 value. |
| System.Boolean | updateTable | Should the value be pushed back to the referenced DataTableBase cell? |
Remarks
Updating the DataTableBase will update the cached table version.