de.desy.tine.histUtils.THistory Class Reference

THistory is a utility class with numerous static methods for access archive data from either the central archive system of the local history subsystems of targeted servers. More...

List of all members.

Static Public Member Functions
static int	getArchivedData (String context, String server, String property, String device, double start, double stop, FLTINT[] data)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, int index, int sample, double start, double stop, FLTINT[] data, int timeout)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, FLTINT[] data)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, int index, double start, double stop, FLTINT[] data)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, int index, double start, double stop, FLTINT[] data, int timeout)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, double start, double stop, DBLDBL[] data)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, int index, int sample, double start, double stop, DBLDBL[] data, int timeout)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, DBLDBL[] data)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, double start, double stop, DBLDBL[] data, THistorySource src, int timeout)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, double start, double stop, FLTINT[] data, THistorySource src, int timeout)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, double start, double stop, NAME16I[] data, THistorySource src, int timeout)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, double start, double stop, NAME32I[] data, THistorySource src, int timeout)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, double start, double stop, NAME64I[] data, THistorySource src, int timeout)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, int index, double start, double stop, DBLDBL[] data)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, int index, double start, double stop, DBLDBL[] data, int timeout)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, int index, double start, double stop, HISTORY[] data, int timeout)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, int index, int sample, double start, double stop, HISTORY[] data, int timeout)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, double start, double stop, NAME16I[] data)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, int index, int sample, double start, double stop, NAME16I[] data, int timeout)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, double start, double stop, NAME16I[] data, int timeout)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, double start, double stop, NAME32I[] data)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, int index, int sample, double start, double stop, NAME32I[] data, int timeout)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, double start, double stop, NAME32I[] data, int timeout)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, double start, double stop, NAME64I[] data)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, int index, int sample, double start, double stop, NAME64I[] data, int timeout)
	Retrieves an archive data set.
static int	getArchivedData (String context, String server, String property, String device, double start, double stop, NAME64I[] data, int timeout)
	Retrieves an archive data set.
static int	getNumPointsInInterval (String context, String server, String property, String device, double start, double stop)
	Retrieves the total number of stored data points in the interval specified.
static int	getNumPointsInInterval (String context, String server, String property, String device, double start, double stop, int timeout)
	Retrieves the total number of stored data points in the interval specified.
static int	getArchivedSnapshot (String context, String server, String property, String device, double[] targetTime, float[] data)
	Retrieves an archived data array 'snapshot' at the time specified.
static String[]	getArchivedProperties (String context)
	Retrieve a list of properties archived by the central archive server for the context given.
static String[]	getArchivedProperties (String context, String server)
	Retrieve a list of properties archived by the given server.
static String[]	getArchivedProperties (String context, String server, String subsystem)
	Retrieve a list of properties archived by the given server.
static String[]	getArchivedDevices (String context, String server, String property)
	Retrieve a list of archived devices for the given server and property.
static String[]	getArchivedSubsystems (String context)
	Retrieve a list of available subsystems at the central archive server for the given context.
static String[]	getArchiveServerContexts ()
	Retrieve a list of available contexts where a central archive server exists.
static String[]	getArchiveServerContexts (String importance)
	Retrieve a list of available contexts where a central archive server exists and has the importance specified.

---

Detailed Description

THistory is a utility class with numerous static methods for access archive data from either the central archive system of the local history subsystems of targeted servers.

Author:

duval

---

Member Function Documentation

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		FLTINT[]	data
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried. Archived data will be obtained up to the current time and to a depth given by the supplied data buffer.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		double	start,
		double	stop,
		NAME16I[]	data,
		int	timeout
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		double	start,
		double	stop,
		NAME32I[]	data
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		double	start,
		double	stop,
		FLTINT[]	data,
		THistorySource	src,
		int	timeout
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. Both the central archive and local archive are queried for the number of stored points over the interval. Data are usually retrieved from the central archive system if there are at least 500 points over the time interval in question. Otherwise the local archive system is used. By examining the THistorySource object one can see which source was chosen and how many points both sources have over the interval. For dedicated retrieval from one source or the other, please use an overloaded method which does not take the THistorySource parameter!

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The src parameter will give the exact number of points actually stored over the interval specified. The number of points returned in the call will often be less than array dimension and less than the exact number of points stored over the interval.
src	is a reference to a THistorySource object to receive the history source information.
timeout	gives the number of milliseconds to wait for the call to complete (usually 1000 is sufficient).

Returns:

0 upon success or a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		int	index,
		int	sample,
		double	start,
		double	stop,
		NAME32I[]	data,
		int	timeout
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
index	is the array index requested in the event that the archive record is a (spectrum) array. When the archive record is a multi-channel array, the device name passed determines the array index. Generally passing a '0' in most cases a good idea, as the history of a particular spectrum or waveform index is of limited value and is useful primarily in retrieving an array of stored timestamps.
sample	is the requested sampling raster. If 0 or less, then the archive server will determine a suitable raster to accommodate the time range specified as well as the size of the data buffer given.
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed if the given sample is 0 or less). The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.
timeout	is the time in milliseconds to wait for a response from the archive server.

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		double	start,
		double	stop,
		NAME32I[]	data,
		int	timeout
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.
timeout	gives the number of milliseconds to wait for the call to complete (usually 1000 is sufficient).

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		int	index,
		double	start,
		double	stop,
		FLTINT[]	data
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		double	start,
		double	stop,
		NAME64I[]	data
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		int	index,
		int	sample,
		double	start,
		double	stop,
		NAME64I[]	data,
		int	timeout
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
index	is the array index requested in the event that the archive record is a (spectrum) array. When the archive record is a multi-channel array, the device name passed determines the array index. Generally passing a '0' in most cases a good idea, as the history of a particular spectrum or waveform index is of limited value and is useful primarily in retrieving an array of stored timestamps.
sample	is the requested sampling raster. If 0 or less, then the archive server will determine a suitable raster to accommodate the time range specified as well as the size of the data buffer given.
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed if the given sample is 0 or less). The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.
timeout	is the time in milliseconds to wait for a response from the archive server.

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		double	start,
		double	stop,
		NAME64I[]	data,
		int	timeout
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		int	index,
		double	start,
		double	stop,
		FLTINT[]	data,
		int	timeout
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		double	start,
		double	stop,
		NAME16I[]	data,
		THistorySource	src,
		int	timeout
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. Both the central archive and local archive are queried for the number of stored points over the interval. Data are usually retrieved from the central archive system if there are at least 500 points over the time interval in question. Otherwise the local archive system is used. By examining the THistorySource object one can see which source was chosen and how many points both sources have over the interval. For dedicated retrieval from one source or the other, please use an overloaded method which does not take the THistorySource parameter!

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The src parameter will give the exact number of points actually stored over the interval specified. The number of points returned in the call will often be less than array dimension and less than the exact number of points stored over the interval.
src	is a reference to a THistorySource object to receive the history source information.
timeout	gives the number of milliseconds to wait for the call to complete (usually 1000 is sufficient).

Returns:

0 upon success or a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		double	start,
		double	stop,
		DBLDBL[]	data
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		double	start,
		double	stop,
		NAME32I[]	data,
		THistorySource	src,
		int	timeout
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. Both the central archive and local archive are queried for the number of stored points over the interval. Data are usually retrieved from the central archive system if there are at least 500 points over the time interval in question. Otherwise the local archive system is used. By examining the THistorySource object one can see which source was chosen and how many points both sources have over the interval. For dedicated retrieval from one source or the other, please use an overloaded method which does not take the THistorySource parameter!

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The src parameter will give the exact number of points actually stored over the interval specified. The number of points returned in the call will often be less than array dimension and less than the exact number of points stored over the interval.
src	is a reference to a THistorySource object to receive the history source information.
timeout	gives the number of milliseconds to wait for the call to complete (usually 1000 is sufficient).

Returns:

0 upon success or a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		double	start,
		double	stop,
		FLTINT[]	data
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		int	index,
		int	sample,
		double	start,
		double	stop,
		DBLDBL[]	data,
		int	timeout
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
index	is the array index requested in the event that the archive record is a (spectrum) array. When the archive record is a multi-channel array, the device name passed determines the array index. Generally passing a '0' in most cases a good idea, as the history of a particular spectrum or waveform index is of limited value and is useful primarily in retrieving an array of stored timestamps.
sample	is the requested sampling raster. If 0 or less, then the archive server will determine a suitable raster to accommodate the time range specified as well as the size of the data buffer given.
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed if the given sample is 0 or less). The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.
timeout	is the time in milliseconds to wait for a response from the archive server.

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		double	start,
		double	stop,
		NAME64I[]	data,
		THistorySource	src,
		int	timeout
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. Both the central archive and local archive are queried for the number of stored points over the interval. Data are usually retrieved from the central archive system if there are at least 500 points over the time interval in question. Otherwise the local archive system is used. By examining the THistorySource object one can see which source was chosen and how many points both sources have over the interval. For dedicated retrieval from one source or the other, please use an overloaded method which does not take the THistorySource parameter!

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The src parameter will give the exact number of points actually stored over the interval specified. The number of points returned in the call will often be less than array dimension and less than the exact number of points stored over the interval. One can use the getNumberReturned() method of the history source object to ascertain the number of archived data points returned.
src	is a reference to a THistorySource object to receive the history source information.
timeout	gives the number of milliseconds to wait for the call to complete (usually 1000 is sufficient).

Returns:

0 upon success or a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		DBLDBL[]	data
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried. Archived data will be obtained up to the current time and to a depth given by the supplied data buffer.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		int	index,
		double	start,
		double	stop,
		DBLDBL[]	data
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		int	index,
		double	start,
		double	stop,
		DBLDBL[]	data,
		int	timeout
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.
timeout	gives the number of milliseconds to wait for the call to complete (usually 1000 is sufficient).

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		int	index,
		int	sample,
		double	start,
		double	stop,
		FLTINT[]	data,
		int	timeout
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
index	is the array index requested in the event that the archive record is a (spectrum) array. When the archive record is a multi-channel array, the device name passed determines the array index. Generally passing a '0' in most cases a good idea, as the history of a particular spectrum or waveform index is of limited value and is useful primarily in retrieving an array of stored timestamps.
sample	is the requested sampling raster. If 0 or less, then the archive server will determine a suitable raster to accommodate the time range specified as well as the size of the data buffer given.
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed if the given sample is 0 or less). The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.
timeout	is the time in milliseconds to wait for a response from the archive server.

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		double	start,
		double	stop,
		DBLDBL[]	data,
		THistorySource	src,
		int	timeout
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. Both the central archive and local archive are queried for the number of stored points over the interval. Data are usually retrieved from the central archive system if there are at least 500 points over the time interval in question. Otherwise the local archive system is used. By examining the THistorySource object one can see which source was chosen and how many points both sources have over the interval. For dedicated retrieval from one source or the other, please use an overloaded method which does not take the THistorySource parameter!

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The src parameter will give the exact number of points actually stored over the interval specified. The number of points returned in the call will often be less than array dimension and less than the exact number of points stored over the interval.
src	is a reference to a THistorySource object to receive the history source information.
timeout	gives the number of milliseconds to wait for the call to complete (usually 1000 is sufficient).

Returns:

0 upon success or a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		int	index,
		double	start,
		double	stop,
		HISTORY[]	data,
		int	timeout
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a HISTORY[] data array object to contain the returned data. This object passed should be an array of HISTORY instances, which have been constructed with the desired data type (usually a compound data type) to be returned. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.
timeout	gives the number of milliseconds to wait for the call to complete (usually 1000 is sufficient).

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		int	index,
		int	sample,
		double	start,
		double	stop,
		HISTORY[]	data,
		int	timeout
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
sample	is the desired raster sample. Passing a '0' will instruct the targeted server to select a raster which will best fill in the desired time range. If (e.g.) a '1' is passed then no raster will be used. This means that the desired 'stop' time may not have been reached. Thus the returned data need to be examined in order to determine whether the call should be repeated (after adjusting the 'start' time).
data	is a reference to a HISTORY[] data array object to contain the returned data. This object passed should be an array of HISTORY instances, which have been constructed with the desired data type (usually a compound data type) to be returned. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.
timeout	gives the number of milliseconds to wait for the call to complete (usually 1000 is sufficient).

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		double	start,
		double	stop,
		NAME16I[]	data
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data.
timeout	gives the number of milliseconds to wait for the call to complete (usually 1000 is sufficient). This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed. The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getArchivedData	(	String	context,
		String	server,
		String	property,
		String	device,
		int	index,
		int	sample,
		double	start,
		double	stop,
		NAME16I[]	data,
		int	timeout
	)		[static]

Retrieves an archive data set.

Retrieve an archive data set (value - timestamp pairs) for the target property and device given and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
index	is the array index requested in the event that the archive record is a (spectrum) array. When the archive record is a multi-channel array, the device name passed determines the array index. Generally passing a '0' in most cases a good idea, as the history of a particular spectrum or waveform index is of limited value and is useful primarily in retrieving an array of stored timestamps.
sample	is the requested sampling raster. If 0 or less, then the archive server will determine a suitable raster to accommodate the time range specified as well as the size of the data buffer given.
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
data	is a reference to a (doublet) data array object to contain the returned data. This can be one of FLTINT[], DBLDBL[], NAME64I[], and so on. The array should be dimensioned to the maximum number of points desired (effectively determining a raster over which the archived data will be distributed if the given sample is 0 or less). The number of points returned in the call will often be less than array dimension so one should pay attention to the return value of the call.
timeout	is the time in milliseconds to wait for a response from the archive server.

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static String [] de.desy.tine.histUtils.THistory.getArchivedDevices	(	String	context,
		String	server,
		String	property
	)		[static]

Retrieve a list of archived devices for the given server and property.

Parameters:

context	is the targeted server context
server	is the targeted server name
property	is the targeted property

Returns:

a list of available archived device names

static String [] de.desy.tine.histUtils.THistory.getArchivedProperties

(

String

context

)

[static]

Retrieve a list of properties archived by the central archive server for the context given.

Parameters:

context

is the targeted context

Returns:

a list of available archived properties

static String [] de.desy.tine.histUtils.THistory.getArchivedProperties	(	String	context,
		String	server
	)		[static]

Retrieve a list of properties archived by the given server.

Parameters:

context	is the targeted server context
server	is the targeted server name

Returns:

a list of available archived properties

static String [] de.desy.tine.histUtils.THistory.getArchivedProperties	(	String	context,
		String	server,
		String	subsystem
	)		[static]

Retrieve a list of properties archived by the given server.

Parameters:

context	is the targeted server context
server	is the targeted server name
subsystem	is the targeted subsystem (applicable when the server = "HISTORY", i.e. the central archive server)

Returns:

a list of available archived properties

static int de.desy.tine.histUtils.THistory.getArchivedSnapshot	(	String	context,
		String	server,
		String	property,
		String	device,
		double[]	targetTime,
		float[]	data
	)		[static]

Retrieves an archived data array 'snapshot' at the time specified.

Retrieve an archive data set for the target property and device given at the time specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried. The returned data set represents the entire data array, be it a multi-channel array, trace array, or scalar at a stored time nearest (but not greater than) the given time.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
targetTime	is the targetted time in seconds (UTC double, a TINE timestamp) This is passed as a single-valued array, so that the targetted time can be altered by the call to reflect the time found.
data	is a reference to a float data array object to contain the returned data. The array should be dimensioned to the number of points in the data record.

Returns:

0 if success or a TINE error code.

static String [] de.desy.tine.histUtils.THistory.getArchivedSubsystems

(

String

context

)

[static]

Retrieve a list of available subsystems at the central archive server for the given context.

Parameters:

context

is the targeted server context

Returns:

a list of available subsystems

static String [] de.desy.tine.histUtils.THistory.getArchiveServerContexts

(

)

[static]

Retrieve a list of available contexts where a central archive server exists.

Returns:

a list of available contexts

static String [] de.desy.tine.histUtils.THistory.getArchiveServerContexts

(

String

importance

)

[static]

Retrieve a list of available contexts where a central archive server exists and has the importance specified.

Parameters:

importance

is the targeted importance level (one of "ALL", "IMPORTANT", "CRITICAL", "ESSENTIAL")

Returns:

a list of available contexts

static int de.desy.tine.histUtils.THistory.getNumPointsInInterval	(	String	context,
		String	server,
		String	property,
		String	device,
		double	start,
		double	stop
	)		[static]

Retrieves the total number of stored data points in the interval specified.

Retrieve the number of points stored for the given parameters and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

static int de.desy.tine.histUtils.THistory.getNumPointsInInterval	(	String	context,
		String	server,
		String	property,
		String	device,
		double	start,
		double	stop,
		int	timeout
	)		[static]

Retrieves the total number of stored data points in the interval specified.

Retrieve the number of points stored for the given parameters and over the time range specified. If server is null, an empty string, or "HISTORY", the central archive server is queried for the data. Otherwise the local history subsystem of the device server specified is queried.

Parameters:

context	is the desired context
server	is the device server which manages the archived parameter. If null then the central archive will be queried for the property and device
property	is the desired archived property
device	is the desired device name
start	is the start time in seconds (UTC double, a TINE timestamp)
stop	is the stop time in seconds (UTC double, a TINE timestamp)
timeout	gives the number of milliseconds to wait for the call to complete (usually 1000 is sufficient).

Returns:

if positive, the number of points returned in the archive call; if negative, the negative of a TINE error code.

---

The documentation for this class was generated from the following file:

• THistory.java