OpenStudio:utilities
Loading...
Searching...
No Matches
openstudio::OSOptionalQuantity Class Reference

#include <OSOptionalQuantity.hpp>

Public Member Functions

Constructors and Destructors
 OSOptionalQuantity (const UnitSystem &sys=UnitSystem::Mixed)
 
 OSOptionalQuantity (const Unit &units)
 
 OSOptionalQuantity (const Quantity &quantity)
 
 OSOptionalQuantity (const OSOptionalQuantity &oq)
 
OSOptionalQuantityoperator= (const OSOptionalQuantity &oq)
 

Getters and Queries

bool empty () const
 Returns true if there is no value.
 
bool isSet () const
 Returns true if there is a value.
 
Quantity get () const
 Returns the corresponding Quantity.
 
Unit units () const
 Returns a clone of this object's units.
 

Detailed Description

OSOptionalQuantity class to be used in OpenStudio ModelObject properties.

Always contains a Unit. Optionally contains a value. The constructors and assignment operator ensure that this class behaves as "plain old data" (POD) by cloning any units information (to avoid multiple objects pointing to the exact same unit data).

Constructor & Destructor Documentation

◆ OSOptionalQuantity() [1/4]

openstudio::OSOptionalQuantity::OSOptionalQuantity ( const UnitSystem & sys = UnitSystem::Mixed)
explicit

◆ OSOptionalQuantity() [2/4]

openstudio::OSOptionalQuantity::OSOptionalQuantity ( const Unit & units)
explicit

◆ OSOptionalQuantity() [3/4]

openstudio::OSOptionalQuantity::OSOptionalQuantity ( const Quantity & quantity)

◆ OSOptionalQuantity() [4/4]

openstudio::OSOptionalQuantity::OSOptionalQuantity ( const OSOptionalQuantity & oq)

Member Function Documentation

◆ empty()

bool openstudio::OSOptionalQuantity::empty ( ) const

Returns true if there is no value.

◆ get()

Quantity openstudio::OSOptionalQuantity::get ( ) const

Returns the corresponding Quantity.

Throws if empty().

◆ isSet()

bool openstudio::OSOptionalQuantity::isSet ( ) const

Returns true if there is a value.

◆ operator=()

OSOptionalQuantity & openstudio::OSOptionalQuantity::operator= ( const OSOptionalQuantity & oq)

◆ units()

Unit openstudio::OSOptionalQuantity::units ( ) const

Returns a clone of this object's units.