AntPadInhibitor

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

The AntPadInhibitor transfer functions gets 2 inputs:

  • the association of antennas to pads (string)
  • an ALARM It inhibits the alarm if there are no antennas in the pads whose names match with the given pattern. It is also possible to add a filter by antenna type by setting antTypePropName to one of the possible antenna types: the alarm in output is set if the alarm in input is set AND there are antennas in the pads AND at least one antenna of the passed type.

No check is done on the ID of the alarm in input. The TF produces an alarm that is always CLEAR if there are no antennas in the pads or the alarm in input is CLEAR. If the input is SET and there are antennas in the PAD, the output is set with the same priority of the alarm in input.

The association of antennas to pad is a monitor point that contains all the antennas and the names of the relative pads where they seat. The matching is done by a regular expression provided as a java property.

This is an example of the value (string) of the Array-AntennasToPads, the monitor points that contains the pads of all the antennas: DV01:A045,DV02:A025,...

Attributes

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

Members list

Value members

Concrete methods

def affectedAntennas(antsPadsMP: String): String

Build the comma separated list of names of affected antennas, i.e. the names of the antennas whose names match with the regular expression passed in the java properties

Build the comma separated list of names of affected antennas, i.e. the names of the antennas whose names match with the regular expression passed in the java properties

Value parameters

antsPadsMP:

the antennas to pads string received in input

Attributes

Returns

the comma separated list of names of affected antennas

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

Produces the output of the component by evaluating the inputs.

Produces the output of the component by evaluating the inputs.

Attributes

Returns

the computed output of the ASCE

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

Initialize the TF by making some consistency checks

Initialize the TF by making some consistency checks

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

Concrete fields

val antPadRegExp: Regex

Names of pads must match with this regular expression

Names of pads must match with this regular expression

Attributes

val antType: Option[String]