Package org.yamcs.xtce
package org.yamcs.xtce
-
ClassDescriptionUsed to contain an absolute time.AbsoluteTimeDataType.Builder<T extends AbsoluteTimeDataType.Builder<T>>AggregateDataType.Builder<T extends AggregateDataType.Builder<T>>AggegateParameters are analogous to a C struct, they are an aggregation of related data items.An enumerated list of the possible alarm levelsContains five ranges: Watch, Warning, Distress, Critical, and Severe each in increasing severity.Allow control over when alarms are reported.Base type for alarmsAbstract algorithm - defines the inputs, outputs and triggersUsed for any other data associated with each named object.Describe the name of an Argument its NameReference to an ArgumentType in ArgumentTypeSetAn entry that is a single ArgumentA reference to a command argument or to a member of an argument of type aggregateInterface to be implemented by all the argument typesArgumentType.Builder<T extends ArgumentType.Builder<T>>Describe an array parameter type.An array of values of the type referenced in
ArrayDataType.typeand have the number of array dimensions as specified inArrayDataType.numberOfDimensionsArrayDataType.Builder<T extends ArrayDataType.Builder<T>>Describe an entry that is an array parameter.Describe an array parameter type.Base class for all simple XTCE types - tha is all types exceptAggregateDataTypeandArrayDataTypeBaseDataType.Builder<T extends BaseDataType.Builder<T>>BaseTimeDataType.Builder<T extends BaseTimeDataType.Builder<T>>Although 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).BinaryDataType.Builder<T extends BinaryDataType.Builder<T>>For boolean data.BooleanDataType.Builder<T extends BooleanDataType.Builder<T>>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 ArgumentComparisonAll 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 typesEntry 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.DataEncoding.Builder<T extends DataEncoding.Builder<T>>The data source is associated to aParameterand specifies the source of the values for that parameter.Interface for all XTCE data types.DataType.Builder<T extends DataType.Builder<T>>Uses a parameter instance to obtain the value.EnumeratedDataType.Builder<T extends EnumeratedDataType.Builder<T>>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 ParameterContext 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 ANDedConditionsA simple long valueHolds 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.FloatDataType.Builder<T extends FloatDataType.Builder<T>>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.An entry whose name is given by the value of a ParamameterInstance.Input parameters for algorithms.For all major encodings of integer dataContains an integral value.IntegerDataType.Builder<T extends IntegerDataType.Builder<T>>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.NamedDescriptionIndex<T extends NameDescription>Keeps a list ofNameDescriptionobjects 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.NameDescription.Builder<T extends NameDescription.Builder<T>>NonStandardData<T extends NonStandardData<T>>XTCE: This type describes how a numeric value should be represented in engineering/calibrated form.Alarms associated with numeric data typesContext alarms are applied when the ContextMatch is true.Interface that makes it easier to work with either of FloatDataEncoding or IntegerDataEncodingNumericDataEncoding.Builder<T extends NumericDataEncoding.Builder<T>>NumericDataType.Builder<T extends NumericDataType.Builder<T>>NumericParameterType.Builder<T extends NumericParameterType.Builder<T>>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 ParameterA reference to an instance of a Parameter.Interface implemented by all the parameters types.ParameterType.Builder<T extends ParameterType.Builder<T>>XTCE: A parameter change in value or specified delta change in valueDescribes 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 calibration type where a curve in a raw vs calibrated plane is described using a set of polynomial coefficients.Specifies the number baseXTCE 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 CountA 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 valuesFor common encodings of string data.StringDataType.Builder<T extends StringDataType.Builder<T>>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 unitsXtceDB database