Package org.eso.ias.asce.transfer

Class TransferExecutor

java.lang.Object

org.eso.ias.asce.transfer.TransferExecutor

Direct Known Subclasses:

JavaTransferExecutor

public abstract class TransferExecutor
extends Object

TransferExecutor is the abstract for the implementators of the transfer function in java.

Author:

acaproni

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	compElementId	The ID of the computational element that runs this transfer function
protected final String	compElementRunningId	The ID of the computational element that runs this transfer function extended with the IDs of its parents
protected final Properties	props	Properties for this executor.
protected final long	validityTimeFrame	The time frame (msec) to invalidate monitor points that have been refreshed after the time frame.

Constructor Summary

Constructors

Constructor	Description
TransferExecutor(String cEleId, String cEleRunningId, long validityTimeFrame, Properties props)	Constructor

Method Summary

Modifier and Type	Method	Description
Optional<Integer>	getTemplateInstance()
boolean	isTemplated()
final void	setTemplateInstance(Optional<Integer> templateInstance)	Set the instance of the template, if any
abstract void	shutdown()	Shuts down the BehaviorRunner when the IAS does not need it anymore.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

compElementId

protected final String compElementId

The ID of the computational element that runs this transfer function

compElementRunningId

protected final String compElementRunningId

The ID of the computational element that runs this transfer function extended with the IDs of its parents

See Also:

• Identifier

validityTimeFrame

protected final long validityTimeFrame

The time frame (msec) to invalidate monitor points that have been refreshed after the time frame. The validityTimeFrame is given by validityThreshold prop. of the IAS

props

protected final Properties props

Properties for this executor.

Constructor Details

TransferExecutor

public TransferExecutor(String cEleId,
 String cEleRunningId,
 long validityTimeFrame,
 Properties props)

Constructor

Parameters:

cEleId - : The id of the ASCE

cEleRunningId - : the running ID of the ASCE

validityTimeFrame - : The time frame (msec) to invalidate monitor points

props - : The properties fro the executor

Method Details

setTemplateInstance

public final void setTemplateInstance(Optional<Integer> templateInstance)

Set the instance of the template, if any

Parameters:

templateInstance - the instance of the template

isTemplated

public boolean isTemplated()

Returns:

true if the ASCE where the TF runs has been generated by a template; false otherwise

shutdown

public abstract void shutdown()
                       throws Exception

Shuts down the BehaviorRunner when the IAS does not need it anymore. This life cycle method is called last, to clean up the resources. It is supposed to return quickly, even if not mandatory.

Throws:

Exception - In case of error shutting down

getTemplateInstance

public Optional<Integer> getTemplateInstance()

Returns:

The instance of the template, if defined; empty otherwise

See Also:

• templateInstance