deltaFlow
Reader Class Referenceabstract

Abstract reader interface for power system input formats. More...

#include <Reader.H>

Inheritance diagram for Reader:
Collaboration diagram for Reader:

Public Member Functions

virtual ~Reader ()=default
 Virtual destructor.
 
virtual void read (const std::string &filename)=0
 Read and parse the input file.
 
const BusDatagetBusData () const noexcept
 Get the parsed bus data.
 
const BranchDatagetBranchData () const noexcept
 Get the parsed branch data.
 

Protected Attributes

BusData busData
 Parsed bus data.
 
BranchData branchData
 Parsed branch data.
 

Detailed Description

Abstract reader interface for power system input formats.

Subclasses implement the read() method for specific file formats (e.g., IEEE Common Data Format, PSS/E Raw).

Definition at line 40 of file Reader.H.

Constructor & Destructor Documentation

◆ ~Reader()

virtual Reader::~Reader ( )
virtualdefault

Virtual destructor.

Member Function Documentation

◆ getBranchData()

const BranchData & Reader::getBranchData ( ) const
noexcept

Get the parsed branch data.

Returns
Const reference to BranchData.

Definition at line 32 of file Reader.C.

32 {
33 return this->branchData;
34}
BranchData branchData
Parsed branch data.
Definition Reader.H:65

References branchData.

◆ getBusData()

const BusData & Reader::getBusData ( ) const
noexcept

Get the parsed bus data.

Returns
Const reference to BusData.

Definition at line 28 of file Reader.C.

28 {
29 return this->busData;
30}
BusData busData
Parsed bus data.
Definition Reader.H:64

References busData.

◆ read()

virtual void Reader::read ( const std::string &  filename)
pure virtual

Read and parse the input file.

Parameters
filenamePath to the input data file.

Implemented in IEEECommonDataFormat, and PSSERawFormat.

Member Data Documentation

◆ branchData

BranchData Reader::branchData
protected

Parsed branch data.

Definition at line 65 of file Reader.H.

◆ busData

BusData Reader::busData
protected

Parsed bus data.

Definition at line 64 of file Reader.H.


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