Package org.yamcs

Class ProcessorConfig

java.lang.Object
org.yamcs.ProcessorConfig
public class ProcessorConfig extends Object
Configuration options for a processor

  • Constructor Details

    • ProcessorConfig

      public ProcessorConfig(YConfiguration config)

    • ProcessorConfig

      public ProcessorConfig()
      Default configuration

  • Method Details

    • getSpec

      public static Spec getSpec()

    • getAlarmSpec

      public static Spec getAlarmSpec()

    • getMaxCommandSize

      public int getMaxCommandSize()
      Returns the maximum allowed size for a telecommand (TC) in bytes.
      Returns:
      the maximum TC size

    • getEventAlarmMinViolations

      public int getEventAlarmMinViolations()
      Returns the minimum number of violations required to trigger an event alarm.
      Returns:
      the minimum number of event alarm violations

    • generateEvents

      public boolean generateEvents()
      Returns whether event generation is enabled.

      It refers to the events generated inside the processor (for example when encountering errors on processing packets) not events in general.

      Returns:
      true if event generation is enabled, false otherwise

    • getContainerProcessingOptions

      public ContainerProcessingOptions getContainerProcessingOptions()

    • allowContainerlessCommands

      public boolean allowContainerlessCommands()
      Returns whether commands without associated containers are allowed.
      Returns:
      true if containerless commands are allowed, false otherwise

    • checkCommandClearance

      public boolean checkCommandClearance()
      Returns whether command clearance checks are enabled.
      Returns:
      true if command clearance checks are enabled, false otherwise

    • checkParameterValidityRanges

      public boolean checkParameterValidityRanges()
      Returns whether parameter validity range checks are enabled.
      Returns:
      true if parameter validity range checks are enabled, false otherwise

    • subscribeContainerArchivePartitions

      public boolean subscribeContainerArchivePartitions()

    • setSubscribeContainerArchivePartitions

      public void setSubscribeContainerArchivePartitions(boolean b)

    • persistParameters

      public boolean persistParameters()
      Returns whether parameter persistence is enabled, meaning parameter values will be saved at shutdown and loaded at startup.

      If enabled, only parameters with the persistence flag set are saved

      Returns:
      true if parameter persistence is enabled, false otherwise

    • getAlarmLoadDays

      public double getAlarmLoadDays()
      Returns the number of past days of alarm data to load at startup.

      If zero or negative, no alarms are loaded.

      Returns:
      the number of days of alarm data to load

    • setAlarmLoadDays

      public void setAlarmLoadDays(double alarmLoadDays)

    • toString

      public String toString()
      Overrides:
      toString in class Object