src

Documentation

Index

• func CreateEnvironment(envId string, createdAt time.Time, status string, statusMessage string) (sw.EnvironmentResponse, *http.Response, error)
• func CreateFlp(name string, hostName string, runNumber int32) (sw.FlpResponse, *http.Response, error)
• func CreateLog(text string, title string, runNumbers string, parentLogId int32) (sw.LogResponse, *http.Response, error)
• func CreateRun(environmentId string, nDetectors int32, nEpns int32, nFlps int32, ...) (sw.RunResponse, *http.Response, error)
• func GetLogs()
• func GetRuns()
• func InitializeApi(baseUrl string, apiKey string)
• func UpdateEnvironment(envId string, toredownAt time.Time, status string, statusMessage string) (sw.EnvironmentResponse, *http.Response, error)
• func UpdateFlp(flpName string, runNumber int32, nSubtimeframes int32, nEquipmentBytes int32, ...) (sw.FlpResponse, *http.Response, error)
• func UpdateRun(runNumber int32, runQuality sw.RunQuality, timeO2Start int64, timeO2End int64, ...) (sw.RunResponse, *http.Response, error)

Functions

func CreateEnvironment

func CreateEnvironment(envId string, createdAt time.Time, status string, statusMessage string) (sw.EnvironmentResponse, *http.Response, error)

*

• Create an environment
• @param envId Integer ID of a specific data taking session.
• @param createdAt The time of creation, if empty it will give a default time
• @param status The current status of the environment STARTED/STOPPED etc.
• @param statusMessage A message to elaborate onto

func CreateFlp

func CreateFlp(name string, hostName string, runNumber int32) (sw.FlpResponse, *http.Response, error)

*

• Adds an FLP to a run *
• @param name Identifying name of the FLP
• @param hostName Host name of the FLP
• @param runNumber Integer ID of a specific data taking session

func CreateLog

func CreateLog(text string, title string, runNumbers string, parentLogId int32) (sw.LogResponse, *http.Response, error)

*

• Create a log *
• @param text Log entry that is written by the shifter
• @param title Title for the log
• @param runNumbers Vector of runNumbers that the log is about
• @param parentLogId Integer id of the parent log

todo: keep runNumbers as string? or convert to css (comma separated string) in function body?

func CreateRun

func CreateRun(environmentId string, nDetectors int32, nEpns int32, nFlps int32,
	runNumber int32, runType string, dd_flp bool, dcs bool, epn bool, epnTopology string, odcTopologyFullName string, detectors sw.Detectors) (sw.RunResponse, *http.Response, error)

*

• Starts a run *
• @param activityId Control ID string. Can be a long hash, 32 or 64 character long
• @param nDetectors Number of detectors in the Run
• @param nEpns Number of EPN nodes in the Run
• @param nFlps Number of FLP nodes in the Run
• @param runNumber Integer ID of a specific data taking session
• @param runType Type of run. Might be replaced by tags
• @param o2Start Time (UTC) when command to start a new Run was given
• @param dd_flp Data Distrubtion(FLP) boolean of the Run. On or Off
• @param dcs DCS boolean of the Run. On or Off
• @param epn EPN boolean of the Run. On or Off
• @param epnTopology description of the EPN.
• @param detectors types of detecotrs in the run.
• @param triggerStart Time (UTC) when Trigger subsystem was started

func GetLogs

func GetLogs()

*

• Get all logs
• @returns ArrayOfLogsResponse

func GetRuns

func GetRuns()

*

• Get all runs
• @returns ArrayOfRunsResponse

func InitializeApi

func InitializeApi(baseUrl string, apiKey string)

*

• Initialize api *
• @param baseUrl String which is the base url used
• @param apiKey Current apikey while running the system

func UpdateEnvironment

func UpdateEnvironment(envId string, toredownAt time.Time, status string, statusMessage string) (sw.EnvironmentResponse, *http.Response, error)

*

• Update flp by id *
• @param envId Integer ID of a specific data taking session.
• @param createdAt The time of creation, if empty it will give a default time
• @param status The current status of the environment STARTED/STOPPED etc.
• @param statusMessage A message to elaborate onto

func UpdateFlp

func UpdateFlp(flpName string, runNumber int32, nSubtimeframes int32, nEquipmentBytes int32, nRecordingBytes int32, nFairMQBytes int32) (sw.FlpResponse, *http.Response, error)

*

• Update flp by id *
• @param flpId Integer ID of a specific data taking session.
• @param flpName Identifying name of the FLP.
• @param nSubtimeframes Number of subtimeframes processed in this FLP. Updated regularly.
• @param nEquipmentBytes Data volume out from the readout 'equipment' component in bytes. Can reach PetaBytes. Updated regularly.
• @param nRecordingBytes Data volume out from the readout 'recording' component in bytes. Can reach PetaBytes. Updated regularly.
• @param nFairMqBytes Data volume out from the readout 'fmq' component in bytes. Can reach PetaBytes. Updated regularly.

func UpdateRun

func UpdateRun(runNumber int32, runQuality sw.RunQuality, timeO2Start int64, timeO2End int64, timeTrgStart int64, timeTrgEnd int64,
	triggerValue string, pdpConfigOption string, pdpTopologyDescriptionLibraryFile string, tfbDdMode string, lhcPeriod string, odcTopologyFullName string,
	pdpWorkflowParameters string, pdpBeamType string, readoutCfgUri string) (sw.RunResponse, *http.Response, error)

*

• Ends a run *
• @param runNumber Integer ID of a specific data taking session
• @param runQuality Overall quality of the data from O2 point of view
• @param o2End Time (UTC) when Run was completely stopped
• @param triggerEnd (UTC) Time when Trigger subsystem was stopped