DPsim
Loading...
Searching...
No Matches
CPS::CIM::Reader Class Reference

Public Member Functions

 Reader (String name, Logger::Level logLevel=Logger::Level::info, Logger::Level componentLogLevel=Logger::Level::off)
 
SystemTopology loadCIM (Real systemFrequency, const fs::path &filename, Domain domain=Domain::DP, PhaseType phase=PhaseType::Single, GeneratorType genType=GeneratorType::None)
 Parses data from CIM files into the CPS data structure.
 
SystemTopology loadCIM (Real systemFrequency, const std::list< fs::path > &filenames, Domain domain=Domain::DP, PhaseType phase=PhaseType::Single, GeneratorType genType=GeneratorType::None)
 Parses data from CIM files into the CPS data structure.
 
SystemTopology loadCIM (Real systemFrequency, const std::list< CPS::String > &filenamesString, Domain domain=Domain::DP, PhaseType phase=PhaseType::Single, GeneratorType genType=GeneratorType::None)
 
void setShuntCapacitor (Real v)
 set shunt capacitor value
 
void setShuntConductance (Real v)
 set shunt conductance value
 
void useProtectionSwitches (Bool value=true)
 If set, some components like loads include protection switches.
 

Detailed Description

Definition at line 59 of file Reader.h.

Constructor & Destructor Documentation

◆ Reader()

Reader::Reader ( String name,
Logger::Level logLevel = Logger::Level::info,
Logger::Level componentLogLevel = Logger::Level::off )

Creates new reader with a name for logging. The first log level is for the reader and the second for the generated components.

Definition at line 21 of file Reader.cpp.

◆ ~Reader()

Reader::~Reader ( )
virtual

Definition at line 30 of file Reader.cpp.

Member Function Documentation

◆ loadCIM() [1/3]

SystemTopology Reader::loadCIM ( Real systemFrequency,
const fs::path & filename,
Domain domain = Domain::DP,
PhaseType phase = PhaseType::Single,
GeneratorType genType = GeneratorType::None )

Parses data from CIM files into the CPS data structure.

Definition at line 209 of file Reader.cpp.

◆ loadCIM() [2/3]

SystemTopology Reader::loadCIM ( Real systemFrequency,
const std::list< CPS::String > & filenamesString,
Domain domain = Domain::DP,
PhaseType phase = PhaseType::Single,
GeneratorType genType = GeneratorType::None )

Definition at line 32 of file Reader.cpp.

◆ loadCIM() [3/3]

SystemTopology Reader::loadCIM ( Real systemFrequency,
const std::list< fs::path > & filenames,
Domain domain = Domain::DP,
PhaseType phase = PhaseType::Single,
GeneratorType genType = GeneratorType::None )

Parses data from CIM files into the CPS data structure.

Definition at line 222 of file Reader.cpp.

◆ setShuntCapacitor()

void Reader::setShuntCapacitor ( Real v)

set shunt capacitor value

Definition at line 45 of file Reader.cpp.

◆ setShuntConductance()

void Reader::setShuntConductance ( Real v)

set shunt conductance value

Definition at line 50 of file Reader.cpp.

◆ useProtectionSwitches()

void Reader::useProtectionSwitches ( Bool value = true)

If set, some components like loads include protection switches.

Definition at line 56 of file Reader.cpp.


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