Table of Contents

Class FieldPlan

Namespace
Typhon.Protocol
Assembly
Typhon.Protocol.dll

One field compiled for encoding and decoding: its codec's parameters resolved into the numbers the arithmetic needs, and its place in its section.

public sealed class FieldPlan
Inheritance
FieldPlan
Inherited Members

Properties

BitCount

For a packed field, its width in bits.

public int BitCount { get; }

Property Value

int

BitOffset

For a packed field, its first bit within the pack.

public int BitOffset { get; }

Property Value

int

Codec

The codec.

public CatalogCodec Codec { get; }

Property Value

CatalogCodec

Components

Numbers per value (per element, for a list); 0 for text and bytes.

public int Components { get; }

Property Value

int

Count

The codec's count (W33): how many values of it the field carries, 1 when the catalog declares none.

public int Count { get; }

Property Value

int

Element

For a list, the element's plan.

public FieldPlan Element { get; }

Property Value

FieldPlan

ElementSection

For a collection, its element's fields as one section (W34), each field's Ordinal its place in the element.

public SectionPlan ElementSection { get; }

Property Value

SectionPlan

EnumCount

The number of names of the field's enum, or 0 when it has none; a server refuses a command value at or above it (W13).

public int EnumCount { get; }

Property Value

int

Field

The catalog field, or null for a position codec or a list element.

public CatalogField Field { get; }

Property Value

CatalogField

Kind

The codec kind.

public CodecKind Kind { get; }

Property Value

CodecKind

Name

The field's wire name.

public string Name { get; }

Property Value

string

Ordinal

The field's position in its owner's flat field list — Fields, OwnerFields or a message body — so a store can index its columns without a lookup by name.

public int Ordinal { get; }

Property Value

int

Packed

Whether the field lives in its section's leading bit pack.

public bool Packed { get; }

Property Value

bool

Parent

For a collection's element field, the collection; null otherwise.

public FieldPlan Parent { get; }

Property Value

FieldPlan

QuantStep

For a quant codec, its step — one, shared by every component of a count — computed once exactly as QuantStep(double, double, int) does; null otherwise.

public double[] QuantStep { get; }

Property Value

double[]

ValueKind

What a value of this field is made of.

public FieldValueKind ValueKind { get; }

Property Value

FieldValueKind

VelocityUnitExp

For a velocity: the unit's binary exponent — one code is 2^VelocityUnitExp metres per tick (W5).

public int VelocityUnitExp { get; }

Property Value

int