IDataRequest (newDataRequest())

class awips.dataaccess.IDataRequest[source]

An IDataRequest to be submitted to the DataAccessLayer to retrieve data.

__weakref__

list of weak references to the object

abstractmethod addIdentifier(key, value)[source]

Adds an identifier to the request. Identifiers are specific to the datatype being requested.

Args:

key: the string key of the identifier value: the value of the identifier

abstractmethod getDatatype()[source]

Gets the datatype of the request

Returns:

the datatype set on the request

abstractmethod getEnvelope()[source]

Gets the envelope on the request

Returns:

a rectangular shapely geometry

abstractmethod getIdentifiers()[source]

Gets the identifiers on the request

Returns:

a dictionary of the identifiers

abstractmethod getLevels()[source]

Gets the levels on the request

Returns:

a list of strings of the levels

abstractmethod getLocationNames()[source]

Gets the location names on the request

Returns:

a list of strings of the location names

abstractmethod setDatatype(datatype)[source]

Sets the datatype of the request.

Args:

datatype: A string of the datatype, such as “grid”, “radar”, “gfe”, “obs”

abstractmethod setEnvelope(env)[source]

Sets the envelope of the request. If supported by the datatype factory, the data returned for the request will be constrained to only the data within the envelope.

Args:

env: a shapely geometry

abstractmethod setLevels(levels)[source]

Sets the levels of data to request. Not all datatypes support levels.

Args:

levels: a list of strings of level abbreviations to request

abstractmethod setLocationNames(locationNames)[source]

Sets the location names of the request.

Args:

locationNames: a list of strings of location names to request

abstractmethod setParameters(params)[source]

Sets the parameters of data to request.

Args:

params: a list of strings of parameters to request