OpenSWMM Engine  6.0.0-alpha.1
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.1)
Loading...
Searching...
No Matches
openswmm::climate::ClimateFileReader Class Reference

#include <ClimateFile.hpp>

Collaboration diagram for openswmm::climate::ClimateFileReader:

Public Member Functions

 ClimateFileReader ()=default
 
 ~ClimateFileReader ()
 
 ClimateFileReader (const ClimateFileReader &)=delete
 
ClimateFileReaderoperator= (const ClimateFileReader &)=delete
 
bool open (const std::string &path, double start_oa_date, int unit_system)
 
void close ()
 Close file and release resources.
 
bool getRecord (double oa_date, DailyClimateRecord &rec)
 
ClimateFileFormat format () const
 Detected file format.
 
bool isOpen () const
 True if file is open and valid.
 

Constructor & Destructor Documentation

◆ ClimateFileReader() [1/2]

openswmm::climate::ClimateFileReader::ClimateFileReader ( )
default

◆ ~ClimateFileReader()

openswmm::climate::ClimateFileReader::~ClimateFileReader ( )
Here is the call graph for this function:

◆ ClimateFileReader() [2/2]

openswmm::climate::ClimateFileReader::ClimateFileReader ( const ClimateFileReader )
delete

Member Function Documentation

◆ close()

void openswmm::climate::ClimateFileReader::close ( )

Close file and release resources.

Here is the caller graph for this function:

◆ format()

ClimateFileFormat openswmm::climate::ClimateFileReader::format ( ) const
inline

Detected file format.

◆ getRecord()

bool openswmm::climate::ClimateFileReader::getRecord ( double  oa_date,
DailyClimateRecord rec 
)

Get the daily climate record for a OADate (days since 12/30/1899). Automatically buffers the month if needed.

Parameters
oa_dateOADate (days since 12/30/1899) (e.g. from DateTime).
[out]recOutput record.
Returns
true if data was found, false if date is out of range.

◆ isOpen()

bool openswmm::climate::ClimateFileReader::isOpen ( ) const
inline

True if file is open and valid.

◆ open()

bool openswmm::climate::ClimateFileReader::open ( const std::string &  path,
double  start_oa_date,
int  unit_system 
)

Open file and detect format. Returns false on error.

Parameters
pathFile path.
start_oa_dateStart date (OADate) — skip data before this date.
unit_system0 = US, 1 = SI.
Here is the call graph for this function:

◆ operator=()

ClimateFileReader & openswmm::climate::ClimateFileReader::operator= ( const ClimateFileReader )
delete

The documentation for this class was generated from the following files: