Uses of Package
org.yamcs.xtce
Package
Description
-
ClassDescriptionA list of raw parameters, parameter segments, stream segments, containers, or container segments.
-
ClassDescriptionDescribe the name of an Argument its NameReference to an ArgumentType in ArgumentTypeSetThe MetaCommand is the base type for a tele-command.
-
-
ClassDescriptionAlgorithm implemented in a specific language.Describes how a particular piece of data is sent or received from some non-native, off-platform device.
-
ClassDescriptionAbstract algorithm - defines the inputs, outputs and triggersA reference to a command argument or to a member of an argument of type aggregateAlgorithm implemented in a specific language.Input parameters for algorithms.A Parameter is a description of something that can have a value; it is not the value itself.A reference to an instance of a Parameter.A trigger is used to initiate the processing of some algorithm.
-
ClassDescriptionDescribe the name of an Argument its NameReference to an ArgumentType in ArgumentTypeSetXTCE: A command verifier is used to check that the command has been successfully executed.The MetaCommand is the base type for a tele-command.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]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. -
ClassDescriptionAn abstract block of data; used as the base type for more specific container typesA list of raw parameters, parameter segments, stream segments, containers, or container segments.
-
ClassDescriptionContains five ranges: Watch, Warning, Distress, Critical, and Severe each in increasing severity.Abstract 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 ArgumentTypeSetA reference to a command argument or to a member of an argument of type aggregateInterface to be implemented by all the argument typesAlthough 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).XTCE: A command verifier is used to check that the command has been successfully executed.This corresponds to XTCE Comparison or ArgumentComparisonContext calibrations are applied when the ContextMatch is true.Describes how a particular piece of data is sent or received from some non-native, off-platform device.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.Holds an optional attributes name, bitOrder, byteOrderList, required attributes binaryValue, sizeInBits and optional LocationInContainerInBits, RepeatEntry and IncludeCondition.Input parameters for algorithms.The MetaCommand is the base type for a tele-command.The type definition used by most elements that require a name with optional descriptions.Alarms associated with numeric data typesContext alarms are applied when the ContextMatch is true.A Parameter is a description of something that can have a value; it is not the value itself.A reference to an instance of a Parameter.Interface implemented by all the parameters types.A calibration type where a curve in a raw vs calibrated plane is described using a set of polynomial coefficients.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.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.For common encodings of string data.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.Used to hold the unit(s) plus possibly the exponent and factor for the units
-
ClassDescriptionAbstract algorithm - defines the inputs, outputs and triggersDescribe the name of an Argument its NameReference to an ArgumentType in ArgumentTypeSetInterface to be implemented by all the argument typesThis corresponds to XTCE Comparison or ArgumentComparisonAn abstract block of data; used as the base type for more specific container typesContext calibrations are applied when the ContextMatch is true.Describes how a particular piece of data is sent or received from some non-native, off-platform device.Interface for all XTCE data types.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 ParameterContext alarms are applied when the ContextMatch is true.For common encodings of floating point data.Holds the min/max of a ValidRange for floating point.Input parameters for algorithms.For all major encodings of integer dataXTCE: 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.The MetaCommand is the base type for a tele-command.Alarms associated with numeric data typesContext alarms are applied when the ContextMatch is true.A Parameter is a description of something that can have a value; it is not the value itself.A reference to an instance of a Parameter.Interface implemented by all the parameters types.A calibration type where a curve in a raw vs calibrated plane is described using a set of polynomial coefficients.A list of raw parameters, parameter segments, stream segments, containers, or container segments.An abstract type used by sequence containers.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.Parameters made on the fly.XtceDB database
-
ClassDescriptionAggegateParameters are analogous to a C struct, they are an aggregation of related data items.The data source is associated to a
Parameter
and specifies the source of the values for that parameter.A Parameter is a description of something that can have a value; it is not the value itself.Interface implemented by all the parameters types.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]An abstract type used by sequence containers.Parameters made on the fly.Used to hold the unit(s) plus possibly the exponent and factor for the units -
ClassDescriptionSpaceSystem is a collection of SpaceSystem(s) including space assets, ground assets, multi-satellite systems and sub-systems.
-
ClassDescriptionA Parameter is a description of something that can have a value; it is not the value itself.
-
ClassDescriptionA Parameter is a description of something that can have a value; it is not the value itself.
-
ClassDescriptionSpaceSystem is a collection of SpaceSystem(s) including space assets, ground assets, multi-satellite systems and sub-systems.
-
ClassDescriptionA Parameter is a description of something that can have a value; it is not the value itself.
-
ClassDescriptionA Parameter is a description of something that can have a value; it is not the value itself.
-
ClassDescriptionAggegateParameters are analogous to a C struct, they are an aggregation of related data items.Interface implemented by all the parameters types.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] -
ClassDescriptionUsed to contain an absolute time.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 typesDescribe an array parameter type.An array of values of the type referenced in
ArrayDataType.type
and have the number of array dimensions as specified inArrayDataType.numberOfDimensions
Describe an array parameter type.Base class for all simple XTCE types - tha is all types exceptAggregateDataType
andArrayDataType
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).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 ArgumentComparisonAn 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.The data source is associated to aParameter
and specifies the source of the values for that parameter.Interface for all XTCE data types.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 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 ANDedConditionsRepresent 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.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.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.The type definition used by most elements that require a name with optional descriptions.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 IntegerDataEncodingNames 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.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]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 spline is a set on points from which a curve may be drawn to interpolate raw to calibrated valuesFor 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 -
ClassDescriptionDescribe the name of an Argument its NameReference to an ArgumentType in ArgumentTypeSetInterface for all XTCE data types.The MetaCommand is the base type for a tele-command.The type definition used by most elements that require a name with optional descriptions.A Parameter is a description of something that can have a value; it is not the value itself.Interface implemented by all the parameters types.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]SpaceSystem is a collection of SpaceSystem(s) including space assets, ground assets, multi-satellite systems and sub-systems. -
ClassDescriptionContext calibrations are applied when the ContextMatch is true.The data source is associated to a
Parameter
and specifies the source of the values for that parameter.A Parameter is a description of something that can have a value; it is not the value itself.SpaceSystem is a collection of SpaceSystem(s) including space assets, ground assets, multi-satellite systems and sub-systems. -
ClassDescriptionInterface to be implemented by all the argument typesContext calibrations are applied when the ContextMatch is true.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 Parameter is a description of something that can have a value; it is not the value itself.Interface implemented by all the parameters types.SpaceSystem is a collection of SpaceSystem(s) including space assets, ground assets, multi-satellite systems and sub-systems. -
ClassDescriptionUses a parameter instance to obtain the value.SpaceSystem is a collection of SpaceSystem(s) including space assets, ground assets, multi-satellite systems and sub-systems.