Class Setup

    • Constructor Detail

      • Setup

        public Setup​(Prefix source,
                     CommandName commandName,
                     scala.Option<ObsId> maybeObsId,
                     scala.collection.immutable.Set<Parameter<?>> paramSet)
      • Setup

        public Setup​(Prefix source,
                     CommandName commandName,
                     java.util.Optional<ObsId> maybeObsId)
        A java helper to construct Setup command
        Parameters:
        source - (undocumented)
        commandName - (undocumented)
        maybeObsId - (undocumented)
    • Method Detail

      • apply

        public static Setup apply​(Prefix source,
                                  CommandName commandName,
                                  scala.Option<ObsId> maybeObsId)
        The apply method is used to create Setup command by end-user.

        Parameters:
        source - prefix representing source of the command
        commandName - the name of the command
        maybeObsId - an optional obsId for command
        Returns:
        a new instance of Setup with empty paramSet
      • apply

        public static Setup apply​(Prefix source,
                                  CommandName commandName,
                                  scala.Option<ObsId> maybeObsId,
                                  scala.collection.immutable.Set<Parameter<?>> paramSet)
        The apply method is used to create Setup command by end-user.

        Parameters:
        source - prefix representing source of the command
        commandName - the name of the command
        maybeObsId - an optional obsId for command
        paramSet - an initial set of parameters (keys with values)
        Returns:
        a new instance of Setup
      • source

        public Prefix source()
        Description copied from interface: Command
        Prefix representing source of the command
        Specified by:
        source in interface Command
        Returns:
        (undocumented)
      • commandName

        public CommandName commandName()
        Description copied from interface: Command
        The name of command
        Specified by:
        commandName in interface Command
        Returns:
        (undocumented)
      • maybeObsId

        public scala.Option<ObsId> maybeObsId()
        Description copied from interface: Command
        An optional obsId for command
        Specified by:
        maybeObsId in interface Command
        Returns:
        (undocumented)
      • create

        protected Setup create​(scala.collection.immutable.Set<Parameter<?>> data)
        Create a new Setup instance when a parameter is added or removed

        Specified by:
        create in class ParameterSetType<Setup>
        Parameters:
        data - set of parameters
        Returns:
        a new instance of Setup with provided data