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
virtual std::string	description () const
	user facing description of this measure, defaults to empty
virtual std::string	taxonomy () const
	user facing BCL taxonomy of this measure, defaults to empty
virtual std::string	modeler_description () const
	user facing technical description of this measure, defaults to empty
MeasureType	measureType () const

Related Symbols
(Note that these are not member symbols.)
using	OptionalOSMeasure = boost::optional<OSMeasure>
using	OSMeasureVector = std::vector<OSMeasure>

Actions
virtual OS_DEPRECATED bool	registerWithSketchUp () const
	Register this script with SketchUp.
virtual OS_DEPRECATED bool	registerWithApplication () const
	Register this script with an Application.
	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

~OSMeasure()

virtual openstudio::measure::OSMeasure::~OSMeasure ( )

virtualdefault

OSMeasure()

openstudio::measure::OSMeasure::OSMeasure ( MeasureType measureType )

protected

Member Function Documentation

description()

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

virtual

user facing description of this measure, defaults to empty

measureType()

MeasureType openstudio::measure::OSMeasure::measureType

(

)

const

modeler_description()

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

virtual

user facing technical description of this measure, defaults to empty

name()

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

virtual

user facing name of this measure, defaults to empty

registerWithApplication()

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

registerWithSketchUp()

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

taxonomy()

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

virtual

user facing BCL taxonomy of this measure, defaults to empty

Friends And Related Symbol Documentation

OptionalOSMeasure

using OptionalOSMeasure = boost::optional<OSMeasure>

related

OSMeasureVector

using OSMeasureVector = std::vector<OSMeasure>

related