root
API
Generated with
root/org.eso.ias/org.eso.ias.asce/org.eso.ias.asce.transfer/IasIO

IasIO

org.eso.ias.asce.transfer.IasIO
class IasIO[T](val inOut: InOut[T])

The view of an InOut for the TF

IasIO 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

IasIo is immutable.

Value parameters

inOut

The InOut to delegate

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def setValidityConstraint(constraint: Option[Set[String]]): IasIO[T]

Set the validity constraints to the passed set of IDs of inputs.

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 when the TF runs: in this case a message is logged and the TF will not be run again.

To remove the constrans, the passed set must be empty

Value parameters

constraint

the constraints

Attributes

def updateMode(newMode: OperationalMode): IasIO[T]

Update the mode of the monitor point

Update the mode of the monitor point

Value parameters

newMode:

The new mode of the monitor point

Attributes

def updateProps(additionalProps: Map[String, String]): IasIO[T]

Return a new IasIO with the passed additional properties.

Return a new IasIO with the passed additional properties.

Value parameters

The

additional properties

Attributes

Returns

a new inOut with the passed additional properties

def updateValue[B >: T](newValue: B): IasIO[T]

Update the value of a IASIO

Update the value of a IASIO

Value parameters

newValue:

The not null new value of the IASIO

Attributes

Returns

A new InOut with updated value

def validityOfInputByTime(threshold: Long): IasValidity

The validity of an input taking times into account

The validity of an input taking times into account

Attributes

Concrete fields

lazy val fullRunningId: String

The full running identifier of the monitor point

The full running identifier of the monitor point

Attributes

lazy val iasType: IASTypes

The IAS type of the monitor point

The IAS type of the monitor point

Attributes

lazy val id: String

The identifier of the monitor point

The identifier of the monitor point

Attributes

lazy val mode: OperationalMode

The operational mode

The operational mode

Attributes

lazy val productionTStamp: Option[Long]

The point in time when this monitor point has been produced by a DASU, a plugin or a IAS core tool

The point in time when this monitor point has been produced by a DASU, a plugin or a IAS core tool

Attributes

lazy val props: Map[String, String]

The additional properties

The additional properties

Attributes

lazy val validity: IasValidity

The validity

The validity

This is the validity without taking times into account.

Attributes

lazy val validityConstraints: Option[Set[String]]

The validity constraints

The validity constraints

Attributes

val value: Option[T]

The actual value

The actual value

Attributes

Generated with