OutputFileCommon Namespace Reference

Small pieces of business/formatting logic shared by all OutputFile writers. More...

Classes
struct	BusTotals
	Aggregate bus totals (load/gen) used in the bus-data result tables. More...
struct	BusTypeCounts
	Bus type counts (Slack/PV/PQ). More...

Functions
std::string	hostname ()
	Returns the current hostname.
std::string	timestamp ()
	Returns the current timestamp string.
std::string	dateStr ()
	Returns the current date string.
std::string	timeStr ()
	Returns the current time string.
BusTypeCounts	countBusTypes (const BusData &busData)
	Counts buses by type (1=Slack, 2=PV, else PQ).
BusTotals	computeBusTotals (const BusData &busData)
	Computes total load/gen/injected Mvar across all buses.

Detailed Description

Small pieces of business/formatting logic shared by all OutputFile writers.

Function Documentation

computeBusTotals()

BusTotals OutputFileCommon::computeBusTotals ( const BusData &  busData )

inline

Computes total load/gen/injected Mvar across all buses.

Definition at line 119 of file OutputFileCommon.H.

                                                              {
        BusTotals t;
        t.totalPl = busData.Pl.sum();
        t.totalQl = busData.Ql.sum();
        t.totalPg = busData.Pg.sum();
        t.totalQg = busData.Qg.sum();
        t.totalInjected = t.totalQg - t.totalQl;
        return t;
    }

References BusData::Pg, BusData::Pl, BusData::Qg, BusData::Ql, OutputFileCommon::BusTotals::totalInjected, OutputFileCommon::BusTotals::totalPg, OutputFileCommon::BusTotals::totalPl, OutputFileCommon::BusTotals::totalQg, and OutputFileCommon::BusTotals::totalQl.

Here is the caller graph for this function:

countBusTypes()

BusTypeCounts OutputFileCommon::countBusTypes ( const BusData &  busData )

inline

Counts buses by type (1=Slack, 2=PV, else PQ).

Definition at line 98 of file OutputFileCommon.H.

                                                               {
        BusTypeCounts counts;
        int nBus = static_cast<int>(busData.Type.size());
        for (int i = 0; i < nBus; ++i) {
            if (busData.Type(i) == 1) counts.nSlack++;
            else if (busData.Type(i) == 2) counts.nPV++;
            else counts.nPQ++;
        }
        return counts;
    }

References OutputFileCommon::BusTypeCounts::nPQ, OutputFileCommon::BusTypeCounts::nPV, OutputFileCommon::BusTypeCounts::nSlack, and BusData::Type.

Here is the caller graph for this function:

dateStr()

std::string OutputFileCommon::dateStr ( )

inline

Returns the current date string.

Definition at line 79 of file OutputFileCommon.H.

                               {
        auto now = std::time(nullptr);
        return fmt::format("{:%d-%b-%Y}", fmt::localtime(now));
    }

Here is the caller graph for this function:

hostname()

std::string OutputFileCommon::hostname ( )

inline

Returns the current hostname.

Definition at line 60 of file OutputFileCommon.H.

                                {
    #ifdef _WIN32
        char buf[MAX_COMPUTERNAME_LENGTH + 1];
        DWORD bufLen = sizeof(buf);
        if (GetComputerNameA(buf, &bufLen)) return std::string(buf);
    #else
        char buf[256];
        if (gethostname(buf, sizeof(buf)) == 0) return std::string(buf);
    #endif
        return "unknown";
    }

Here is the caller graph for this function:

timestamp()

std::string OutputFileCommon::timestamp ( )

inline

Returns the current timestamp string.

Definition at line 73 of file OutputFileCommon.H.

                                 {
        auto now = std::time(nullptr);
        return fmt::format("{:%d-%b-%Y  %H:%M:%S}", fmt::localtime(now));
    }

Here is the caller graph for this function:

timeStr()

std::string OutputFileCommon::timeStr ( )

inline

Returns the current time string.

Definition at line 85 of file OutputFileCommon.H.

                               {
        auto now = std::time(nullptr);
        return fmt::format("{:%H:%M:%S}", fmt::localtime(now));
    }

Here is the caller graph for this function: