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

#include "PythonPluginInstance.hpp"

Inheritance diagram for openstudio::model::PythonPluginInstance:

Public Member Functions

 PythonPluginInstance (const ExternalFile &externalfile, const std::string &pluginClassName)
virtual ~PythonPluginInstance ()=default
ExternalFile externalFile () const
bool runDuringWarmupDays () const
bool isRunDuringWarmupDaysDefaulted () const
std::string pluginClassName () const
bool setRunDuringWarmupDays (bool runDuringWarmupDays)
void resetRunDuringWarmupDays ()
bool setPluginClassName (const std::string &pluginClassName)
bool findPluginClassNameInFile (const std::string &pluginClassName) const
std::vector< std::string > validPluginClassNamesInFile () const

Static Public Member Functions

static IddObjectType iddObjectType ()

Related Functions

using OptionalPythonPluginInstance = boost::optional< PythonPluginInstance >
using PythonPluginInstanceVector = std::vector< PythonPluginInstance >

Detailed Description

PythonPluginInstance is a ResourceObject that wraps the OpenStudio IDD object 'OS:PythonPlugin:Instance'.

Constructor & Destructor Documentation

openstudio::model::PythonPluginInstance::PythonPluginInstance ( const ExternalFile externalfile,
const std::string &  pluginClassName 
)
virtual openstudio::model::PythonPluginInstance::~PythonPluginInstance ( )
virtualdefault

Member Function Documentation

ExternalFile openstudio::model::PythonPluginInstance::externalFile ( ) const
bool openstudio::model::PythonPluginInstance::findPluginClassNameInFile ( const std::string &  pluginClassName) const

Helper that will return whether the pluginClassName can be found in the linked file.

static IddObjectType openstudio::model::PythonPluginInstance::iddObjectType ( )
static
bool openstudio::model::PythonPluginInstance::isRunDuringWarmupDaysDefaulted ( ) const
std::string openstudio::model::PythonPluginInstance::pluginClassName ( ) const
void openstudio::model::PythonPluginInstance::resetRunDuringWarmupDays ( )
bool openstudio::model::PythonPluginInstance::runDuringWarmupDays ( ) const
bool openstudio::model::PythonPluginInstance::setPluginClassName ( const std::string &  pluginClassName)
bool openstudio::model::PythonPluginInstance::setRunDuringWarmupDays ( bool  runDuringWarmupDays)
std::vector<std::string> openstudio::model::PythonPluginInstance::validPluginClassNamesInFile ( ) const

Friends And Related Function Documentation

using OptionalPythonPluginInstance = boost::optional<PythonPluginInstance>
related
using PythonPluginInstanceVector = std::vector<PythonPluginInstance>
related