OpenStudio:measure
 All Classes Namespaces Functions Typedefs Enumerations Enumerator Pages
Related Functions | List of all members
openstudio::measure::OSMeasure Class Reference

#include <OSMeasure.hpp>

+ Inheritance diagram for openstudio::measure::OSMeasure:

Public Member Functions

Constructors and Destructors
virtual ~OSMeasure ()=default
 
Getters
virtual std::string name () const
 user facing name of this measure, defaults to empty More...
 
virtual std::string description () const
 user facing description of this measure, defaults to empty More...
 
virtual std::string taxonomy () const
 user facing BCL taxonomy of this measure, defaults to empty More...
 
virtual std::string modeler_description () const
 user facing technical description of this measure, defaults to empty More...
 
MeasureType measureType () const
 

Related Functions

(Note that these are not member functions.)

using OptionalOSMeasure = boost::optional< OSMeasure >
 
using OSMeasureVector = std::vector< OSMeasure >
 

Actions

virtual OS_DEPRECATED bool registerWithSketchUp () const
 Register this script with SketchUp. More...
 
virtual OS_DEPRECATED bool registerWithApplication () const
 Register this script with an Application. More...
 
 OSMeasure (MeasureType measureType)
 

Detailed Description

OSMeasure is an abstract base class for a user script.

There are derived types that operate on OpenStudio Models and EnergyPlus Workspaces.

Constructor & Destructor Documentation

virtual openstudio::measure::OSMeasure::~OSMeasure ( )
virtualdefault
openstudio::measure::OSMeasure::OSMeasure ( MeasureType  measureType)
protected

Member Function Documentation

virtual std::string openstudio::measure::OSMeasure::description ( ) const
virtual

user facing description of this measure, defaults to empty

MeasureType openstudio::measure::OSMeasure::measureType ( ) const
virtual std::string openstudio::measure::OSMeasure::modeler_description ( ) const
virtual

user facing technical description of this measure, defaults to empty

virtual std::string openstudio::measure::OSMeasure::name ( ) const
virtual

user facing name of this measure, defaults to empty

virtual OS_DEPRECATED bool openstudio::measure::OSMeasure::registerWithApplication ( ) const
virtual

Register this script with an Application.

Base class implementation does nothing and returns false.

Deprecated:
virtual OS_DEPRECATED bool openstudio::measure::OSMeasure::registerWithSketchUp ( ) const
virtual

Register this script with SketchUp.

Deprecated in favor of registerWithApplication(). Base class implementation does nothing and returns false.

Deprecated:
virtual std::string openstudio::measure::OSMeasure::taxonomy ( ) const
virtual

user facing BCL taxonomy of this measure, defaults to empty

Friends And Related Function Documentation

using OptionalOSMeasure = boost::optional<OSMeasure>
related
using OSMeasureVector = std::vector<OSMeasure>
related