Package cern.nxcals.api.backport.client.service

Interface LHCFillDataService

public interface LHCFillDataService

Method Summary

Modifier and Type	Method	Description
LHCFill	getLastCompletedLHCFillAndBeamModes()	Gets the last completed LHC Fill, containing all beams modes which have occurred within the fill.
LHCFill	getLHCFillAndBeamModesByFillNumber(int fillNumber)	Gets the LHC Fill with the given fill number.
LHCFillSet	getLHCFillsAndBeamModesInTimeWindow(java.sql.Timestamp startTime, java.sql.Timestamp endTime)	Gets the LHC Fills which occurred within the given time window.
LHCFillSet	getLHCFillsAndBeamModesInTimeWindowContainingBeamModes(java.sql.Timestamp startTime, java.sql.Timestamp endTime, BeamModeValue[] beamModes)	Gets the LHC Fills which occurred within the given time window, provided that they contain one or more of the given beam modes.
LHCFillSet	getLHCFillsInTimeWindow(java.sql.Timestamp startTime, java.sql.Timestamp endTime)	Gets the LHC Fills which occurred within the given time window.
LHCFillSet	getLHCFillsInTimeWindowContainingBeamModes(java.sql.Timestamp startTime, java.sql.Timestamp endTime, BeamModeValue[] beamModes)	Gets the LHC Fills which occurred within the given time window, provided that they contain one or more of the given beam modes.

Method Detail

getLHCFillsInTimeWindow

LHCFillSet getLHCFillsInTimeWindow(java.sql.Timestamp startTime,
                                   java.sql.Timestamp endTime)

Gets the LHC Fills which occurred within the given time window. Each LHC Fill will NOT contain the beams modes which have occurred within the Fill.

Parameters:

startTime - - The start of the time window within which to search for LHC Fills

endTime - - The end of the time window within which to search for LHC Fills

Returns:

an LHCFillSet containing all LHC Fills which occurred within the given time window

See Also:

getLHCFillsAndBeamModesInTimeWindow(Timestamp, Timestamp)

getLHCFillsAndBeamModesInTimeWindow

LHCFillSet getLHCFillsAndBeamModesInTimeWindow(java.sql.Timestamp startTime,
                                               java.sql.Timestamp endTime)

Gets the LHC Fills which occurred within the given time window. Each LHC Fill will contain all beams modes which have occurred within the Fill.

Parameters:

startTime - - The start of the time window within which to search for LHC Fills

endTime - - The end of the time window within which to search for LHC Fills

Returns:

an LHCFillSet containing all LHC Fills which match the search criteria

See Also:

getLHCFillsInTimeWindow(Timestamp, Timestamp)

getLHCFillsAndBeamModesInTimeWindowContainingBeamModes

LHCFillSet getLHCFillsAndBeamModesInTimeWindowContainingBeamModes(java.sql.Timestamp startTime,
                                                                  java.sql.Timestamp endTime,
                                                                  BeamModeValue[] beamModes)

Gets the LHC Fills which occurred within the given time window, provided that they contain one or more of the given beam modes. Each LHC Fill will contain all beams modes which have occurred within the fill.

Parameters:

startTime - - The start of the time window within which to search for LHC Fills

endTime - - The end of the time window within which to search for LHC Fills

beamModes - - The beam modes by which LHC Fills in the time window will be filtered by (i.e. only Fills containing one or more of the beam modes will be returned).

Returns:

an LHCFillSet containing all LHC Fills which match the search criteria

See Also:

getLHCFillsInTimeWindowContainingBeamModes(Timestamp, Timestamp, BeamModeValue[])

getLastCompletedLHCFillAndBeamModes

LHCFill getLastCompletedLHCFillAndBeamModes()

Gets the last completed LHC Fill, containing all beams modes which have occurred within the fill. The last completed LHC Fill is the Fill which has ended before the current Fill has started.

Returns:

The last completed LHCFill

getLHCFillAndBeamModesByFillNumber

LHCFill getLHCFillAndBeamModesByFillNumber(int fillNumber)

Gets the LHC Fill with the given fill number. Returns null if no Fill with the given number exists.

Parameters:

fillNumber - - The number of the LHCFill which should be retrieved

Returns:

The LHCFill with the given fill number

getLHCFillsInTimeWindowContainingBeamModes

LHCFillSet getLHCFillsInTimeWindowContainingBeamModes(java.sql.Timestamp startTime,
                                                      java.sql.Timestamp endTime,
                                                      BeamModeValue[] beamModes)

Gets the LHC Fills which occurred within the given time window, provided that they contain one or more of the given beam modes. Each LHC Fill will NOT contain the beams modes which have occurred within the Fill.

Parameters:

startTime - - The start of the time window within which to search for LHC Fills

endTime - - The end of the time window within which to search for LHC Fills

beamModes - - The beam modes by which LHC Fills in the time window will be filtered by (i.e. only Fills containing one or more of the beam modes will be returned).

Returns:

an LHCFillSet containing all LHC Fills which match the search criteria

See Also:

getLHCFillsAndBeamModesInTimeWindowContainingBeamModes(Timestamp, Timestamp, BeamModeValue[])