Package org.eso.ias.asce.transfer

Class IasIOJ<T>

java.lang.Object
org.eso.ias.asce.transfer.IasIOJ<T>
public class IasIOJ<T> extends Object
The java countr part of the scala IasIO, that is the view of an InOut for the TF IasIOJ exposes only the InOut's methods that can be invoked by the TF hiding the methods meant for the internals of the IAS. The IasIo reduces the risk of errors from misuse from the TF and simplify the API hiding scala details. IasIo is immutable.
Author:
acaproni

  • Constructor Details

    • IasIOJ

      public IasIOJ(org.eso.ias.types.InOut<T> inOut)
      Constructor
      Parameters:
      inOut - The InOut to delegate

  • Method Details

    • updateMode

      public IasIOJ<T> updateMode(OperationalMode newMode)
      Update the mode of the monitor point
      Parameters:
      newMode - : The new mode of the monitor point

    • updateValue

      public IasIOJ<T> updateValue(T newValue)
      Update the value of a IASIO
      Parameters:
      newValue - : The new value of the IASIO
      Returns:
      A new InOut with updated value

    • setValidityConstraint

      public IasIOJ<T> setValidityConstraint(Set<String> constraint)
      Set the validity constraints to the passed set of IDs of inputs. The passed set contains the IDs of the inputs that the core must be consider when evaluating the validity of the output. The core returns an error if at least one of the ID is not an input to the ASCE where the TF runs: in this case a message is logged and the TF will not be run again. To remove the constraints, the passed set must be empty
      Parameters:
      constraint - the constraint the constraints (can be null)

    • updateProps

      public IasIOJ<T> updateProps(Map<String,String> additionalProps)
      Return a new IasIO with the passed additional properties.
      Parameters:
      additionalProps - additional properties
      Returns:
      a new IasIOJ with the passed additional properties

    • getType

      public IASTypes getType()
      Returns:
      the type of the monitor point

    • getId

      public String getId()
      Returns:
      the identifier of the monitor point

    • getFullrunningId

      public String getFullrunningId()
      Returns:
      the full running identifier of the monitor point

    • productionTStamp

      public Optional<Long> productionTStamp()
      Th eproduction timestamp of the IASIO independently if it has been produced by a plugin, a DASU or a CORE tool
      Returns:
      The point in time when this monitor point has been produced by the DASU

    • getProps

      public Map<String,String> getProps()
      The properties of the monitor point
      Returns:
      the (unmodifiable) properties

    • getValue

      public Optional<T> getValue()
      Returns:
      the actual value of the monitor point (can be null)

    • getMode

      public OperationalMode getMode()
      Returns:
      the operational mode

    • getValidity

      public IasValidity getValidity()
      The validity without taking times into account.
      Returns:
      the validity

    • validityOfInputByTime

      public IasValidity validityOfInputByTime(long threshold)
      The validity of an input taking times into account
      Returns:
      the validity by tim

    • getValidityConstraints

      public Set<String> getValidityConstraints()
      Returns:
      the validity constraints