OpenSWMM Engine  6.0.0-alpha.4
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
openswmm::ProcessComponentSpec Struct Reference

One row of [PROCESS_COMPONENTS] (Unified Transport suite, D-UT8). More...

#include <SimulationContext.hpp>

Collaboration diagram for openswmm::ProcessComponentSpec:

Public Attributes

std::string id
 Component id (or library path — HC2)
 
std::string config_path
 config="…" argument (may be empty)
 
std::vector< std::pair< std::string, std::string > > args
 other key/value args
 
std::string resolved_config_path
 

Detailed Description

One row of [PROCESS_COMPONENTS] (Unified Transport suite, D-UT8).

id is a registered component id (e.g. org.hydrocouple.openswmm.reactions) or — reserved for the HC2 phase — a shared-library path exporting hydrocouple_component_info(). config_path is the component's external configuration file (the config="…" argument), resolved relative to the parent .inp per the [2D_MESH_FILE] rules. args holds any further key="value" pairs verbatim.

See also
plans/transport/TRANSPORT_IO_PLUGIN_CONFIG_PLAN.md §2

Member Data Documentation

◆ args

std::vector<std::pair<std::string, std::string> > openswmm::ProcessComponentSpec::args

other key/value args

◆ config_path

std::string openswmm::ProcessComponentSpec::config_path

config="…" argument (may be empty)

◆ id

std::string openswmm::ProcessComponentSpec::id

Component id (or library path — HC2)

◆ resolved_config_path

std::string openswmm::ProcessComponentSpec::resolved_config_path

Effective path the config was READ from (set by resolve_process_components; empty until then). IO3 uses it to copy the config file alongside a save-as so relative references never dangle in the destination directory.


The documentation for this struct was generated from the following file: