pytuflow.ControlFileRunState

class ControlFileRunState(build_state, context, parent)

Bases: RunState, ControlFile

Class for storing the run state of a control file.

This class should not be instantiated directly, but rather it should be created from an instance of a BuildState class using the context method of the BuildState class.

Parameters:

• build_state (ControlFileBuildState) – The BuildState object that the RunState object is based on.

• context (Context) – The context object that the RunState object is based on.

• parent (ControlFileRunState) – The parent control file run state.

__init__(build_state, context, parent)

Parameters:

• build_state (BuildState) – The BuildState object that the RunState object is based on.

• context (Context) – The context object that the RunState object is based on.

• parent (ControlFile) – The parent control file.

Methods

context	Returns the ScopeList that makes up the objects Context for the given RunState Object.
find_input	Find a particular input(s) using a search filter.
input	Returns the input with the given UUID.

Attributes

TUFLOW_TYPE	Return the TUFLOW type of the input.
scope	List of scopes associated with the object.
tcf	The parent TCF control file object
bs	the BuildState object that the RunState object is based on.
parent	the parent control file
fpath	the path to the control file
config	the configuration settings for the model.
inputs	list of inputs and comments in the control file
loaded	whether the control file has been loaded from disk or not.
ctx	the context object that the RunState object is based on.