Structure¶

Base data structures for the SDK.

class helios.core.structure.ImageRecord(name=None, filename=None, **kwargs)[source]¶

Record class for images.

Parameters:	name (str) – Name of image. filename (str) – Full path to image file that was written.

image¶

Alias for Record content attribute.

Returns:	Image data.
Return type:	PIL.Image.Image

ok¶

Check if failure occurred.

Returns:	False if error occurred, and True otherwise.
Return type:	bool

parameters¶

Function call parameters.

Returns:	Parameters dictionary.
Return type:	dict

class helios.core.structure.Record(url=None, parameters=None, content=None, error=None)[source]¶

Individual query record.

Parameters:	url (str) – API URL. parameters (dict) – All parameters for current function or method call. content – Returned content. To be defined by method. error (exception) – Exception that occurred, if any.

ok¶

Check if failure occurred.

Returns:	False if error occurred, and True otherwise.
Return type:	bool

parameters¶

Function call parameters.

Returns:	Parameters dictionary.
Return type:	dict

class helios.core.structure.RecordCollection(records=None)[source]¶

Class for handling query records. .. attribute:: records

Raw record data for debugging purposes.

type: list of Record