Uses of Package
org.yamcs.xtce

Packages that use org.yamcs.xtce

Package	Description
org.yamcs.xtce
org.yamcs.xtce.util
org.yamcs.xtce.xml

Classes in org.yamcs.xtce used by org.yamcs.xtce

Class and Description
AbsoluteTimeDataType Used to contain an absolute time.
AbsoluteTimeParameterType
AggregateDataType
AggregateParameterType AggegateParameters are analogous to a C struct, they are an aggregation of related data items.
AlarmLevels An enumerated list of the possible alarm levels
AlarmRanges Contains five ranges: Watch, Warning, Distress, Critical, and Severe each in increasing severity.
AlarmReportType Allow control over when alarms are reported.
AlarmType Base type for alarms
Algorithm Abstract algorithm - just defines the inputs, outputs and triggers Note: the XTCE names the inputs and outputs "Sets".
Algorithm.Scope
AncillaryData Used for any other data associated with each named object.
Argument Describe the name of an Argument its NameReference to an ArgumentType in ArgumentTypeSet
ArgumentAssignment
ArgumentEntry An entry that is a single Argument
ArgumentType Interface to be implemented by all the argument types
ArrayDataType An array of values of the type referenced in ArrayDataType.type and have the number of array dimensions as specified in ArrayDataType.numberOfDimensions
ArrayParameterType Describe an array parameter type.
BaseDataType Base class for all simple XTCE types - tha is all types except AggregateDataType and ArrayDataType
BaseTimeDataType
BinaryDataEncoding For binary data or for integer, float, string, or time data that is not in any of the known encoding formats.
BinaryDataEncoding.Type
BinaryDataType
BinaryParameterType
BooleanDataType
BooleanExpression
BooleanParameterType
Calibrator
CheckWindow 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.
CheckWindow.TimeWindowIsRelativeToType
CommandContainer
CommandVerifier XTCE: A command verifier is used to check that the command has been successfully executed.
CommandVerifier.TerminationAction what can happen when the verification finishes XTCE does not specify very well, just that each verifier returns true or false.
CommandVerifier.Type
Comparison A simple ParameterInstanceRef to value comparison.
Container An abstract block of data; used as the base type for more specific container types
ContainerEntry Entry from a container that makes reference to another container.
ContextCalibrator Context calibrations are applied when the ContextMatch is true.
CriteriaEvaluator
CustomAlgorithm Algorithm implemented in a specific language.
DataEncoding Describes how a particular piece of data is sent or received from some non-native, off-platform device.
DataSource The data source is associated to a Parameter and specifies the source of the values for that parameter.
DataType Interface for all XTCE data types.
EnumeratedDataType
EnumeratedParameterType
EnumerationAlarm 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
EnumerationAlarm.EnumerationAlarmItem
EnumerationContextAlarm Context alarms are applied when the ContextMatch is true.
ExpressionList This class does not have an equivalence in the XTCE standard Created as a base-class for ORedConditions and ANDedConditions
FloatDataEncoding For common encodings of floating point data.
FloatDataEncoding.Encoding
FloatDataType
FloatParameterType
FloatValidRange Holds the min/max of a ValidRange for floating point.
Header A header contains general information about the system or subsystem.
History Capture creation or change history of document.
IndirectParameterRefEntry An entry whose name is given by the value of a ParamameterInstance.
InputParameter Input parameters for algorithms
IntegerDataEncoding For all major encodings of integer data
IntegerDataEncoding.Encoding
IntegerDataType Contains an integral value.
IntegerParameterType
IntegerRange An integral range of numbers.
IntegerValidRange 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.
IntegerValue
MatchCriteria
MathOperation Postfix (aka Reverse Polish Notation (RPN)) notation is used to describe mathematical equations.
MathOperation.Element
MathOperation.ElementType
MathOperator Mathematical operators used in the math operation.
Member Describe a member field in an AggregateDataType.
MetaCommand The MetaCommand is the base type for a tele-command.
NameDescription The type definition used by most elements that require a name with optional descriptions.
NonStandardData
NumericAlarm Alarms associated with numeric data types
NumericContextAlarm Context alarms are applied when the ContextMatch is true.
NumericDataEncoding Interface that makes it easier to work with either of FloatDataEncoding or IntegerDataEncoding
NumericDataType
NumericParameterType
OnParameterUpdateTrigger Names a parameter that upon change will start the execution of the algorithm.
OnPeriodicRateTrigger
OperatorType
OutputParameter
Parameter A Parameter is a description of something that can have a value; it is not the value itself.
ParameterEntry An entry that is a single Parameter
ParameterInstanceRef A reference to an instance of a Parameter.
ParameterType Interface implemented by all the parameters types.
PathElement 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] both name and index can be null
RateInStream 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.
ReferenceTime Most time values are relative to another time e.g. seconds are relative to minutes, minutes are relative to hours.
Repeat Hold a structure that can be repeated X times, where X is the Count
SequenceContainer A list of raw parameters, parameter segments, stream segments, containers, or container segments.
SequenceEntry An abstract type used by sequence containers.
SequenceEntry.ReferenceLocationType The location may be relative to the start of the container (containerStart), or relative to the end of the previous entry (previousEntry)
Significance XTCE: Significance provides some cautionary information about the potential consequence of each MetaCommand.
Significance.Levels
SpaceSystem SpaceSystem is a collection of SpaceSystem(s) including space assets, ground assets, multi-satellite systems and sub-systems.
SplinePoint a spline is a set on points from which a curve may be drawn to interpolate raw to calibrated values
StringDataEncoding For common encodings of string data
StringDataEncoding.SizeType
StringDataType
StringParameterType
SystemParameter Parameters made on the fly.
TimeEpoch
TimeEpoch.CommonEpochs
TransmissionConstraint 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.
TriggeredMathOperation
TriggerSetType A trigger is used to initiate the processing of some algorithm.
UnitType Used to hold the unit(s) plus possibly the exponent and factor for the units
ValueEnumeration
ValueEnumerationRange

Classes in org.yamcs.xtce used by org.yamcs.xtce.util

Class and Description
DataType Interface for all XTCE data types.
NameDescription The type definition used by most elements that require a name with optional descriptions.
PathElement 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] both name and index can be null

Classes in org.yamcs.xtce used by org.yamcs.xtce.xml

Class and Description
ParameterType Interface implemented by all the parameters types.
SpaceSystem SpaceSystem is a collection of SpaceSystem(s) including space assets, ground assets, multi-satellite systems and sub-systems.