Serialized Form

Package org.yamcs.xtce

Class org.yamcs.xtce.AbsoluteTimeArgumentType

class AbsoluteTimeArgumentType extends AbsoluteTimeDataType implements Serializable

serialVersionUID:

1L

Class org.yamcs.xtce.AbsoluteTimeDataType

class AbsoluteTimeDataType extends BaseTimeDataType implements Serializable

serialVersionUID:

1L

Serialized Fields

initialValue

String initialValue

referenceTime

ReferenceTime referenceTime

Class org.yamcs.xtce.AbsoluteTimeParameterType

class AbsoluteTimeParameterType extends AbsoluteTimeDataType implements Serializable

serialVersionUID:

1L

Class org.yamcs.xtce.AggregateArgumentType

class AggregateArgumentType extends AggregateDataType implements Serializable

serialVersionUID:

2L

Class org.yamcs.xtce.AggregateDataType

class AggregateDataType extends NameDescription implements Serializable

serialVersionUID:

1L

Serialized Fields

memberList

List<Member> memberList

Class org.yamcs.xtce.AggregateParameterType

class AggregateParameterType extends AggregateDataType implements Serializable

serialVersionUID:

1L

Class org.yamcs.xtce.AlarmRanges

class AlarmRanges extends Object implements Serializable

serialVersionUID:

200706052351L

Serialized Fields

criticalRange

DoubleRange criticalRange

distressRange

DoubleRange distressRange

severeRange

DoubleRange severeRange

warningRange

DoubleRange warningRange

watchRange

DoubleRange watchRange

Class org.yamcs.xtce.AlarmType

class AlarmType extends Object implements Serializable

serialVersionUID:

7443202826018275789L

Serialized Fields

autoAck

boolean autoAck

latching

boolean latching

minViolations

int minViolations

reportType

AlarmReportType reportType

Class org.yamcs.xtce.Algorithm

class Algorithm extends NameDescription implements Serializable

serialVersionUID:

6L

Serialized Fields

inputList

List<InputParameter> inputList

outputList

List<OutputParameter> outputList

scope

Algorithm.Scope scope

triggerSet

TriggerSetType triggerSet

Class org.yamcs.xtce.AncillaryData

class AncillaryData extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

href

URI href

mimeType

String mimeType

name

String name

value

String value

Class org.yamcs.xtce.ANDedConditions

class ANDedConditions extends ExpressionList implements Serializable

serialVersionUID:

6301730763127090210L

Class org.yamcs.xtce.Argument

class Argument extends NameDescription implements Serializable

serialVersionUID:

7L

Serialized Fields

argumentType

ArgumentType argumentType

initialValue

Object initialValue

Class org.yamcs.xtce.ArgumentAssignment

class ArgumentAssignment extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

argumentName

String argumentName

argumentValue

String argumentValue

Class org.yamcs.xtce.ArgumentEntry

class ArgumentEntry extends SequenceEntry implements Serializable

serialVersionUID:

1L

Serialized Fields

argument

Argument argument

Class org.yamcs.xtce.ArgumentInstanceRef

class ArgumentInstanceRef extends ParameterOrArgumentRef implements Serializable

serialVersionUID:

1L

Serialized Fields

argument

Argument argument

Class org.yamcs.xtce.ArrayArgumentType

class ArrayArgumentType extends ArrayDataType implements Serializable

serialVersionUID:

2L

Class org.yamcs.xtce.ArrayDataType

class ArrayDataType extends NameDescription implements Serializable

serialVersionUID:

1L

Serialized Fields

dim

List<IntegerValue> dim

initialValue

Object[] initialValue

numberOfDimensions

int numberOfDimensions

type

DataType type

Class org.yamcs.xtce.ArrayParameterEntry

class ArrayParameterEntry extends ParameterEntry implements Serializable

serialVersionUID:

2L

Serialized Fields

dim

List<IntegerValue> dim

parameter

Parameter parameter

Class org.yamcs.xtce.ArrayParameterType

class ArrayParameterType extends ArrayDataType implements Serializable

serialVersionUID:

1L

Class org.yamcs.xtce.BaseDataType

class BaseDataType extends NameDescription implements Serializable

serialVersionUID:

3L

Serialized Fields

encoding

DataEncoding encoding

unitSet

List<UnitType> unitSet

Class org.yamcs.xtce.BaseTimeDataType

class BaseTimeDataType extends BaseDataType implements Serializable

serialVersionUID:

2L

Serialized Fields

needsScaling

boolean needsScaling

offset

double offset

scale

double scale

Class org.yamcs.xtce.BinaryArgumentType

class BinaryArgumentType extends BinaryDataType implements Serializable

serialVersionUID:

1L

Class org.yamcs.xtce.BinaryDataEncoding

class BinaryDataEncoding extends DataEncoding implements Serializable

serialVersionUID:

3L

Serialized Fields

dynamicSize

DynamicIntegerValue dynamicSize

For variable-sized parameters or arguments, a reference to the parameter or argument containing the size.

sizeInBitsOfSizeTag

int sizeInBitsOfSizeTag

type

BinaryDataEncoding.Type type

Class org.yamcs.xtce.BinaryDataType

class BinaryDataType extends BaseDataType implements Serializable

serialVersionUID:

3L

Serialized Fields

initialValue

byte[] initialValue

sizeRangeInBytes

IntegerRange sizeRangeInBytes

DIFFERS_FROM_XTCE XTCE does not define a size range

Class org.yamcs.xtce.BinaryParameterType

class BinaryParameterType extends BinaryDataType implements Serializable

serialVersionUID:

200805131551L

Class org.yamcs.xtce.BooleanArgumentType

class BooleanArgumentType extends BooleanDataType implements Serializable

serialVersionUID:

3L

Class org.yamcs.xtce.BooleanDataEncoding

class BooleanDataEncoding extends DataEncoding implements Serializable

serialVersionUID:

200805131551L

Class org.yamcs.xtce.BooleanDataType

class BooleanDataType extends BaseDataType implements Serializable

serialVersionUID:

2L

Serialized Fields

initialValue

Boolean initialValue

oneStringValue

String oneStringValue

zeroStringValue

String zeroStringValue

Class org.yamcs.xtce.BooleanParameterType

class BooleanParameterType extends BooleanDataType implements Serializable

serialVersionUID:

1L

Class org.yamcs.xtce.CheckWindow

class CheckWindow extends Object implements Serializable

serialVersionUID:

2L

Serialized Fields

timeToStartChecking

long timeToStartChecking

timeToStopChecking

long timeToStopChecking

timeWindowIsRelativeTo

CheckWindow.TimeWindowIsRelativeToType timeWindowIsRelativeTo

Class org.yamcs.xtce.CommandContainer

class CommandContainer extends Container implements Serializable

serialVersionUID:

1L

Serialized Fields

entryList

ArrayList<SequenceEntry> entryList

Class org.yamcs.xtce.CommandVerifier

class CommandVerifier extends Object implements Serializable

serialVersionUID:

2L

Serialized Fields

algorithm

Algorithm algorithm

checkWindow

CheckWindow checkWindow

XTCE: A time based check window

containerRef

SequenceContainer containerRef

matchCriteria

MatchCriteria matchCriteria

onFail

CommandVerifier.TerminationAction onFail

onSuccess

CommandVerifier.TerminationAction onSuccess

onTimeout

CommandVerifier.TerminationAction onTimeout

paraValueChange

ParameterValueChange paraValueChange

returnParameter

Parameter returnParameter

stage

String stage

Command verification stage. This corresponds to the verifier name from XTCE.

type

CommandVerifier.Type type

verifierFailOnFirstFailedMatch

boolean verifierFailOnFirstFailedMatch

Class org.yamcs.xtce.Comparison

class Comparison extends Object implements Serializable

serialVersionUID:

10L

Serialized Fields

comparisonOperator

OperatorType comparisonOperator

ref

ParameterOrArgumentRef ref

stringValue

String stringValue

Class org.yamcs.xtce.ComparisonList

class ComparisonList extends Object implements Serializable

serialVersionUID:

200805131551L

Serialized Fields

comparisons

ArrayList<Comparison> comparisons

Class org.yamcs.xtce.ComparisonOperatorType

class ComparisonOperatorType extends Object implements Serializable

serialVersionUID:

200706141154L

Serialized Fields

type

org.yamcs.xtce.ComparisonOperatorType.Type type

Class org.yamcs.xtce.Condition

class Condition extends Object implements Serializable

serialVersionUID:

2L

Serialized Fields

comparisonOperator

OperatorType comparisonOperator

leftRef

ParameterOrArgumentRef leftRef

rightRef

ParameterOrArgumentRef rightRef

rightValue

String rightValue

Class org.yamcs.xtce.Container

class Container extends NameDescription implements Serializable

serialVersionUID:

200706051148L

Serialized Fields

baseContainer

Container baseContainer

rate

RateInStream rate

restrictionCriteria

MatchCriteria restrictionCriteria

sizeInBits

int sizeInBits

Class org.yamcs.xtce.ContainerEntry

class ContainerEntry extends SequenceEntry implements Serializable

serialVersionUID:

200706050737L

Serialized Fields

refContainer

SequenceContainer refContainer

Class org.yamcs.xtce.ContextCalibrator

class ContextCalibrator extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

calibrator

Calibrator calibrator

context

MatchCriteria context

Class org.yamcs.xtce.CustomAlgorithm

class CustomAlgorithm extends Algorithm implements Serializable

serialVersionUID:

1L

Serialized Fields

algorithmText

String algorithmText

language

String language

Class org.yamcs.xtce.DataEncoding

class DataEncoding extends Object implements Serializable

serialVersionUID:

4L

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

fromBinaryTransformAlgorithm

Algorithm fromBinaryTransformAlgorithm

sizeInBits

int sizeInBits

size in bits if known. If the size in bits is variable, it should be set to -1.

toBinaryTransformAlgorithm

Algorithm toBinaryTransformAlgorithm

Class org.yamcs.xtce.DynamicIntegerValue

class DynamicIntegerValue extends IntegerValue implements Serializable

serialVersionUID:

14L

Serialized Fields

instanceRef

ParameterOrArgumentRef instanceRef

intercept

long intercept

slope

long slope

Class org.yamcs.xtce.EnumeratedArgumentType

class EnumeratedArgumentType extends EnumeratedDataType implements Serializable

serialVersionUID:

1L

Class org.yamcs.xtce.EnumeratedDataType

class EnumeratedDataType extends BaseDataType implements Serializable

serialVersionUID:

2L

Serialized Fields

enumeration

HashMap<Long,ValueEnumeration> enumeration

enumerationList

List<ValueEnumeration> enumerationList

initialValue

String initialValue

ranges

List<ValueEnumerationRange> ranges

Class org.yamcs.xtce.EnumeratedParameterType

class EnumeratedParameterType extends EnumeratedDataType implements Serializable

serialVersionUID:

5L

Serialized Fields

contextAlarmList

List<EnumerationContextAlarm> contextAlarmList

defaultAlarm

EnumerationAlarm defaultAlarm

Class org.yamcs.xtce.EnumerationAlarm

class EnumerationAlarm extends AlarmType implements Serializable

serialVersionUID:

200707121420L

Serialized Fields

alarmList

List<EnumerationAlarm.EnumerationAlarmItem> alarmList

defaultAlarmLevel

AlarmLevels defaultAlarmLevel

If none from the list above applies, then this one is used

Class org.yamcs.xtce.EnumerationAlarm.EnumerationAlarmItem

class EnumerationAlarmItem extends Object implements Serializable

serialVersionUID:

200707121420L

Serialized Fields

alarmLevel

AlarmLevels alarmLevel

enumerationLabel

String enumerationLabel

Class org.yamcs.xtce.EnumerationContextAlarm

class EnumerationContextAlarm extends EnumerationAlarm implements Serializable

serialVersionUID:

201103300451L

Serialized Fields

contextMatch

MatchCriteria contextMatch

Class org.yamcs.xtce.ExpressionList

class ExpressionList extends Object implements Serializable

serialVersionUID:

2333657095062539096L

Serialized Fields

expressions

List<BooleanExpression> expressions

Class org.yamcs.xtce.FixedIntegerValue

class FixedIntegerValue extends IntegerValue implements Serializable

serialVersionUID:

200706091239L

Serialized Fields

value

long value

Class org.yamcs.xtce.FixedValueEntry

class FixedValueEntry extends SequenceEntry implements Serializable

serialVersionUID:

1L

Serialized Fields

binaryValue

byte[] binaryValue

The fixed/constant value that should be encoded into the sequence. This value provided should have sufficient bit length to accommodate the size in bits. If the value is larger, the most significant unnecessary bits are dropped. The value provided should be in network byte order for encoding.

name

String name

sizeInBits

int sizeInBits

Class org.yamcs.xtce.FloatArgumentType

class FloatArgumentType extends FloatDataType implements Serializable

serialVersionUID:

1L

Class org.yamcs.xtce.FloatDataEncoding

class FloatDataEncoding extends DataEncoding implements Serializable

serialVersionUID:

3L

Serialized Fields

contextCalibratorList

List<ContextCalibrator> contextCalibratorList

defaultCalibrator

Calibrator defaultCalibrator

encoding

FloatDataEncoding.Encoding encoding

stringEncoding

StringDataEncoding stringEncoding

Class org.yamcs.xtce.FloatDataType

class FloatDataType extends NumericDataType implements Serializable

serialVersionUID:

1L

Serialized Fields

initialValue

Double initialValue

numberFormat

NumberFormatType numberFormat

XTCE: This element provides the implementation with assistance rendering the value as a string for users.

Note that XTCE wraps NumberFormatType in another type ToStringType, which we don't do.

sizeInBits

int sizeInBits

validRange

FloatValidRange validRange

XTCE: The Valid Range bounds the universe of possible values this Parameter may have. For Telemetry the valid range is always applied before calibration, regardless of the value of validRangeAppliesToCalibrated. For commanding, if validRangeAppliesToCalibrated is false -- it is applied before calibration to the link DataEncoding.

Class org.yamcs.xtce.FloatParameterType

class FloatParameterType extends FloatDataType implements Serializable

serialVersionUID:

2L

Serialized Fields

contextAlarmList

List<NumericContextAlarm> contextAlarmList

defaultAlarm

NumericAlarm defaultAlarm

Class org.yamcs.xtce.FloatValidRange

class FloatValidRange extends DoubleRange implements Serializable

serialVersionUID:

2L

Serialized Fields

validRangeAppliesToCalibrated

boolean validRangeAppliesToCalibrated

The range specified applies to the destination data type if true, or the raw source data type if false. The default is false and reflects the more likely scenario of checking raw values before conversion or calibration in telemetry.

Class org.yamcs.xtce.Header

class Header extends Object implements Serializable

serialVersionUID:

2L

Serialized Fields

date

String date

historyList

List<History> historyList

version

String version

Class org.yamcs.xtce.History

class History extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

author

String author

date

String date

message

String message

version

String version

Class org.yamcs.xtce.IndirectParameterRefEntry

class IndirectParameterRefEntry extends SequenceEntry implements Serializable

serialVersionUID:

1L

Serialized Fields

aliasNameSpace

String aliasNameSpace

parameterRef

ParameterInstanceRef parameterRef

Class org.yamcs.xtce.InputParameter

class InputParameter extends Object implements Serializable

serialVersionUID:

4L

Serialized Fields

argumentRef

ArgumentInstanceRef argumentRef

inputName

String inputName

mandatory

boolean mandatory

parameterInstance

ParameterInstanceRef parameterInstance

Class org.yamcs.xtce.IntegerArgumentType

class IntegerArgumentType extends IntegerDataType implements Serializable

serialVersionUID:

3L

Class org.yamcs.xtce.IntegerDataEncoding

class IntegerDataEncoding extends DataEncoding implements Serializable

serialVersionUID:

3L

Serialized Fields

contextCalibratorList

List<ContextCalibrator> contextCalibratorList

defaultCalibrator

Calibrator defaultCalibrator

encoding

IntegerDataEncoding.Encoding encoding

stringEncoding

StringDataEncoding stringEncoding

Class org.yamcs.xtce.IntegerDataType

class IntegerDataType extends NumericDataType implements Serializable

serialVersionUID:

1L

Serialized Fields

initialValue

Long initialValue

numberFormat

NumberFormatType numberFormat

XTCE: This element provides the implementation with assistance rendering the value as a string for users.

Note that XTCE wraps NumberFormatType in another type ToStringType, which we don't do.

signed

boolean signed

sizeInBits

int sizeInBits

validRange

IntegerValidRange validRange

XTCE: The Valid Range bounds the universe of possible values this Parameter may have. For Telemetry the valid range is always applied before calibration, regardless of the value of validRangeAppliesToCalibrated. For commanding, if validRangeAppliesToCalibrated is false -- it is applied before calibration to the link DataEncoding.

Class org.yamcs.xtce.IntegerParameterType

class IntegerParameterType extends IntegerDataType implements Serializable

serialVersionUID:

2L

Serialized Fields

contextAlarmList

List<NumericContextAlarm> contextAlarmList

defaultAlarm

NumericAlarm defaultAlarm

Class org.yamcs.xtce.IntegerRange

class IntegerRange extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

maxInclusive

long maxInclusive

minInclusive

long minInclusive

Class org.yamcs.xtce.IntegerValidRange

class IntegerValidRange extends IntegerRange implements Serializable

serialVersionUID:

1L

Serialized Fields

validRangeAppliesToCalibrated

boolean validRangeAppliesToCalibrated

Ranges are applied to the raw source DataEncoding data type or against the calibrated or converted destination data type

Class org.yamcs.xtce.IntegerValue

class IntegerValue extends Object implements Serializable

serialVersionUID:

1L

Class org.yamcs.xtce.JavaExpressionCalibrator

class JavaExpressionCalibrator extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

javaFormula

String javaFormula

Class org.yamcs.xtce.MathAlgorithm

class MathAlgorithm extends Algorithm implements Serializable

serialVersionUID:

1L

Serialized Fields

operation

TriggeredMathOperation operation

Class org.yamcs.xtce.MathOperation

class MathOperation extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

elementList

List<MathOperation.Element> elementList

Class org.yamcs.xtce.MathOperation.Element

class Element extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

operator

MathOperator operator

pref

ParameterInstanceRef pref

type

MathOperation.ElementType type

value

double value

Class org.yamcs.xtce.MathOperationCalibrator

class MathOperationCalibrator extends MathOperation implements Serializable

serialVersionUID:

1L

Class org.yamcs.xtce.Member

class Member extends NameDescription implements Serializable

serialVersionUID:

1L

Serialized Fields

initialValue

Object initialValue

type

DataType type

Class org.yamcs.xtce.MetaCommand

class MetaCommand extends NameDescription implements Serializable

serialVersionUID:

5L

Serialized Fields

abstractCmd

boolean abstractCmd

if command is abstract, it cannot be instantiated

argumentAssignmentList

List<ArgumentAssignment> argumentAssignmentList

argumentList

List<Argument> argumentList

From XTCE: Many commands have one or more options. These are called command arguments. Command arguments may be of any of the standard data types.

MetaCommand arguments are local to the MetaCommand. Arguments are the visible to the user or processing software.

This can be somewhat subjective -- for example a checksum that is always part of the command format is probably not an argument.

baseMetaCommand

MetaCommand baseMetaCommand

commandContainer

CommandContainer commandContainer

From XTCE: Tells how to package this command.

May not be referred to in the EntryList of a SequenceContainer, CommandContainerSet/CommandContainer or another MetaCommandContainer.

May be extended by another MetaCommand/CommandContainer.

defaultSignificance

Significance defaultSignificance

From XTCE: Some Command and Control Systems may require special user access or confirmations before transmitting commands with certain levels. The level is inherited from the Base MetaCommand, or it overrides any in the parent-chain if given here, however it should not go down in consequenceLevel.

transmissionContstraintList

List<TransmissionConstraint> transmissionContstraintList

verifierList

List<CommandVerifier> verifierList

From XTCE A Command Verifier is a conditional check on the telemetry from a SpaceSystem that that provides positive indication on the processing state of a command. There are eight different verifiers each associated with difference states in command processing: TransferredToRange, TransferredFromRange, Received, Accepted, Queued, Execution, Complete, and Failed. There may be multiple ‘complete’ verifiers. ‘Complete’ verifiers are added to the Base MetaCommand ‘Complete’ verifier list. All others will override a verifier defined in a Base MetaCommand In Yamcs the verifier type is specified in the stage field.

Class org.yamcs.xtce.NamedDescriptionIndex

class NamedDescriptionIndex extends Object implements Serializable

serialVersionUID:

4L

Serialized Fields

aliasIndex

LinkedHashMap<String,LinkedHashMap<String,T extends NameDescription>> aliasIndex

index

LinkedHashMap<String,T extends NameDescription> index

Class org.yamcs.xtce.NameDescription

class NameDescription extends Object implements Serializable

serialVersionUID:

200706050619L

Serialized Fields

ancillaryData

List<AncillaryData> ancillaryData

Escape hatch for storing any type of information

longDescription

String longDescription

name

String name

Name of the object

qualifiedName

String qualifiedName

fully qualified name (i.e. space system name+"/"+name

shortDescription

String shortDescription

xtceAliasSet

XtceAliasSet xtceAliasSet

Set of aliases

Class org.yamcs.xtce.NumberFormatType

class NumberFormatType extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

maximumFractionDigits

int maximumFractionDigits

XTCE: Describes how the engineering/calibrated value of this number should be displayed with respect to the maximum or upper bound of the number of digits. There is no default. No value specified should be interpreted as no upper bound such that all requires digits are used to fully characterize the value.

maximumIntegerDigits

int maximumIntegerDigits

XTCE: Describes how the engineering/calibrated value of this number should be displayed with respect to the maximum or upper bound of the integer digits. There is no default. No value specified should be interpreted as no upper bound such that all requires digits are used to fully characterize the value.

minimumFractionDigits

int minimumFractionDigits

XTCE: Describes how the engineering/calibrated value of this number should be displayed with respect to the minimum number of fractional digits. The default is 0.

minimumIntegerDigits

int minimumIntegerDigits

XTCE: Describes how the engineering/calibrated value of this number should be displayed with respect to the minimum number of integer digits. The default is 1.

negativePrefix

String negativePrefix

XTCE: Describes how the engineering/calibrated value of this number should be displayed with respect to negative values. This attribute specifies the character or characters that should be prepended to the numeric value to indicate negative values. The default is a minus character "-".

negativeSuffix

String negativeSuffix

XTCE: Describes how the engineering/calibrated value of this number should be displayed with respect to negative values. This attribute specifies the character or characters that should be appended to the numeric value to indicate negative values. The default is none.

notation

FloatingPointNotationType notation

XTCE: Describes how the engineering/calibrated value of this number should be displayed with respect to notation. Engineering, scientific, or traditional decimal notation may be specified. The precise characters used is locale specific for the implementation/platform. The default is "normal" for the traditional notation.

numberBase

RadixType numberBase

XTCE: Describes how the engineering/calibrated value of this number should be displayed with respect to the radix. Default is base 10.

positivePrefix

String positivePrefix

XTCE: Describes how the engineering/calibrated value of this number should be displayed with respect to positive values. This attribute specifies the character or characters that should be prepended to the numeric value to indicate positive values. The default is none. Zero is considered to be specific to the implementation/platform and is not implied here.

positiveSuffix

String positiveSuffix

XTCE: Describes how the engineering/calibrated value of this number should be displayed with respect to positive values. This attribute specifies the character or characters that should be appended to the numeric value to indicate positive values. The default is none. Zero is considered to be specific to the implementation/platform and is not implied here.

showThousandsGrouping

boolean showThousandsGrouping

XTCE: Describes how the engineering/calibrated value of this number should be displayed with respect to larger values. Groupings by thousand are specific to locale, so the schema only specifies whether they will be present and not which character separators are used. The default is false.

Class org.yamcs.xtce.NumericAlarm

class NumericAlarm extends AlarmType implements Serializable

serialVersionUID:

200706052351L

Serialized Fields

changeAlarmRanges

AlarmRanges changeAlarmRanges

ChangeAlarmRanges are used to trigger alarms when the parameter value's rate-of-change is either too fast or too slow. The change may be with respect to time (the default) or with respect to samples (delta alarms) - the changeType attribute determines this. The change may also be either relative (as a percentage change) or absolute as set by the changeBasis attribute. The alarm also requires the spanOfInterest in both samples and seconds to have passed before it is to trigger. For time based rate of change alarms, the time specified in spanOfInterestInSeconds is used to calculate the change. For sample based rate of change alarms, the change is calculated over the number of samples specified in spanOfInterestInSeconds.

staticAlarmRanges

AlarmRanges staticAlarmRanges

StaticAlarmRanges are used to trigger alarms when the parameter value passes some threshold value (as opposed to delta alarms or other fancy alarms not supported by yamcs).

Class org.yamcs.xtce.NumericContextAlarm

class NumericContextAlarm extends NumericAlarm implements Serializable

serialVersionUID:

201103300437L

Serialized Fields

contextMatch

MatchCriteria contextMatch

Class org.yamcs.xtce.NumericDataType

class NumericDataType extends BaseDataType implements Serializable

serialVersionUID:

5L

Class org.yamcs.xtce.OnParameterUpdateTrigger

class OnParameterUpdateTrigger extends Object implements Serializable

serialVersionUID:

2L

Serialized Fields

parameter

Parameter parameter

Class org.yamcs.xtce.OnPeriodicRateTrigger

class OnPeriodicRateTrigger extends Object implements Serializable

serialVersionUID:

-7880893090845503905L

Serialized Fields

fireRate

long fireRate

Class org.yamcs.xtce.ORedConditions

class ORedConditions extends ExpressionList implements Serializable

serialVersionUID:

10L

Class org.yamcs.xtce.OutputParameter

class OutputParameter extends Object implements Serializable

serialVersionUID:

201308201307L

Serialized Fields

outputName

String outputName

parameter

Parameter parameter

Class org.yamcs.xtce.Parameter

class Parameter extends NameDescription implements Serializable

serialVersionUID:

3L

Serialized Fields

dataSource

DataSource dataSource

initialValue

Object initialValue

parameterType

ParameterType parameterType

persistent

boolean persistent

XTCE: A Parameter marked to persist should retain the latest value through resets/restarts to the extent that is possible or defined in the implementation. The net effect is that the initial/default value on a Parameter is only seen once or when the system has a reset to revert to initial/default values.

recordingGroup

String recordingGroup

This is used for recording; if the recordingGroup is not set, the subsystem name is used. Currently it is only set for DaSS processed parameters for compatibility with the old recorder

Class org.yamcs.xtce.ParameterEntry

class ParameterEntry extends SequenceEntry implements Serializable

serialVersionUID:

200805131551L

Serialized Fields

parameter

Parameter parameter

Class org.yamcs.xtce.ParameterInstanceRef

class ParameterInstanceRef extends ParameterOrArgumentRef implements Serializable

serialVersionUID:

1L

Serialized Fields

instance

int instance

parameter

Parameter parameter

Class org.yamcs.xtce.ParameterOrArgumentRef

class ParameterOrArgumentRef extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

path

PathElement[] path

useCalibratedValue

boolean useCalibratedValue

Class org.yamcs.xtce.ParameterValueChange

class ParameterValueChange extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

delta

double delta

parameterRef

ParameterInstanceRef parameterRef

Class org.yamcs.xtce.PathElement

class PathElement extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

index

int[] index

name

String name

Class org.yamcs.xtce.PolynomialCalibrator

class PolynomialCalibrator extends Object implements Serializable

serialVersionUID:

3L

Serialized Fields

coefficients

double[] coefficients

Class org.yamcs.xtce.RateInStream

class RateInStream extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

maxInterval

long maxInterval

minInterval

long minInterval

Class org.yamcs.xtce.ReferenceTime

class ReferenceTime extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

epoch

TimeEpoch epoch

offsetFrom

ParameterInstanceRef offsetFrom

Class org.yamcs.xtce.Repeat

class Repeat extends Object implements Serializable

serialVersionUID:

200706111239L

Serialized Fields

count

IntegerValue count

Value (either fixed or dynamic) that contains the count of repeated structures.

offsetSizeInBits

int offsetSizeInBits

Indicates the distance between repeating entries (the last bit of one entry to the start bit of the next entry)

Class org.yamcs.xtce.SequenceContainer

class SequenceContainer extends Container implements Serializable

serialVersionUID:

4L

Serialized Fields

autoPartition

boolean autoPartition

If this is true, the SequenceContainer.useAsArchivePartition flag will be set automatically after all the MDB has been loaded.

entryList

List<SequenceEntry> entryList

useAsArchivePartition

boolean useAsArchivePartition

Use this container as a partition when archiving (name of the container is used as partitioning key in the tm table).

If this property is set, this container name will be used for storing a certain packet if the packet doesn't match any inherited container with the property set

Class org.yamcs.xtce.SequenceEntry

class SequenceEntry extends Object implements Serializable

serialVersionUID:

3L

Serialized Fields

container

Container container

includeCondition

MatchCriteria includeCondition

This entry will only be included in the sequence when this condition is true. If no IncludeCondition is given, then it is will be included. A parameter that is not included will be treated as if it did not exist in the sequence at all.

index

int index

this is the index in the ArrayList of the Container from which this sequence entry is part is used for sorting and for finding the parameter before or after this one.

locationInContainerInBits

int locationInContainerInBits

if the referenceLocation is containerStart, then this is number of bits from the start for previousEntry, this is the number of bits from where the previous entry ends

referenceLocation

SequenceEntry.ReferenceLocationType referenceLocation

repeatEntry

Repeat repeatEntry

May be used when this entry repeats itself in the sequence container. If null, the entry does not repeat.

Class org.yamcs.xtce.Significance

class Significance extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

consequenceLevel

Significance.Levels consequenceLevel

reasonForWarning

String reasonForWarning

Class org.yamcs.xtce.SpaceSystem

class SpaceSystem extends NameDescription implements Serializable

serialVersionUID:

6L

Serialized Fields

algorithms

HashMap<String,Algorithm> algorithms

argumentTypes

HashMap<String,ArgumentType> argumentTypes

cmdContainers

Map<String,CommandContainer> cmdContainers

commands

HashMap<String,MetaCommand> commands

containers

Map<String,SequenceContainer> containers

header

Header header

nonStandardDatas

HashMap<Class<?>,NonStandardData> nonStandardDatas

parameters

Map<String,Parameter> parameters

parameterTypes

HashMap<String,ParameterType> parameterTypes

parent

SpaceSystem parent

subsystems

Map<String,SpaceSystem> subsystems

Class org.yamcs.xtce.SplineCalibrator

class SplineCalibrator extends Object implements Serializable

serialVersionUID:

3L

Serialized Fields

points

SplinePoint[] points

Class org.yamcs.xtce.SplinePoint

class SplinePoint extends Object implements Serializable

serialVersionUID:

200706050619L

Serialized Fields

calibrated

double calibrated

raw

double raw

Class org.yamcs.xtce.StringArgumentType

class StringArgumentType extends StringDataType implements Serializable

serialVersionUID:

2L

Class org.yamcs.xtce.StringDataEncoding

class StringDataEncoding extends DataEncoding implements Serializable

serialVersionUID:

1L

Serialized Fields

dynamicBufferSize

DynamicIntegerValue dynamicBufferSize

If the buffer size is dynamic

encoding

String encoding

maxSizeInBytes

int maxSizeInBytes

sizeInBytesOfSizeTag

int sizeInBytesOfSizeTag

sizeType

StringDataEncoding.SizeType sizeType

terminationChar

byte terminationChar

Class org.yamcs.xtce.StringDataType

class StringDataType extends BaseDataType implements Serializable

serialVersionUID:

2L

Serialized Fields

initialValue

String initialValue

sizeRangeInCharacters

IntegerRange sizeRangeInCharacters

For telemetry, specify as UTF-8 or UTF-16 value to match the encoding. This range check will be applied before conversion to the host string data type. For commanding, the range check occurs on the string host data type encoding, whatever that is -- before injection on the command link.

Class org.yamcs.xtce.StringParameterType

class StringParameterType extends StringDataType implements Serializable

serialVersionUID:

1L

Class org.yamcs.xtce.SystemParameter

class SystemParameter extends Parameter implements Serializable

serialVersionUID:

2L

Class org.yamcs.xtce.TimeEpoch

class TimeEpoch extends Object implements Serializable

serialVersionUID:

2L

Serialized Fields

dateTime

String dateTime

epoch

TimeEpoch.CommonEpochs epoch

Class org.yamcs.xtce.TransmissionConstraint

class TransmissionConstraint extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

matchCriteria

MatchCriteria matchCriteria

XTCE: A specialised form of MatchCriteria for transmission constraint that may be suspendable on timeout.

timeout

long timeout

timeout in milliseconds

Class org.yamcs.xtce.TriggeredMathOperation

class TriggeredMathOperation extends MathOperation implements Serializable

serialVersionUID:

1L

Class org.yamcs.xtce.TriggerSetType

class TriggerSetType extends Object implements Serializable

serialVersionUID:

-9191842839880223058L

Serialized Fields

onParameterUpdateTriggers

ArrayList<OnParameterUpdateTrigger> onParameterUpdateTriggers

onPeriodicRateTriggers

ArrayList<OnPeriodicRateTrigger> onPeriodicRateTriggers

Class org.yamcs.xtce.UnitType

class UnitType extends Object implements Serializable

serialVersionUID:

-2505869748092316015L

Serialized Fields

description

String description

factor

String factor

power

double power

unit

String unit

Class org.yamcs.xtce.ValueEnumeration

class ValueEnumeration extends Object implements Serializable

serialVersionUID:

2011023231432L

Serialized Fields

description

String description

label

String label

value

long value

Class org.yamcs.xtce.ValueEnumerationRange

class ValueEnumerationRange extends Object implements Serializable

serialVersionUID:

2011023231432L

Serialized Fields

description

String description

isMaxInclusive

boolean isMaxInclusive

isMinInclusive

boolean isMinInclusive

label

String label

max

double max

min

double min

Class org.yamcs.xtce.XtceDb

class XtceDb extends Object implements Serializable

serialVersionUID:

57L

Serialized Fields

algorithmAliases

NamedDescriptionIndex<Algorithm> algorithmAliases

algorithms

HashMap<String,Algorithm> algorithms

commandAliases

NamedDescriptionIndex<MetaCommand> commandAliases

commands

HashMap<String,MetaCommand> commands

indirectParameterRefEntries

Map<String,List<IndirectParameterRefEntry>> indirectParameterRefEntries

namespaces

Set<String> namespaces

nonStandardDatas

HashMap<Class<?>,NonStandardData> nonStandardDatas

parameter2ParameterEntryMap

HashMap<Parameter,ArrayList<ParameterEntry>> parameter2ParameterEntryMap

Maps the Parameter to a list of ParameterEntry such that we know from which container we can extract this parameter

parameterAliases

NamedDescriptionIndex<Parameter> parameterAliases

parameters

Map<String,Parameter> parameters

parameterTypeAliases

NamedDescriptionIndex<NameDescription> parameterTypeAliases

parameterTypes

Map<String,ParameterType> parameterTypes

rootSequenceContainer

SequenceContainer rootSequenceContainer

rootSystem

SpaceSystem rootSystem

rwLock

ReadWriteLock rwLock

sequenceContainer2ContainerEntryMap

HashMap<SequenceContainer,ArrayList<ContainerEntry>> sequenceContainer2ContainerEntryMap

maps the SequenceContainer to a list of other EntryContainers in case of aggregation

sequenceContainer2InheritingContainerMap

HashMap<SequenceContainer,ArrayList<SequenceContainer>> sequenceContainer2InheritingContainerMap

maps the SequenceContainer to a list of containers inheriting this one

sequenceContainerAliases

NamedDescriptionIndex<SequenceContainer> sequenceContainerAliases

sequenceContainers

Map<String,SequenceContainer> sequenceContainers

spaceSystemAliases

NamedDescriptionIndex<SpaceSystem> spaceSystemAliases

spaceSystems

HashMap<String,SpaceSystem> spaceSystems

Package org.yamcs.xtce.util

Class org.yamcs.xtce.util.DoubleRange

class DoubleRange extends Object implements Serializable

serialVersionUID:

3L

Serialized Fields

max

double max

maxIncl

boolean maxIncl

min

double min

minIncl

boolean minIncl

Package org.yamcs.xtce.xml

Class org.yamcs.xtce.xml.XtceAliasSet

class XtceAliasSet extends Object implements Serializable

serialVersionUID:

6841708656383592099L

Serialized Fields

aliases

HashMap<String,String> aliases

Exception org.yamcs.xtce.xml.XtceLoadException

class XtceLoadException extends RuntimeException implements Serializable

serialVersionUID:

1L

Serialized Fields

fileName

String fileName

location

Location location