Class Dimension

Represents a TileDB dimension object.

Inheritance

object

Dimension

Implements

IDisposable

Namespace: TileDB.CSharp

Assembly: TileDB.CSharp.dll

Syntax

public sealed class Dimension : IDisposable

Fields

| Edit this page View Source

VariableSized

This value indicates a variable-sized attribute. It may be returned from CellValNum() and can be passed to SetCellValNum(uint).

Declaration

public const uint VariableSized = 4294967295

Field Value

Type	Description
uint

Methods

| Edit this page View Source

CellValNum()

Gets the number of values per cell for the dimension.

Declaration

public uint CellValNum()

Returns

Type	Description
uint	The number of values per cell for the dimension, or VariableSized for variable-sized dimensions.

| Edit this page View Source

CreateString(Context, string)

Create a string Dimension.

Declaration

public static Dimension CreateString(Context ctx, string name)

Parameters

Type	Name	Description
Context	ctx	The Context associated with the dimension.
string	name	The dimension's name.

Returns

Type	Description
Dimension

| Edit this page View Source

Create<T>(Context, string, T, T, T)

Creates a Dimension.

Declaration

public static Dimension Create<T>(Context ctx, string name, T boundLower, T boundUpper, T extent)

Parameters

Type	Name	Description
Context	ctx	The Context associated with the dimension.
string	name	The dimension's name.
T	boundLower	The dimension's lower bound, inclusive.
T	boundUpper	The dimension's upper bound, inclusive.
T	extent	The dimension's tile extent.

Returns

Type	Description
Dimension

Type Parameters

Name	Description
T	The dimension's type.

Exceptions

Type	Condition
NotSupportedException	`T` is not supported.

| Edit this page View Source

Dispose()

Disposes the Dimension.

Declaration

public void Dispose()

| Edit this page View Source

DomainToStr()

Gets the dimension's domain as string.

Declaration

public string DomainToStr()

Returns

Type	Description
string

| Edit this page View Source

FilterList()

Gets the filter list of this dimension.

Declaration

public FilterList FilterList()

Returns

Type	Description
FilterList

| Edit this page View Source

GetDomain<T>()

Gets the allowed starting and ending values of the dimension, inclusive.

Declaration

public (T Start, T End) GetDomain<T>() where T : struct

Returns

Type	Description
(T Start, T End)

Type Parameters

Name	Description
T

| Edit this page View Source

Name()

Get name of the dimension.

Declaration

public string Name()

Returns

Type	Description
string

| Edit this page View Source

SetCellValNum(uint)

Sets the number of values per cell for this dimension. For variable-sized attributes the value should be VariableSized.

Declaration

public void SetCellValNum(uint cellValNum)

Parameters

Type	Name	Description
uint	cellValNum

| Edit this page View Source

SetFilterList(FilterList)

Set filter list.

Declaration

public void SetFilterList(FilterList filterList)

Parameters

Type	Name	Description
FilterList	filterList

| Edit this page View Source

TileExtentToStr()

Gets the dimension's tile extent as string.

Declaration

public string TileExtentToStr()

Returns

Type	Description
string

| Edit this page View Source

TileExtent<T>()

Gets the dimension's tile extent.

Declaration

public T TileExtent<T>() where T : struct

Returns

Type	Description
T

Type Parameters

Name	Description
T

| Edit this page View Source

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

object.ToString()

| Edit this page View Source

Type()

Get DataType of the dimension.

Declaration

public DataType Type()

Returns

Type	Description
DataType

Implements

IDisposable