pytuflow.GisInputRunState

class GisInputRunState(build_state, context, parent)

Bases: InputRunState

Class for storing the run state of a GisInput.

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 (GisInputBase) – 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.
file_scope	Public function that will return the scope of a given file.
is_end_block	Returns whether this input is the end of a block.
is_match	Returns True if the input matches the search parameters, which is made of multiple parameters.
is_start_block	Returns whether this input is the start of a block.

Attributes

TUFLOW_TYPE	Return the TUFLOW type of the input.
comment
files
geoms
has_missing_files
lhs	Property holding the LHS string part of Command == Value
rhs	Property holding the value part of Command == Value.
scope	List of scopes associated with the object.
value	Property holding the value part of Command == Value.
bs	the BuildState object that the RunState object is based on.
attr_idx	index of the attribute column to use for the GIS input.
parent	the parent control file
cf	the loaded run state if the input is a control file or database.
uuid	A unique identifier for the input, set to the same as the BuildState UUID.
trd	The .trd file that this input is from.
config	Configuration object for the input.
part_count	The number of parts in the input command.
ctx	the context object that the RunState object is based on.