...
| Code Block |
|---|
String getClientConfigFile(String clientIdin0, String fileExtensionin1); |
Retrieves a client configuration file.
- in0 - clientId: File name of client configuration file located in the OC configuration directory 'PiClientConfigFiles'. This file is free format and content is only read by client application. Only requirement is that content is text based.
- in1 - fileExtension: Extension of client file.
- returns: Text file containing client configuration.
| Code Block |
|---|
Date getSystemTime(String clientIdin0); |
Get current OC system time.
- in0 - clientId: <id not required>
- returns: Date field containing OC system time.
...
| Code Block |
|---|
String getDisplayUnit(String parameterIdin0); |
Retrieves display unit for a specific parameter
- in0 - parameterId
- returns: String holding the unit
...
| Code Block |
|---|
String getTimeZoneId(String clientIdin0); |
Get OC timeZone id.
- in0 - clientId: <id not required>
- returns: String representation of time zone.
...
| Code Block |
|---|
String[] getColdStateIds(String clientIdin0, String idin1); |
Get list of available ColdState ids.
- in0 - clientId: File name of service configuration file located in the OC configuration directory 'PiServiceConfigFiles'. This file is an instance of the FewsPiServiceConfig XSD.
- in1 - id: Reference to the ID of a ModuleState element in the service configuration file.
- returns: List of ColdStateGroup ids.
...
| Code Block |
|---|
Date[] getAvailableStateTimes(String clientIdin0, String idin1); |
Get available warm state times.
- in0 - clientId: File name of service configuration file located in the OC configuration directory 'PiServiceConfigFiles'. This file is an instance of the FewsPiServiceConfig XSD.
- in1 - id: Reference to the ID of a ModuleState element in the service configuration file.
- returns: Available warm state times for requested ModuleState.
| Code Block |
|---|
int[] getEnsembleMemberIndices(String clientIdin0, String ensembleIdin1); |
Get available ensemble member ids.
- in0 - clientId: <id not required>
- in1 - ensembleId: Id of requested ensemble.
- returns: Available member indices of requested ensemble.
...
| Code Block |
|---|
String getFilters(String piVersionin0); |
Get the configured filter ids from the FEWS system.
- in0 - piVersion: (Optional) Pi Version for the return file. Defaults to the latest PI version.
- returns: String content of a Pi_Filters XML file containing Fews Filters.
| Code Block |
|---|
String getLocations(String clientIdin0, String filterIdin1, String piVersionin2); |
Get location information available for the passed 'filterId' argument.
- in0 - clientId: (Optional) File name of service configuration file located in the OC configuration directory 'PiServiceConfigFiles'. This file is an instance of the FewsPiServiceConfig XSD. If not
provided then no id mapping will be done. - in1 - filterId: Filter Id. Can be retrieved using the String getFilters(String piVersion) method.
- in2 - piVersion: (Optional) Pi Version for the return file. Defaults to the latest PI version.
- returns: String content of a Pi_Locations XML file containing the locations available for passed filter id.
| Code Block |
|---|
String getParameters(String clientIdin0, String filterIdin1, String piVersionin2); |
Get timeseries parameter information available for the passed 'filterId' argument.
- in0 - clientId: (Optional) File name of service configuration file located in the OC configuration directory 'PiServiceConfigFiles'. This file is an instance of the FewsPiServiceConfig XSD. If not provided then no id mapping will be done.
- in1 - filterId: Filter Id. Can be retrieved using the String getFilters(String piVersion) method.
- in2 - piVersion: (Optional) Pi Version for the return file. Defaults to the latest PI version.
- returns: String content of a Pi_TimeSeriesParameters XML file containing the parameters available for passed filter id.
| Code Block |
|---|
String getRatingCurves(String[] ratingCurveIdsin0); |
Retrieves rating curves content in PI-rating curve format for selecetd rating curve identifiers
- in0 - ratingCurveIds: String array with lcoation identifiers of the ratings
- returns: Xml string in Pi_ratyingcurves format holding rating curves
| Code Block |
|---|
String getLogMessages(String clientIdin0, String taskIdin1) |
Get log messages produces by the last run of given task id.
- in0 - clientId: <id not required but can not be null>
- in1 - taskId: Task ID for which to retrieve log messages. Only messages for the last run are returned.
- returns: String containing the log messages in the format defined by the PI Diag XSD
...