Package org.yamcs.xtce

Enum DataSource

java.lang.Object
java.lang.Enum<DataSource>
org.yamcs.xtce.DataSource
All Implemented Interfaces:
Serializable, Comparable<DataSource>
public enum DataSource extends Enum<DataSource>
The data source is associated to a Parameter and specifies the source of the values for that parameter.

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    COMMAND
    parameters used in the context of command verifiers
    COMMAND_HISTORY
    special parameters created on the fly and instantiated in the context of command verifiers
    CONSTANT
    constants in the XtceDb - cannot be changed
    DERIVED
    parameters set by the algorithm manager
    EXTERNAL1
    external parameters are like local parameters (can be set by the client) but maintained outside Yamcs.
    EXTERNAL2
     
    EXTERNAL3
     
    GROUND
    According to XTCE, a ground parameter is generated by an asset which is not the spacecraft.
    LOCAL
    software parameters maintained by Yamcs and that can be set by client
    SYSTEM
    parameters giving internal yamcs state -created on the fly
    TELEMETERED
    used for data acquired from outside, parameters of this type cannot be changed

  • Method Summary

    Modifier and Type
    Method
    Description
    static DataSource
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static DataSource[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • TELEMETERED

      public static final DataSource TELEMETERED
      used for data acquired from outside, parameters of this type cannot be changed

    • GROUND

      public static final DataSource GROUND
      According to XTCE, a ground parameter is generated by an asset which is not the spacecraft. From Yamcs point of view is the same as TELEMETERED.

    • DERIVED

      public static final DataSource DERIVED
      parameters set by the algorithm manager

    • CONSTANT

      public static final DataSource CONSTANT
      constants in the XtceDb - cannot be changed

    • LOCAL

      public static final DataSource LOCAL
      software parameters maintained by Yamcs and that can be set by client

    • SYSTEM

      public static final DataSource SYSTEM
      parameters giving internal yamcs state -created on the fly

    • COMMAND

      public static final DataSource COMMAND
      parameters used in the context of command verifiers

    • COMMAND_HISTORY

      public static final DataSource COMMAND_HISTORY
      special parameters created on the fly and instantiated in the context of command verifiers

    • EXTERNAL1

      public static final DataSource EXTERNAL1
      external parameters are like local parameters (can be set by the client) but maintained outside Yamcs. These are project specific and require a SoftwareParameterManager to be defined in the Yamcs processor configuration.

    • EXTERNAL2

      public static final DataSource EXTERNAL2

    • EXTERNAL3

      public static final DataSource EXTERNAL3

  • Method Details

    • values

      public static DataSource[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static DataSource valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null