DSS C-API and dss.hpp
DSS C-API and dss.hpp expose a customized and extended implementation of OpenDSS to C and C++.
dss::classic::IFuses Class Reference
Inheritance diagram for dss::classic::IFuses:
[legend]
Collaboration diagram for dss::classic::IFuses:
[legend]

Public Member Functions

 IFuses (dss::APIUtil *util)
 
strings AllNames ()
 Array of strings with all Fuse names in the circuit.
 
int32_t Count ()
 Number of Fuse objects in active circuit.
 
int32_t First ()
 Sets the first Fuse active. More...
 
string Name ()
 Get the name of the current active Fuse.
 
IFusesName (const char *value)
 Sets the active Fuse by Name.
 
IFusesName (const string &value)
 
int32_t Next ()
 Sets the next Fuse active. More...
 
int32_t idx ()
 Get active Fuse by index; index is 1-based: 1..count.
 
void idx (int32_t value)
 Get active Fuse by index; index is 1-based: 1..count.
 
void Close ()
 Close all phases of the fuse.
 
bool IsBlown ()
 Current state of the fuses. More...
 
void Open ()
 Manual opening of all phases of the fuse.
 
void Reset ()
 Reset fuse to normal state.
 
double Delay ()
 A fixed delay time in seconds added to the fuse blowing time determined by the TCC curve. More...
 
IFusesDelay (double value)
 
string MonitoredObj ()
 Full name of the circuit element to which the fuse is connected.
 
IFusesMonitoredObj (const char *value)
 
IFusesMonitoredObj (const string &value)
 
int32_t MonitoredTerm ()
 Terminal number to which the fuse is connected.
 
IFusesMonitoredTerm (int32_t value)
 
int32_t NumPhases ()
 Number of phases, this fuse.
 
double RatedCurrent ()
 Multiplier or actual amps for the TCCcurve object. More...
 
IFusesRatedCurrent (double value)
 
string SwitchedObj ()
 Full name of the circuit element switch that the fuse controls. More...
 
IFusesSwitchedObj (const char *value)
 
IFusesSwitchedObj (const string &value)
 
int32_t SwitchedTerm ()
 Number of the terminal of the controlled element containing the switch controlled by the fuse.
 
IFusesSwitchedTerm (int32_t value)
 
string TCCcurve ()
 Name of the TCCcurve object that determines fuse blowing.
 
IFusesTCCcurve (const char *value)
 
IFusesTCCcurve (const string &value)
 
strings State ()
 Array of strings indicating the state of each phase of the fuse.
 
IFusesState (const strings &value)
 
strings NormalState ()
 Array of strings indicating the normal state of each phase of the fuse.
 
IFusesNormalState (const strings &value)
 
- Public Member Functions inherited from dss::ContextState
 ContextState (APIUtil *util)
 

Additional Inherited Members

- Public Attributes inherited from dss::ContextState
void * ctx
 Pointer to the DSSContext for easy access.
 
APIUtilapi_util
 API utility functions.
 

Member Function Documentation

◆ Delay()

double dss::classic::IFuses::Delay ( )
inline

A fixed delay time in seconds added to the fuse blowing time determined by the TCC curve.

Default is 0. This represents a fuse clear or other delay.

◆ First()

int32_t dss::classic::IFuses::First ( )
inline

Sets the first Fuse active.

Returns 0 if no more.

◆ IsBlown()

bool dss::classic::IFuses::IsBlown ( )
inline

Current state of the fuses.

TRUE if any fuse on any phase is blown. Else FALSE.

◆ Next()

int32_t dss::classic::IFuses::Next ( )
inline

Sets the next Fuse active.

Returns 0 if no more.

◆ RatedCurrent()

double dss::classic::IFuses::RatedCurrent ( )
inline

Multiplier or actual amps for the TCCcurve object.

Defaults to 1.0. Multiply current values of TCC curve by this to get actual amps.

◆ SwitchedObj()

string dss::classic::IFuses::SwitchedObj ( )
inline

Full name of the circuit element switch that the fuse controls.

Defaults to the MonitoredObj.


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