Obtains information from the specified Archive Server. More...

Static Public Member Functions
static int	getArchiveData (String archiveServerContext, String deviceServer, String deviceProperty, String deviceName, int eventNumber, int startTime, int stopTime, TDataType data)

static NAME16[]	getDeviceServers (String context)

static NAME16[]	getDeviceServers (String context, int start, int stop)

static String[]	pmGetDeviceServers (String context)

static NAME16[]	getDeviceServers (String context, String trigger, int start, int stop)

static String[]	getDeviceServers (String context, String trigger, int eventTime)

static String[]	getDeviceServers (String context, String trigger)
	This method is an API break of its predecessor, which returned an array of NAME16 objects. More...

static String[]	pmGetDeviceServers (String context, int start, int stop)

static String[]	pmGetDeviceServers (String context, String trigger, int start, int stop)

static int	sendTrigger (String context, String trigger, String comment, long triggerTime, int triggerLevel, int rangeStart, int rangeStop, int maxOverRange)
	Sends the given trigger to the designated event archive server. More...

static int	sendTrigger (String context, String trigger, String comment)
	Sends the given trigger to the designated event archive server. More...

Detailed Description

Obtains information from the specified Archive Server.

Member Function Documentation

◆ getArchiveData()

static int de.desy.tine.eventUtils.TEventArchive.getArchiveData	(	String	archiveServerContext,
		String	deviceServer,
		String	deviceProperty,
		String	deviceName,
		int	eventNumber,
		int	startTime,
		int	stopTime,
		TDataType	data
	)

static

Deprecated:

Parameters

ArchiveServerContext
DeviceServer
DeviceProperty
DeviceName
eventNumber
startTime
stopTime
data

Returns

References de.desy.tine.client.TLink.cancel(), de.desy.tine.client.TLink.execute(), and de.desy.tine.client.TLink.getLastError().

◆ getDeviceServers() [1/5]

static NAME16 [] de.desy.tine.eventUtils.TEventArchive.getDeviceServers ( String context )

static

Deprecated:: use String[] getDeviceServers(String context,String trigger) or String[] getDeviceServers(String context,String trigger,int eventTime)

Parameters

context is the archive server context

Returns

Referenced by de.desy.tine.eventUtils.TEventArchive.getDeviceServers().

◆ getDeviceServers() [2/5]

static NAME16 [] de.desy.tine.eventUtils.TEventArchive.getDeviceServers	(	String	context,
		int	start,
		int	stop
	)

static

Deprecated:: use String[] getDeviceServers(String context,String trigger) or String[] getDeviceServers(String context,String trigger,int eventTime)

Parameters

context is the archive server context

Returns

References de.desy.tine.eventUtils.TEventArchive.getDeviceServers().

◆ getDeviceServers() [3/5]

static String [] de.desy.tine.eventUtils.TEventArchive.getDeviceServers	(	String	context,
		String	trigger
	)

static

This method is an API break of its predecessor, which returned an array of NAME16 objects.

See also: getDeviceServers_LEGACY

Parameters

context	is the archive server context
trigger	is the specific trigger used to access the device server list.

Returns: the list of device servers associated with the trigger.

References de.desy.tine.eventUtils.TEventArchive.getDeviceServers().

◆ getDeviceServers() [4/5]

static String [] de.desy.tine.eventUtils.TEventArchive.getDeviceServers	(	String	context,
		String	trigger,
		int	eventTime
	)

static

Parameters

context	is the archive server context
trigger	is the specific trigger used to access the device server list
eventTime	is the specific event of interest. If eventTime == 0 then the canonical list of servers which are addressed for the specific trigger is returned. If eventTime is non-zero and refers to a specific event, then the list of actual stored servers is returned (which should be equivalent to the canonical server list under most circumstances.

Returns: the list of device servers associated with the trigger and event time given.

References de.desy.tine.client.TLink.executeAndClose(), de.desy.tine.dataUtils.TDataType.getCompletionLength(), de.desy.tine.client.TLink.getLastError(), and de.desy.tine.client.TLink.getOutputDataObject().

◆ getDeviceServers() [5/5]

static NAME16 [] de.desy.tine.eventUtils.TEventArchive.getDeviceServers	(	String	context,
		String	trigger,
		int	start,
		int	stop
	)

static

Deprecated:: use String[] getDeviceServers(String context,String trigger) or String[] getDeviceServers(String context,String trigger,int eventTime)

Parameters

context	is the archive server context
trigger	is the specific trigger used to access the device server list

Returns

◆ pmGetDeviceServers() [1/3]

static String [] de.desy.tine.eventUtils.TEventArchive.pmGetDeviceServers ( String context )

static

Deprecated:: use GetDeviceServers

Parameters

context

Returns

Referenced by de.desy.tine.eventUtils.TEventArchive.pmGetDeviceServers().

◆ pmGetDeviceServers() [2/3]

static String [] de.desy.tine.eventUtils.TEventArchive.pmGetDeviceServers	(	String	context,
		int	start,
		int	stop
	)

static

Deprecated:: use GetDeviceServers

Parameters

context

Returns

References de.desy.tine.eventUtils.TEventArchive.pmGetDeviceServers().

◆ pmGetDeviceServers() [3/3]

static String [] de.desy.tine.eventUtils.TEventArchive.pmGetDeviceServers	(	String	context,
		String	trigger,
		int	start,
		int	stop
	)

static

Deprecated:: use GetDeviceServers

Parameters

context
trigger

Returns

◆ sendTrigger() [1/2]

static int de.desy.tine.eventUtils.TEventArchive.sendTrigger	(	String	context,
		String	trigger,
		String	comment
	)

static

Sends the given trigger to the designated event archive server.

This is the simplest form of sending an event trigger and is the de-facto standard for most triggers. Triggers started via this method will not be able to receive any range information to use should the trigger event involve accessing a sequence of data from a server's local history subsystem. As few triggers require this, this form of firing an event trigger is widely used.

Parameters

context	is the context of the event archive server which should receive the trigger.
trigger	is the trigger to send
comment	is an event annotation which describes this triggered event.

Returns: 0 upon success or a TINE error code indicating a problem issuing the trigger.

References de.desy.tine.eventUtils.TEventArchive.sendTrigger().

◆ sendTrigger() [2/2]

static int de.desy.tine.eventUtils.TEventArchive.sendTrigger	(	String	context,
		String	trigger,
		String	comment,
		long	triggerTime,
		int	triggerLevel,
		int	rangeStart,
		int	rangeStop,
		int	maxOverRange
	)

static

Sends the given trigger to the designated event archive server.

Parameters

context	is the context of the event archive server which should receive the trigger.
trigger	is the trigger to send
comment	is an event annotation which describes this triggered event.
triggerTime	is the requested time of trigger to associate with this event. If '0' (the default) then the system obtains the current trigger time associated with 'now'.
triggerLevel	is the desired trigger level. Default = 1 signals a normal start of trigger. The value '-1' indicates a pre-step which informs any other configured triggers that the indicated trigger is firing and thereby giving other trigger scripts a chance to participate in the on-going event.
rangeStart	is a system stamp to be used at the initial value when accessing a range of local history data. A value of '0' (default) implies that should the event involve local history data acquisition then a simple 'last 10' algorithm should be used. A value less than zero indicates that the time stamp should be used in acquiring local history data and that the range start value should be subtracted from the current time stamp in establishing the initial local history access.
rangeStop	is a system stamp to be used at the final value when accessing a range of local history data.
maxOverRange	gives a maximum value (default = 1000) of successive calls to the local history subsystem while traversing a range. If this parameter is less than or equal to zero then no range information will be sent with the trigger.