Enum Class ChildCustody

java.lang.Object
java.lang.Enum<ChildCustody>
gov.nasa.jpl.aerie.scheduler.goals.ChildCustody
All Implemented Interfaces:
Serializable, Comparable<ChildCustody>, Constable

public enum ChildCustody extends Enum<ChildCustody>
describes how a goal is satisfied by shared activity instances
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    activity instances may be shared among multiple goals this should generally be the default as it allows synergy between goals
    activity instances may not be shared among goals the goal must have its own individual copy of the activity instance, even if all other constraints are met and even if all other goals allow joint custody this may cause unnecessary replication of activities in the plan, but may be desired in some cases where the activities are unique in some way besides their constrainable parameters
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the enum constant of this class with the specified name.
    static ChildCustody[]
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • Jointly

      public static final ChildCustody Jointly
      activity instances may be shared among multiple goals this should generally be the default as it allows synergy between goals
    • Solely

      public static final ChildCustody Solely
      activity instances may not be shared among goals the goal must have its own individual copy of the activity instance, even if all other constraints are met and even if all other goals allow joint custody this may cause unnecessary replication of activities in the plan, but may be desired in some cases where the activities are unique in some way besides their constrainable parameters
  • Method Details

    • values

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

      public static ChildCustody valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null