numerous.sdk.models.parameter module#

class numerous.sdk.models.parameter.Config(value)#

Bases: object

static from_document(data)#
Return type:

Config

value: str#
class numerous.sdk.models.parameter.Currency(name, code)#

Bases: object

code: str#
static from_document(data)#
Return type:

Currency

name: str#
class numerous.sdk.models.parameter.FileReference(id, path, name, file_manager_client)#

Bases: object

Represents the reference to a selected file, uploaded to the platform. Can be used to access that files content.

download()#

Download the referenced file, and get the resulting path.

If the file has already been downloaded, the previously downloaded file is overridden.

Return type:

str

file_manager_client: FileManagerStub#
property file_path: str#

The local path to the referenced file. The file will be downloaded on access.

static from_document(data, file_manager_client)#
Return type:

FileReference

id: str#
name: str#
open_bytes()#

Open the referenced file for reading binary content.

Return type:

Generator[IO[bytes], None, None]

open_text()#

Open the referenced file for reading text content.

Return type:

Generator[IO[str], None, None]

path: str#
read_bytes()#

Read the bytes of the referenced file.

Return type:

bytes

read_json()#

Read the JSON content of the referenced file.

Return type:

Union[dict, list]

read_text()#

Read the text content of the referenced file.

Return type:

str

class numerous.sdk.models.parameter.MapLocation(id, name, center)#

Bases: object

center: tuple[float, float]#
static from_document(data)#
Return type:

MapLocation

id: str#
name: str#
class numerous.sdk.models.parameter.Month(value)#

Bases: object

static from_document(data)#
Return type:

Month

value: int#
class numerous.sdk.models.parameter.Parameter(id, uuid, display_name, type, value)#

Bases: object

display_name: str#
static from_document(data, file_manager_client)#
Return type:

Parameter

id: str#
type: str#
uuid: str#
value: Any#
class numerous.sdk.models.parameter.Selection(id, value)#

Bases: object

static from_document(data)#
Return type:

Selection

id: str#
value: Union[str, float, int]#
class numerous.sdk.models.parameter.SimTimeUnit(value)#

Bases: Enum

An enumeration.

days = 'days'#
classmethod from_string(value_str)#
Return type:

SimTimeUnit

hours = 'hours'#
minutes = 'minutes'#
months = 'months'#
seconds = 'seconds'#
years = 'years'#
class numerous.sdk.models.parameter.TimeValue(total_seconds, unit, delta)#

Bases: object

delta: timedelta#
static from_document(data)#
Return type:

TimeValue

total_seconds: float#
unit: SimTimeUnit#
numerous.sdk.models.parameter.get_parameters_dict(data, file_manager_client)#
Return type:

dict[str, Parameter]

numerous.sdk.models.parameter.get_parameters_list(data, file_manager_client)#
Return type:

list[Parameter]

numerous.sdk.models.parameter.parse_value(data, file_manager_client)#
Return type:

Any