root
API
Generated with
root/org.eso.ias/org.eso.ias.tranfer/org.eso.ias.tranfer.utlitymodule/UMFireTF

UMFireTF

org.eso.ias.tranfer.utlitymodule.UMFireTF
See theUMFireTF companion object
class UMFireTF(asceId: String, asceRunningId: String, validityTimeFrame: Long, props: Properties) extends ScalaTransferExecutor[Alarm]

The transfer function for the Fire alarm of the utility module

This TF takes only one input string, the status word read from the utility module.

Value parameters

asceId

: the ID of the ASCE

asceRunningId:

the runningID of the ASCE

props:

the user defined properties

  • @author acaproni
validityTimeFrame:

The time frame (msec) to invalidate monitor points

Attributes

Companion
object
Graph
Supertypes
class ScalaTransferExecutor[Alarm]
class TransferExecutor
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

override def eval(compInputs: Map[String, IasIO[_]], actualOutput: IasIO[Alarm]): IasIO[Alarm]

Produces the output of the component by evaluating the input

Produces the output of the component by evaluating the input

Attributes

Returns

the computed output of the ASCE

Definition Classes
override def initialize(inputsInfo: Set[IasioInfo], outputInfo: IasioInfo): Unit

Initialize the TF

Initialize the TF

Value parameters

inputsInfo

The IDs and types of the inputs

outputInfo

The Id and type of thr output

Attributes

Definition Classes
override def shutdown(): Unit

Attributes

See also

TransferExecutor#shutdown()

Definition Classes
TransferExecutor

Inherited methods

final protected def getIdentifier(id: String): String

Value parameters

id

the id to translate, templated or not

Attributes

Returns

teh identifer translated if the ASCE is templated

Inherited from:
ScalaTransferExecutor
def getTemplateInstance(): Optional[Integer]

Attributes

Inherited from:
TransferExecutor
final protected def getValue(inputs: Map[String, IasIO[_]], id: String, instance: Option[Int]): Option[IasIO[_]]

This method transparently returns a value from the passed ID and instance.

This method transparently returns a value from the passed ID and instance.

When an input is not templated, neither a template instance, then its value cabn be directly retrieved from the map of the inputs passed to [#eval]. But if the imput is templated or a templated instance then this method must be used.

If the ASCE is generated out of a template, its inputs can or cannot be generated out of the same template. In the latter, their identifiers must be enriched with the number of the instance of the ASCE. For templated inputs the number of the instance is not needed because it is the same instance number of the ASCE and it is known to the transfer function. The case of templated input instances is different because their instance number is defined in the configuration of the ASCE and not known in the transfer function so it must be esplicity passed by the caller.

For normal and templated inputs, the instance is empty. For templated inputs the instance can be passed if it is teh same of the ASCE. For templated input instances the instance number is required.

This method must be used also to get templated input instances from non templated ASCEs.

Value parameters

id

The (non templated) identifier of the value

inputs

the map of the inputs

instance

the optional instance nummber for templated input instances, not required for other cases

Attributes

Returns

the IASValue of the given ID, or None if not found in the Map

Inherited from:
ScalaTransferExecutor
def isTemplated(): Boolean

Attributes

Inherited from:
TransferExecutor
final def setTemplateInstance(x$0: Optional[Integer]): Unit

Attributes

Inherited from:
TransferExecutor
Generated with