reven.api.ExecutionProgress : API documentation

Method	__init__	Initialize an ExecutionProgress instance from its low-level fields. Not meant to be called directly.
Class Method	from_rvn	Initialize an ExecutionProgress instance from a low-level connection. Not meant to be called directly.
Class Method	from_license_error	Undocumented
Method	is_busy	Property: Whether or not the execution is busy (running).
Method	is_done	Property: Whether or not the execution is done, whether it's from an execution or a load.
Method	is_awaiting_configuration	Property: Whether or not the project has no execution yet, and is waiting for configuration and start.
Method	last_tsc	Property: Last timestamp counter recorded in the scenario.
Method	tsc	Property: Current execution timestamp counter.
Method	point_index	Property: Current execution point index.
Method	last_point_index	Property: Max execution point index configured if such a max is configured, None otherwise.
Method	status	Property: Returns the current status (awaiting configuration, busy, done) as text. Returned values are either "Busy", "Done", or "Awaiting configuration"
Method	text	Property: Text message contained in the progress, if any.
Method	__repr__	Undocumented
Method	__str__	Undocumented
Static Method	_try_execution_started	Determines whether or not the execution was started at some point, by attempting to get the number of runs.

def __init__(self, execution_started, rvn_progress):

Initialize an ExecutionProgress instance from its low-level fields. Not meant to be called directly.

Use Project.execution_status instead.

Parameters	execution_started	`Boolean` indicating whether or not the execution was started at some point.
	rvn_progress	`reven_api.analysis_progress` instance corresponding to the current progress.

@classmethod
def from_rvn(cls, rvn):

Initialize an ExecutionProgress instance from a low-level connection. Not meant to be called directly.

Use Project.execution_status instead.

Parameters	rvn	A `reven_api.reven_connection` instance.
Raises	RuntimeError	If the connection is lost, in case of bad input, or in case of internal service error.

@classmethod
def from_license_error(cls, license_error):

Undocumented

@staticmethod
def _try_execution_started(rvn):

Determines whether or not the execution was started at some point, by attempting to get the number of runs.

Once this returns True for a given server, subsequent calls should always return True.

Parameters	rvn	A `reven_api.reven_connection` instance.
Raises	RuntimeError	If the connection is lost, in case of bad input, or in case of internal service error.
Unknown Field: noraise	reven_api.ServiceNotAllowedDuringExecutionError	the exception is caught in the method

@property
def is_busy(self):

Property: Whether or not the execution is busy (running).

@property
def is_done(self):

Property: Whether or not the execution is done, whether it's from an execution or a load.

@property
def is_awaiting_configuration(self):

Property: Whether or not the project has no execution yet, and is waiting for configuration and start.

@property
def last_tsc(self):

Property: Last timestamp counter recorded in the scenario.

@property
def tsc(self):

Property: Current execution timestamp counter.

@property
def point_index(self):

Property: Current execution point index.

@property
def last_point_index(self):

Property: Max execution point index configured if such a max is configured, None otherwise.

@property
def status(self):

Property: Returns the current status (awaiting configuration, busy, done) as text. Returned values are either "Busy", "Done", or "Awaiting configuration"

@property
def text(self):

Property: Text message contained in the progress, if any.

Returns

A non-empty string, or None

It is typically written in Axion's execution progress window.

For instance, contains the "Reven is being finalized, please wait..." message that is visible after a pause has been requested, and the currently executed symbol.

def __repr__(self):

Undocumented

def __str__(self):

Undocumented

reven.api.ExecutionProgress(object) class documentation

`reven.api.ExecutionProgress(object)` class documentation