r.a.ExecutionProgress(object) : class documentation

Part of reven.api View In Hierarchy

Execution progress.

Method __init__ Initialize an ExecutionProgress instance from a low-level object. Not meant to be called directly.
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: A text description of the progress.
Method __repr__ Undocumented
def __init__(self, rvn, rvn_progress):

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

Use Project.execution_status instead.

ParametersrvnA reven_api.reven_connection instance.
rvn_progressA reven_api.analysis_progress instance.
RaisesRuntimeErrorIf the connection is lost, in case of bad input, or in case of internal service error.
Unknown Field: noraisereven_api.ServiceNotAllowedDuringExecutionErrorthe 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: A text description of the progress.

def __repr__(self):
Undocumented
API Documentation for reven, generated by pydoctor at 2017-07-13 16:50:42.