Canboat ts-pgns
    Preparing search index...

    Type Alias Field

    Represents a field definition within a data structure, including metadata and configuration options.

    type Field = {
        BitLength?: number;
        BitLengthVariable?: boolean;
        BitOffset: number;
        BitStart: number;
        Condition?: string;
        Description?: string;
        EnumBitValues?: any;
        FieldType: FieldType;
        Id: string;
        LookupBitEnumeration?: string;
        LookupEnumeration?: string;
        LookupFieldTypeEnumeration: string;
        LookupIndirectEnumeration?: string;
        LookupIndirectEnumerationFieldOrder?: number;
        Match?: number;
        Name: string;
        Offset?: number;
        PartOfPrimaryKey?: boolean;
        PhysicalQuantity?: PhysicalQuantity;
        RangeMax?: number;
        RangeMin?: number;
        Resolution?: number;
        Signed?: boolean;
        Unit?: string;
    }
    Index

    Properties

    BitLength? BitLengthVariable? BitOffset BitStart Condition? Description? EnumBitValues? FieldType Id LookupBitEnumeration? LookupEnumeration? LookupFieldTypeEnumeration LookupIndirectEnumeration? LookupIndirectEnumerationFieldOrder? Match? Name Offset? PartOfPrimaryKey? PhysicalQuantity? RangeMax? RangeMin? Resolution? Signed? Unit?

    Properties

    BitLength?: number

    Optional fixed bit length of the field.

    BitLengthVariable?: boolean

    Indicates if the bit length is variable.

    BitOffset: number

    Bit offset from the start of the structure.

    BitStart: number

    Starting bit position of the field.

    Condition?: string

    Optional condition for field inclusion.

    Description?: string

    Optional description of the field.

    EnumBitValues?: any

    Optional enumeration of bit values.

    FieldType: FieldType

    Type of the field, as defined by FieldType.

    Id: string

    Unique identifier for the field.

    LookupBitEnumeration?: string

    Optional reference to a bit enumeration.

    LookupEnumeration?: string

    Optional reference to a lookup enumeration.

    LookupFieldTypeEnumeration: string

    Reference to the field type enumeration.

    LookupIndirectEnumeration?: string

    Optional reference to an indirect lookup enumeration.

    LookupIndirectEnumerationFieldOrder?: number

    Optional order for indirect enumeration fields.

    Match?: number

    Optional value to match for conditional fields.

    Name: string

    Human-readable name of the field.

    Offset?: number

    Optional offset to apply to the field value.

    PartOfPrimaryKey?: boolean

    Indicates if the field is part of the primary key.

    PhysicalQuantity?: PhysicalQuantity

    Optional physical quantity represented by the field.

    RangeMax?: number

    Optional maximum allowed value.

    RangeMin?: number

    Optional minimum allowed value.

    Resolution?: number

    Optional resolution or scaling factor.

    Signed?: boolean

    Indicates if the field value is signed.

    Unit?: string

    Optional unit of measurement for the field value.

    Settings

    Member Visibility

    On This Page

    Properties