All Classes and Interfaces
Class
Description
Used to contain an absolute time.
Abstract class for XML readers
Represents a list of aggregate member names.
AggegateParameters are analogous to a C struct, they are an aggregation of related data items.
operations to aggregates or arrays
An enumerated list of the possible alarm levels
Contains five ranges: Watch, Warning, Distress, Critical, and Severe each in increasing severity.
Allow control over when alarms are reported.
Base type for alarms
Abstract algorithm - defines the inputs, outputs and triggers
Used for any other data associated with each named object.
Describe the name of an Argument its NameReference to an ArgumentType in ArgumentTypeSet
An entry that is a single Argument
A reference to a command argument or to a member of an argument of type aggregate
Argument references are used in algorithms or match criteria expressions part of transmission constraints or command
verifiers.
Interface to be implemented by all the argument types
Describe an array parameter type.
An array of values of the type referenced in
ArrayDataType.type and have the number of array dimensions as specified in
ArrayDataType.numberOfDimensionsDescribe an entry that is an array parameter.
Describe an array parameter type.
Base class for all simple XTCE types - tha is all types except
AggregateDataType and ArrayDataTypeAlthough XTCE suggests that this class could be used to encode/decode integer/float/string data, In Yamcs this is
used just for
encoding binary data (i.e. binary to binary).
For boolean data.
From XTCE: Holds a time to stop checking and optional time to start checking and whether window is relative to
command release or last verifier.
XTCE: A command verifier is used to check that the command has been successfully executed.
what can happen when the verification finishes XTCE does not specify very well, just that each verifier returns
true or false.
This corresponds to XTCE Comparison or ArgumentComparison
All comparisons must be true.
The Condition is XTCE overlaps with the Comparison.
An abstract block of data; used as the base type for more specific container types
Entry from a container that makes reference to another container.
Context calibrations are applied when the ContextMatch is true.
Algorithm implemented in a specific language.
Describes how a particular piece of data is sent or received from some non-native, off-platform device.
The data source is associated to a
Parameter and specifies the source of the values for that parameter.Interface for all XTCE data types.
A range of numbers [min, max) where both min and max can be inclusive or exclusive.
Uses a parameter instance to obtain the value.
Alarm conditions for Enumerations
An additional check needs to be performed to ensure that the enumeration values in the alarms are legal
enumeration values for the Parameter
Context alarms are applied when the ContextMatch is true.
This class does not have an equivalence in the XTCE standard
Created as a base-class for ORedConditions and ANDedConditions
A simple long value
Holds an optional attributes name, bitOrder, byteOrderList, required attributes binaryValue, sizeInBits and optional
LocationInContainerInBits, RepeatEntry and IncludeCondition.
Represent aspects of an float, probably using IntegerDataEncoding with a calibrator or FloatDataEncoding.
For common encodings of floating point data.
Holds the min/max of a ValidRange for floating point.
A header contains general information about the system or subsystem.
Capture creation or change history of document.
Stores an incomplete type together with some references which if all resolved, will make the type complete.
An entry whose name is given by the value of a ParamameterInstance.
Input parameters for algorithms.
For all major encodings of integer data
Contains an integral value.
An integral range of numbers.
XTCE: Holds an integer range and flag denoting whether the range is calculated on the value using the source data type or the destination data type.
Postfix (aka Reverse Polish Notation (RPN)) notation is used to describe mathematical equations.
Mathematical operators used in the math operation.
Describe a member field in an AggregateDataType.
The MetaCommand is the base type for a tele-command.
Keeps a list of
NameDescription objects with corresponding indexes to be able to retrieve them in any namespace.The type definition used by most elements that require a name with optional descriptions.
Used when referencing a directory style "NameType".
XTCE: This type describes how a numeric value should be represented in engineering/calibrated form.
Alarms associated with numeric data types
Context alarms are applied when the ContextMatch is true.
Interface that makes it easier to work with either of FloatDataEncoding or IntegerDataEncoding
Names a parameter that upon change will start the execution of the algorithm.
A Parameter is a description of something that can have a value; it is not the value itself.
An entry that is a single Parameter
A reference to an instance of a Parameter.
Interface implemented by all the parameters types.
XTCE: A parameter change in value or specified delta change in value
Describes an element from an aggregate/array member access path For example, the third element from this path :
a/c[2]/d[0][5]/x
is:
name = "d"
index = [0, 5]
a/c[2]/d[0][5]/x
is:
name = "d"
index = [0, 5]
A calibration type where a curve in a raw vs calibrated plane is described using a set of polynomial coefficients.
Specifies the number base
XTCE doc:
Used in packaging to define the expected rate that any individual container will be in a Stream
DIFFERS_FROM_XTCE
XTCE defines two types: perSecond and perContainerUpdate.
Most time values are relative to another time e.g. seconds are relative to minutes, minutes are relative to hours.
Hold a structure that can be repeated X times, where X is the Count
A list of raw parameters, parameter segments, stream segments, containers, or container segments.
An abstract type used by sequence containers.
The location may be relative to the start of the container (containerStart),
or relative to the end of the previous entry (previousEntry)
XTCE: Significance provides some cautionary information about the potential consequence of each MetaCommand.
The XTCE aliases given to the Levels are from XTCE 1.2 and they correspond to ISO 14950 as well as the description found
here.
SpaceSystem is a collection of SpaceSystem(s) including space assets, ground assets, multi-satellite systems and
sub-systems.
A calibration type where a segmented line in a raw vs calibrated plane is described using a set of points.
a spline is a set on points from which a curve may be drawn to interpolate raw to calibrated values
For common encodings of string data.
Parameters made on the fly.
A CommandTransmission constraint is used to check that the command can be run in the current operating mode and may
block the transmission of the command if the constraint condition is true.
A trigger is used to initiate the processing of some algorithm.
Used to hold the unit(s) plus possibly the exponent and factor for the units
XtceDB database
unchecked exception thrown from the XTCE loader.
Class substituting not implemented XTCE classes
This class reads the XTCE XML files.