ostk.physics.data.Manifest

class Manifest

Bases: pybind11_object

Data class for the OSTk Data Manifest.

Methods

find_remote_data_urls	Return remote data URLs the for data items matching the given name regex string.
get_last_modified_timestamp	Get last update timestamp.
get_last_update_timestamp_for	Get last update timestamp for data.
get_next_update_check_timestamp_for	Get next update check timestamp for data.
get_remote_data_urls	Get the remote data URL for a given data name.
is_defined	Check if the manifest is defined.
load	Load a manifest from a file.
undefined	Create an undefined manifest.

find_remote_data_urls(

self: ostk.physics.data.Manifest,

base_url: ostk.io.URL,

data_name_regex_pattern: ostk.core.type.String,

) → list[ostk.io.URL]

Return remote data URLs the for data items matching the given name regex string.

Parameters:

• base_url (URL) -- A base URL for remote data.

• data_name_regex_pattern (String) -- A data name regex string.

Returns:

List of remote data URLs.

Return type:

list[URL]

get_last_modified_timestamp(

self: ostk.physics.data.Manifest,

) → ostk.physics.time.Instant

Get last update timestamp.

Returns:

Instant indicating when the manifest was last updated based on file modification time.

Return type:

Instant

get_last_update_timestamp_for(

self: ostk.physics.data.Manifest,

data_name: ostk.core.type.String,

) → ostk.physics.time.Instant

Get last update timestamp for data.

Parameters:

data_name (String) -- A data name.

Returns:

Last update instant for data.

Return type:

Instant

get_next_update_check_timestamp_for(

self: ostk.physics.data.Manifest,

data_name: ostk.core.type.String,

) → ostk.physics.time.Instant

Get next update check timestamp for data.

Parameters:

data_name (String) -- A data name.

Returns:

Next update check instant for data.

Return type:

Instant

get_remote_data_urls(

self: ostk.physics.data.Manifest,

base_url: ostk.io.URL,

data_name: ostk.core.type.String,

) → list[ostk.io.URL]

Get the remote data URL for a given data name.

Parameters:

• base_url (URL) -- A base URL for remote data.

• data_name (String) -- Name of the data. i.e. the key for the data entry in the manifest.

Returns:

List of remote data URLs.

Return type:

list[URL]

is_defined(self: ostk.physics.data.Manifest) → bool

Check if the manifest is defined.

Returns:

True if defined.

Return type:

bool

static load(file: ostk.core.filesystem.File) → ostk.physics.data.Manifest

Load a manifest from a file.

Parameters:

file (File) -- A manifest file.

Returns:

Manifest.

Return type:

Manifest

static undefined() → ostk.physics.data.Manifest

Create an undefined manifest.

Returns:

Undefined manifest.

Return type:

Manifest