OpenStudio:model
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages

#include "OutputTableSummaryReports.hpp"

Inheritance diagram for openstudio::model::OutputTableSummaryReports:

Public Member Functions

virtual ~OutputTableSummaryReports ()=default
 OutputTableSummaryReports (const OutputTableSummaryReports &other)=default
 OutputTableSummaryReports (OutputTableSummaryReports &&other)=default
OutputTableSummaryReportsoperator= (const OutputTableSummaryReports &)=default
OutputTableSummaryReportsoperator= (OutputTableSummaryReports &&)=default
std::vector< std::string > summaryReports () const
unsigned int numberofSummaryReports () const
boost::optional< unsigned > summaryReportIndex (const std::string &summaryReport) const
boost::optional< std::string > getSummaryReport (unsigned groupIndex) const
bool addSummaryReport (const std::string &summaryReport)
bool addSummaryReports (const std::vector< std::string > &summaryReports)
bool removeSummaryReport (int groupIndex)
void removeAllSummaryReports ()
bool enableAllSummaryReport ()

Static Public Member Functions

static IddObjectType iddObjectType ()
static std::vector< std::string > summaryReportValues ()
static std::vector< std::string > validSummaryReportValues ()

Protected Member Functions

 OutputTableSummaryReports (Model &model)

Related Functions

using OptionalOutputTableSummaryReports = boost::optional< OutputTableSummaryReports >
using OutputTableSummaryReportsVector = std::vector< OutputTableSummaryReports >

Detailed Description

OutputTableSummaryReports is a ModelObject that wraps the OpenStudio IDD object 'OS:Output:Table:SummaryReports'.

Constructor & Destructor Documentation

virtual openstudio::model::OutputTableSummaryReports::~OutputTableSummaryReports ( )
virtualdefault
openstudio::model::OutputTableSummaryReports::OutputTableSummaryReports ( const OutputTableSummaryReports other)
default
openstudio::model::OutputTableSummaryReports::OutputTableSummaryReports ( OutputTableSummaryReports &&  other)
default
openstudio::model::OutputTableSummaryReports::OutputTableSummaryReports ( Model model)
explicitprotected

Member Function Documentation

bool openstudio::model::OutputTableSummaryReports::addSummaryReport ( const std::string &  summaryReport)
bool openstudio::model::OutputTableSummaryReports::addSummaryReports ( const std::vector< std::string > &  summaryReports)
bool openstudio::model::OutputTableSummaryReports::enableAllSummaryReport ( )
boost::optional<std::string> openstudio::model::OutputTableSummaryReports::getSummaryReport ( unsigned  groupIndex) const
static IddObjectType openstudio::model::OutputTableSummaryReports::iddObjectType ( )
static
unsigned int openstudio::model::OutputTableSummaryReports::numberofSummaryReports ( ) const
OutputTableSummaryReports& openstudio::model::OutputTableSummaryReports::operator= ( const OutputTableSummaryReports )
default
OutputTableSummaryReports& openstudio::model::OutputTableSummaryReports::operator= ( OutputTableSummaryReports &&  )
default
void openstudio::model::OutputTableSummaryReports::removeAllSummaryReports ( )
bool openstudio::model::OutputTableSummaryReports::removeSummaryReport ( int  groupIndex)
boost::optional<unsigned> openstudio::model::OutputTableSummaryReports::summaryReportIndex ( const std::string &  summaryReport) const

If a summaryReport group is already present (cf summaryReportIndex()), it will Warn.

std::vector<std::string> openstudio::model::OutputTableSummaryReports::summaryReports ( ) const
static std::vector<std::string> openstudio::model::OutputTableSummaryReports::summaryReportValues ( )
static
static std::vector<std::string> openstudio::model::OutputTableSummaryReports::validSummaryReportValues ( )
static

Friends And Related Function Documentation