xtce

package

Go to main page

Versions in this module

v0

v0.4.0

Sep 2, 2026

Changes in this version

+ var ErrInvalidMathOperation = errors.New("math operation cannot be evaluated")

+ type BooleanExpression struct

+ ANDedConditions *ConditionGroup

+ Condition *Condition

+ ORedConditions *ConditionGroup

+ type Condition struct

+ ComparisonOperator string

+ ParameterInstanceRefs []ParameterInstanceRef

+ Value *string

+ func (c *Condition) Left() (ParameterInstanceRef, bool)

+ func (c *Condition) Right() (ParameterInstanceRef, bool)

+ type ConditionGroup struct

+ ANDedConditions []ConditionGroup

+ Conditions []Condition

+ ORedConditions []ConditionGroup

+ type DynamicValue struct

+ Adjustment *LinearAdjustment

+ Parameter *ParameterInstanceRef

+ type LinearAdjustment struct

+ Intercept float64

+ Slope *float64

+ func (a *LinearAdjustment) Apply(value int64) int64

+ type MathOperand struct

+ Kind MathOperandKind

+ Operator string

+ Parameter ParameterInstanceRef

+ Value float64

+ type MathOperandKind int

+ const MathOperator

+ const MathParameterInstance

+ const MathThisParameter

+ const MathValue

+ func (k MathOperandKind) String() string

+ type MathOperationCalibrator struct

+ Operands []MathOperand

+ func (m *MathOperationCalibrator) Apply(raw float64) (float64, error)

+ func (m *MathOperationCalibrator) ApplyWith(raw float64, lookup ParameterValueFunc) (float64, error)

+ func (m *MathOperationCalibrator) UnmarshalXML(decoder *xml.Decoder, start xml.StartElement) error

+ type ParameterInstanceRef struct

+ Instance int64

+ ParameterRef string

+ UseCalibratedValue *bool

+ func (p *ParameterInstanceRef) Calibrated() bool

+ type ParameterValueFunc func(ref ParameterInstanceRef) (float64, bool)

type SequenceContainer

+ func (c *SequenceContainer) ExtractDynamic(packet []byte) (*Packet, error)

+ func (c *SequenceContainer) ResolveLayout(packet []byte) (*Layout, error)

type SpaceSystem

+ func (s *SpaceSystem) ResolveLayoutOf(qualifiedName string, packet []byte) (*Layout, error)

v0.3.0

Aug 29, 2026

Changes in this version

+ const MaxDepth

+ const MaxDocumentSize

+ const Namespace

+ var ErrContainerCycle = errors.New("container inheritance forms a cycle")

+ var ErrDuplicateName = errors.New("duplicate name within a SpaceSystem")

+ var ErrDynamicSize = errors.New("the field's size or position depends on the packet contents")

+ var ErrInputTooLarge = errors.New("XTCE document exceeds the maximum size this loader accepts")

+ var ErrInvalidComparison = errors.New("comparison value cannot be parsed")

+ var ErrInvalidEncoding = errors.New("data encoding attribute is not a legal value")

+ var ErrInvalidReference = errors.New("malformed name reference")

+ var ErrInvalidValue = errors.New("XTCE document has a value that cannot be read as its schema type")

+ var ErrMalformedXML = errors.New("malformed XML")

+ var ErrNoMatch = errors.New("no container matches the packet")

+ var ErrNotFound = errors.New("not found")

+ var ErrNotSpaceSystem = errors.New("root element is not an XTCE 1.2 SpaceSystem")

+ var ErrPacketTooShort = errors.New("packet is too short for the container layout")

+ var ErrTooDeep = errors.New("XTCE document nests deeper than this loader accepts")

+ var ErrUnresolvedReference = errors.New("name reference does not resolve")

+ var ErrUnsupportedCalibrator = errors.New("calibrator is not supported")

+ var ErrUnsupportedCriteria = errors.New("restriction criteria are not supported")

+ var ErrUnsupportedEncoding = errors.New("data encoding is not supported")

+ var ErrUnsupportedEntry = errors.New("entry cannot be placed in a layout")

+ type AbsoluteTimeParameterType struct

+ BaseType string

+ Encoding_ *TimeEncoding

+ InitialValue string

+ LongDescription string

+ Name string

+ ReferenceTime *ReferenceTime

+ ShortDescription string

+ func (t *AbsoluteTimeParameterType) Encoding() *DataEncoding

+ func (t *AbsoluteTimeParameterType) TypeKind() string

+ func (t *AbsoluteTimeParameterType) TypeName() string

+ type AggregateParameterType struct

+ Name string

+ Raw []byte

+ ShortDescription string

+ func (t *AggregateParameterType) Encoding() *DataEncoding

+ func (t *AggregateParameterType) TypeKind() string

+ func (t *AggregateParameterType) TypeName() string

+ type Argument struct

+ ArgumentTypeRef string

+ InitialValue string

+ Name string

+ ShortDescription string

+ type ArgumentAssignment struct

+ Name string

+ Value string

+ type ArgumentAssignmentList struct

+ Assignments []ArgumentAssignment

+ type ArgumentList struct

+ Arguments []*Argument

+ type ArrayParameterType struct

+ ArrayTypeRef string

+ Name string

+ Raw []byte

+ ShortDescription string

+ func (t *ArrayParameterType) Encoding() *DataEncoding

+ func (t *ArrayParameterType) TypeKind() string

+ func (t *ArrayParameterType) TypeName() string

+ type BaseContainer struct

+ ContainerRef string

+ RestrictionCriteria *RestrictionCriteria

+ type BaseMetaCommand struct

+ ArgumentAssignmentList *ArgumentAssignmentList

+ MetaCommandRef string

+ type BinaryDataEncoding struct

+ SizeInBits *IntegerValue

+ func (c BinaryDataEncoding) BitOrderOrDefault() string

+ func (c BinaryDataEncoding) ByteOrderOrDefault() string

+ type BinaryParameterType struct

+ InitialValue string

+ func (b *BinaryParameterType) Encoding() *DataEncoding

+ func (b *BinaryParameterType) TypeName() string

+ func (t *BinaryParameterType) TypeKind() string

+ type BlockMetaCommand struct

+ LongDescription string

+ MetaCommandStepList *RawXML

+ Name string

+ ShortDescription string

+ type BooleanParameterType struct

+ InitialValue string

+ OneStringValue string

+ ZeroStringValue string

+ func (b *BooleanParameterType) Encoding() *DataEncoding

+ func (b *BooleanParameterType) TypeName() string

+ func (t *BooleanParameterType) OneStringValueOrDefault() string

+ func (t *BooleanParameterType) TypeKind() string

+ func (t *BooleanParameterType) ZeroStringValueOrDefault() string

+ type Calibrator struct

+ MathOperation *RawXML

+ Name string

+ Polynomial *PolynomialCalibrator

+ Spline *SplineCalibrator

+ func (c *Calibrator) Calibrate(raw float64) (float64, error)

+ func (c *Calibrator) Kind() string

+ type CommandMetaData struct

+ MetaCommandSet *MetaCommandSet

+ ParameterSet *ParameterSet

+ ParameterTypeSet *ParameterTypeSet

+ type Comparison struct

+ ComparisonOperator string

+ Instance int64

+ ParameterRef string

+ UseCalibratedValue *bool

+ Value string

+ func (c *Comparison) Calibrated() bool

+ func (c *Comparison) Operator() string

+ type ComparisonList struct

+ Comparisons []Comparison

+ type ContainerRef struct

+ ContainerRef string

+ type ContainerSet struct

+ SequenceContainers []*SequenceContainer

+ type DataEncoding struct

+ Binary *BinaryDataEncoding

+ Float *FloatDataEncoding

+ Integer *IntegerDataEncoding

+ String *StringDataEncoding

+ func (d *DataEncoding) HasContextCalibrators() bool

+ func (d *DataEncoding) Kind() string

+ func (d *DataEncoding) SizeInBits() (uint, bool)

+ type Entry struct

+ ElementName string

+ IncludeCondition *RawXML

+ Kind EntryKind

+ LocationInContainerInBits *LocationInContainer

+ Ref string

+ RepeatEntry *Repeat

+ ShortDescription string

+ func (e Entry) String() string

+ type EntryKind int

+ const EntryContainerRef

+ const EntryOther

+ const EntryParameterRef

+ func (k EntryKind) String() string

+ type EntryList struct

+ Entries []Entry

+ func (l *EntryList) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

+ type EnumeratedParameterType struct

+ EnumerationList EnumerationList

+ InitialValue string

+ func (b *EnumeratedParameterType) Encoding() *DataEncoding

+ func (b *EnumeratedParameterType) TypeName() string

+ func (t *EnumeratedParameterType) TypeKind() string

+ type Enumeration struct

+ Label string

+ MaxValue *int64

+ ShortDescription string

+ Value int64

+ type EnumerationList struct

+ Enumerations []Enumeration

+ type Field struct

+ BitOffset uint

+ BitSize uint

+ Container *SequenceContainer

+ Entry Entry

+ Name string

+ Parameter *Parameter

+ Type ParameterType

+ func (f Field) String() string

+ type FixedInteger int64

+ func (f *FixedInteger) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

+ func (f *FixedInteger) UnmarshalXMLAttr(attr xml.Attr) error

+ func (f FixedInteger) Int64() int64

+ type FloatDataEncoding struct

+ ChangeThreshold *float64

+ ContextCalibratorList *RawXML

+ DefaultCalibrator *Calibrator

+ Encoding string

+ SizeInBits uint

+ func (c FloatDataEncoding) BitOrderOrDefault() string

+ func (c FloatDataEncoding) ByteOrderOrDefault() string

+ func (e *FloatDataEncoding) EncodingOrDefault() string

+ func (e *FloatDataEncoding) Size() uint

+ type FloatParameterType struct

+ InitialValue string

+ SizeInBits uint

+ func (b *FloatParameterType) Encoding() *DataEncoding

+ func (b *FloatParameterType) TypeName() string

+ func (t *FloatParameterType) Size() uint

+ func (t *FloatParameterType) TypeKind() string

+ type Header struct

+ Classification string

+ Date string

+ Validation string

+ Version string

+ type IntegerDataEncoding struct

+ ChangeThreshold *uint64

+ ContextCalibratorList *RawXML

+ DefaultCalibrator *Calibrator

+ Encoding string

+ SizeInBits uint

+ func (c IntegerDataEncoding) BitOrderOrDefault() string

+ func (c IntegerDataEncoding) ByteOrderOrDefault() string

+ func (e *IntegerDataEncoding) EncodingOrDefault() string

+ func (e *IntegerDataEncoding) Size() uint

+ type IntegerParameterType struct

+ InitialValue string

+ Signed *bool

+ SizeInBits uint

+ func (b *IntegerParameterType) Encoding() *DataEncoding

+ func (b *IntegerParameterType) TypeName() string

+ func (t *IntegerParameterType) IsSigned() bool

+ func (t *IntegerParameterType) Size() uint

+ func (t *IntegerParameterType) TypeKind() string

+ type IntegerValue struct

+ DiscreteLookupList *RawXML

+ DynamicValue *RawXML

+ FixedValue *FixedInteger

+ type Layout struct

+ BitSize uint

+ Container *SequenceContainer

+ Fields []Field

+ func (l *Layout) Extract(packet []byte) (*Packet, error)

+ type LocationInContainer struct

+ DiscreteLookupList *RawXML

+ DynamicValue *RawXML

+ FixedValue *FixedInteger

+ ReferenceLocation string

+ func (l *LocationInContainer) ReferenceLocationOrDefault() string

+ type MatchCriteria struct

+ BooleanExpression *RawXML

+ Comparison *Comparison

+ ComparisonList *ComparisonList

+ CustomAlgorithm *RawXML

+ type MetaCommand struct

+ Abstract bool

+ ArgumentList *ArgumentList

+ BaseMetaCommand *BaseMetaCommand

+ LongDescription string

+ Name string

+ ShortDescription string

+ type MetaCommandRef struct

+ Ref string

+ type MetaCommandSet struct

+ BlockMetaCommands []*BlockMetaCommand

+ MetaCommandRefs []*MetaCommandRef

+ MetaCommands []*MetaCommand

+ type Packet struct

+ Layout *Layout

+ Values []Value

+ func (p *Packet) Err() error

+ func (p *Packet) Get(name string) (Value, bool)

+ func (p *Packet) String() string

+ type Parameter struct

+ InitialValue string

+ LongDescription string

+ Name string

+ ParameterTypeRef string

+ ShortDescription string

+ type ParameterSet struct

+ Parameters []*Parameter

+ type ParameterType interface

+ Encoding func() *DataEncoding

+ TypeKind func() string

+ TypeName func() string

+ type ParameterTypeSet struct

+ AbsoluteTimeTypes []*AbsoluteTimeParameterType

+ AggregateTypes []*AggregateParameterType

+ ArrayTypes []*ArrayParameterType

+ BinaryTypes []*BinaryParameterType

+ BooleanTypes []*BooleanParameterType

+ EnumeratedTypes []*EnumeratedParameterType

+ FloatTypes []*FloatParameterType

+ IntegerTypes []*IntegerParameterType

+ RelativeTimeTypes []*RelativeTimeParameterType

+ StringTypes []*StringParameterType

+ func (p *ParameterTypeSet) All() []ParameterType

+ func (p *ParameterTypeSet) Len() int

+ type PolynomialCalibrator struct

+ Terms []Term

+ func (p *PolynomialCalibrator) Apply(raw float64) float64

+ type RawXML struct

+ Inner []byte

+ type ReferenceTime struct

+ Epoch string

+ OffsetFrom *RawXML

+ type RelativeTimeParameterType struct

+ Name string

+ Raw []byte

+ ShortDescription string

+ func (t *RelativeTimeParameterType) Encoding() *DataEncoding

+ func (t *RelativeTimeParameterType) TypeKind() string

+ func (t *RelativeTimeParameterType) TypeName() string

+ type Repeat struct

+ Count *IntegerValue

+ Offset *IntegerValue

+ type RestrictionCriteria struct

+ NextContainer *ContainerRef

+ type SequenceContainer struct

+ Abstract bool

+ BaseContainer *BaseContainer

+ EntryList EntryList

+ IdlePattern string

+ LongDescription string

+ Name string

+ ShortDescription string

+ func (c *SequenceContainer) Layout() (*Layout, error)

+ func (c *SequenceContainer) Owner() *SpaceSystem

+ type SpaceSystem struct

+ CommandMetaData *CommandMetaData

+ Header *Header

+ LongDescription string

+ Name string

+ OperationalStatus string

+ ShortDescription string

+ SubSystems []*SpaceSystem

+ TelemetryMetaData *TelemetryMetaData

+ XMLName xml.Name

+ func Load(r io.Reader) (*SpaceSystem, error)

+ func LoadFile(path string) (*SpaceSystem, error)

+ func LoadWithLimit(r io.Reader, maxSize int64) (*SpaceSystem, error)

+ func (s *SpaceSystem) Containers() []*SequenceContainer

+ func (s *SpaceSystem) FindContainer(qualifiedName string) (*SequenceContainer, error)

+ func (s *SpaceSystem) FindParameter(qualifiedName string) (*Parameter, error)

+ func (s *SpaceSystem) FindParameterType(qualifiedName string) (ParameterType, error)

+ func (s *SpaceSystem) FindSpaceSystem(qualifiedName string) (*SpaceSystem, error)

+ func (s *SpaceSystem) Humanize() string

+ func (s *SpaceSystem) LayoutOf(qualifiedName string) (*Layout, error)

+ func (s *SpaceSystem) Match(root *SequenceContainer, packet []byte) (*Packet, error)

+ func (s *SpaceSystem) MatchFrom(root *SequenceContainer, packet []byte) (*SequenceContainer, error)

+ func (s *SpaceSystem) MetaCommands() []*MetaCommand

+ func (s *SpaceSystem) ParameterTypes() []ParameterType

+ func (s *SpaceSystem) Parameters() []*Parameter

+ func (s *SpaceSystem) Parent() *SpaceSystem

+ func (s *SpaceSystem) QualifiedName() string

+ func (s *SpaceSystem) ResolveContainer(ref string) (*SequenceContainer, error)

+ func (s *SpaceSystem) ResolveParameter(ref string) (*Parameter, error)

+ func (s *SpaceSystem) ResolveParameterType(ref string) (ParameterType, error)

+ func (s *SpaceSystem) Root() *SpaceSystem

+ func (s *SpaceSystem) Validate() error

+ func (s *SpaceSystem) Walk(fn func(*SpaceSystem) bool)

+ type SplineCalibrator struct

+ Extrapolate bool

+ Order uint

+ Points []SplinePoint

+ func (s *SplineCalibrator) Apply(raw float64) (float64, error)

+ type SplinePoint struct

+ Calibrated float64

+ Order uint

+ Raw float64

+ type StringDataEncoding struct

+ Encoding string

+ SizeInBits *StringSize

+ Variable *RawXML

+ func (c StringDataEncoding) BitOrderOrDefault() string

+ func (c StringDataEncoding) ByteOrderOrDefault() string

+ func (e *StringDataEncoding) EncodingOrDefault() string

+ type StringParameterType struct

+ CharacterWidth string

+ InitialValue string

+ RestrictionPattern string

+ func (b *StringParameterType) Encoding() *DataEncoding

+ func (b *StringParameterType) TypeName() string

+ func (t *StringParameterType) TypeKind() string

+ type StringSize struct

+ Fixed *FixedInteger

+ LeadingSize *RawXML

+ TerminationChar string

+ type TelemetryMetaData struct

+ ContainerSet *ContainerSet

+ ParameterSet *ParameterSet

+ ParameterTypeSet *ParameterTypeSet

+ type Term struct

+ Coefficient float64

+ Exponent uint

+ type TimeEncoding struct

+ BinaryDataEncoding *BinaryDataEncoding

+ FloatDataEncoding *FloatDataEncoding

+ IntegerDataEncoding *IntegerDataEncoding

+ Offset *float64

+ Scale *float64

+ StringDataEncoding *StringDataEncoding

+ Units string

+ func (e *TimeEncoding) DataEncoding() *DataEncoding

+ func (e *TimeEncoding) OffsetOrDefault() float64

+ func (e *TimeEncoding) ScaleOrDefault() float64

+ func (e *TimeEncoding) UnitsOrDefault() string

+ type Unit struct

+ Description string

+ Factor string

+ Power *float64

+ Value string

+ func (u *Unit) PowerOrDefault() float64

+ type UnitSet struct

+ Units []Unit

+ type ValidationError struct

+ Detail string

+ Element string

+ Err error

+ SpaceSystem string

+ func (e *ValidationError) Error() string

+ func (e *ValidationError) Unwrap() error

+ type ValidationErrors []*ValidationError

+ func (e ValidationErrors) Error() string

+ func (e ValidationErrors) Is(target error) bool

+ type Value struct

+ Engineering any

+ Err error

+ Field Field

+ Raw any

+ func (v Value) Bytes() ([]byte, bool)

+ func (v Value) Float() (float64, bool)

+ func (v Value) Name() string

+ func (v Value) String() string

+ func (v Value) Text() (string, bool)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL