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

Two-string carrier for any external file path that appears in a SWMM .inp file. More...

#include <FilePathPair.hpp>

Collaboration diagram for openswmm::gpkg::FilePathPair:

Public Member Functions

 FilePathPair ()=default
 
 FilePathPair (const FilePathPair &)=default
 
 FilePathPair (FilePathPair &&) noexcept=default
 
 FilePathPair (const std::string &s)
 
 FilePathPair (std::string &&s) noexcept
 
 FilePathPair (const char *s)
 
FilePathPairoperator= (const FilePathPair &)=default
 
FilePathPairoperator= (FilePathPair &&) noexcept=default
 
FilePathPairoperator= (const std::string &s)
 
FilePathPairoperator= (std::string &&s) noexcept
 
FilePathPairoperator= (const char *s)
 
 operator const std::string & () const noexcept
 
bool empty () const noexcept
 
std::size_t size () const noexcept
 
const char * c_str () const noexcept
 
const std::string & str () const noexcept
 

Public Attributes

std::string absolute
 
std::string original
 

Friends

bool operator== (const FilePathPair &a, const FilePathPair &b)
 
bool operator== (const FilePathPair &a, const std::string &s)
 
bool operator== (const std::string &s, const FilePathPair &a)
 
bool operator== (const FilePathPair &a, const char *s)
 
bool operator== (const char *s, const FilePathPair &a)
 
bool operator!= (const FilePathPair &a, const FilePathPair &b)
 
bool operator!= (const FilePathPair &a, const std::string &s)
 
bool operator!= (const std::string &s, const FilePathPair &a)
 
bool operator!= (const FilePathPair &a, const char *s)
 
bool operator!= (const char *s, const FilePathPair &a)
 

Detailed Description

Two-string carrier for any external file path that appears in a SWMM .inp file.

Each slot carries:

  • absolute: resolved absolute path, ready for fopen(). Filled by PostParseResolver after read; empty for programmatic models until a path-set call runs.
  • original: verbatim token as it appeared in the source .inp file (relative or absolute, with whichever separators the author used). Empty for models that were not loaded from an .inp.

Slice IO-2 keeps every existing caller working through an implicit std::string surface that targets original. Slice IO-3 wires PostParseResolver to populate absolute; Slice IO-4 wires the writer to rebase original against the destination directory.

Constructor & Destructor Documentation

◆ FilePathPair() [1/6]

openswmm::FilePathPair::FilePathPair ( )
default

◆ FilePathPair() [2/6]

openswmm::FilePathPair::FilePathPair ( const FilePathPair & )
default

◆ FilePathPair() [3/6]

openswmm::FilePathPair::FilePathPair ( FilePathPair && )
defaultnoexcept

◆ FilePathPair() [4/6]

openswmm::FilePathPair::FilePathPair ( const std::string & s)
inline

◆ FilePathPair() [5/6]

openswmm::FilePathPair::FilePathPair ( std::string && s)
inlinenoexcept

◆ FilePathPair() [6/6]

openswmm::FilePathPair::FilePathPair ( const char * s)
inline

Member Function Documentation

◆ c_str()

const char * openswmm::FilePathPair::c_str ( ) const
inlinenodiscardnoexcept

◆ empty()

bool openswmm::FilePathPair::empty ( ) const
inlinenodiscardnoexcept

◆ operator const std::string &()

openswmm::FilePathPair::operator const std::string & ( ) const
inlinenoexcept

◆ operator=() [1/5]

FilePathPair & openswmm::FilePathPair::operator= ( const char * s)
inline

◆ operator=() [2/5]

FilePathPair & openswmm::FilePathPair::operator= ( const FilePathPair & )
default

◆ operator=() [3/5]

FilePathPair & openswmm::FilePathPair::operator= ( const std::string & s)
inline

◆ operator=() [4/5]

FilePathPair & openswmm::FilePathPair::operator= ( FilePathPair && )
defaultnoexcept

◆ operator=() [5/5]

FilePathPair & openswmm::FilePathPair::operator= ( std::string && s)
inlinenoexcept

◆ size()

std::size_t openswmm::FilePathPair::size ( ) const
inlinenodiscardnoexcept

◆ str()

const std::string & openswmm::FilePathPair::str ( ) const
inlinenodiscardnoexcept

Friends And Related Symbol Documentation

◆ operator!= [1/5]

bool operator!= ( const char * s,
const FilePathPair & a )
friend

◆ operator!= [2/5]

bool operator!= ( const FilePathPair & a,
const char * s )
friend

◆ operator!= [3/5]

bool operator!= ( const FilePathPair & a,
const FilePathPair & b )
friend

◆ operator!= [4/5]

bool operator!= ( const FilePathPair & a,
const std::string & s )
friend

◆ operator!= [5/5]

bool operator!= ( const std::string & s,
const FilePathPair & a )
friend

◆ operator== [1/5]

bool operator== ( const char * s,
const FilePathPair & a )
friend

◆ operator== [2/5]

bool operator== ( const FilePathPair & a,
const char * s )
friend

◆ operator== [3/5]

bool operator== ( const FilePathPair & a,
const FilePathPair & b )
friend

◆ operator== [4/5]

bool operator== ( const FilePathPair & a,
const std::string & s )
friend

◆ operator== [5/5]

bool operator== ( const std::string & s,
const FilePathPair & a )
friend

Member Data Documentation

◆ absolute

std::string openswmm::FilePathPair::absolute

◆ original

std::string openswmm::FilePathPair::original

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