OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Static Public Member Functions | Related Functions | List of all members
openstudio::model::LifeCycleCostParameters Class Reference

#include <LifeCycleCostParameters.hpp>

+ Inheritance diagram for openstudio::model::LifeCycleCostParameters:

Public Member Functions

Setters
bool setAnalysisType (const std::string &analysisType)
 
void resetAnalysisType ()
 
bool setDiscountingConvention (const std::string &discountingConvention)
 
void resetDiscountingConvention ()
 
bool setInflationApproach (const std::string &inflationApproach)
 
void resetInflationApproach ()
 
bool setRealDiscountRate (double realDiscountRate)
 This cannot be set when analysis type is FEMP or when inflation approach is "CurrentDollar". More...
 
bool setNominalDiscountRate (double nominalDiscountRate)
 This cannot be set when analysis type is FEMP or when inflation approach is "ConstantDollar". More...
 
bool setInflation (double inflation)
 This cannot be set when analysis type is FEMP or when inflation approach is "ConstantDollar". More...
 
bool setBaseDateMonth (const MonthOfYear &baseDateMonth)
 
void resetBaseDateMonth ()
 
bool setBaseDateYear (int baseDateYear)
 
void resetBaseDateYear ()
 
bool setServiceDateMonth (const MonthOfYear &serviceDateMonth)
 
void resetServiceDateMonth ()
 
bool setServiceDateYear (int serviceDateYear)
 
void resetServiceDateYear ()
 
bool setLengthOfStudyPeriodInYears (int lengthOfStudyPeriodInYears)
 This cannot be set greater than 25 years when analysis type is FEMP. More...
 
void resetLengthOfStudyPeriodInYears ()
 
bool setTaxRate (double taxRate)
 
void resetTaxRate ()
 
bool setDepreciationMethod (const std::string &depreciationMethod)
 
void resetDepreciationMethod ()
 
bool setUseNISTFuelEscalationRates (bool useNISTFuelEscalationRates)
 This cannot be set when analysis type is FEMP. More...
 
void resetUseNISTFuelEscalationRates ()
 
bool setNISTRegion (const std::string &nistRegion)
 This cannot be set when use NIST fuel escalation rates is false. More...
 
void resetNISTRegion ()
 
bool setNISTSector (const std::string &nistSector)
 This cannot be set when use NIST fuel escalation rates is false. More...
 
void resetNISTSector ()
 
bool setElectricityInflation (double electricityInflation)
 This cannot be set when use NIST fuel escalation rates is true. More...
 
void resetElectricityInflation ()
 
bool setNaturalGasInflation (double naturalGasInflation)
 This cannot be set when use NIST fuel escalation rates is true. More...
 
void resetNaturalGasInflation ()
 
bool setSteamInflation (double steamInflation)
 This cannot be set when use NIST fuel escalation rates is true. More...
 
void resetSteamInflation ()
 
bool setGasolineInflation (double gasolineInflation)
 This cannot be set when use NIST fuel escalation rates is true. More...
 
void resetGasolineInflation ()
 
bool setDieselInflation (double dieselInflation)
 This cannot be set when use NIST fuel escalation rates is true. More...
 
void resetDieselInflation ()
 
bool setCoalInflation (double coalInflation)
 This cannot be set when use NIST fuel escalation rates is true. More...
 
void resetCoalInflation ()
 
bool setFuelOil1Inflation (double fuelOil1Inflation)
 This cannot be set when use NIST fuel escalation rates is true. More...
 
void resetFuelOil1Inflation ()
 
bool setFuelOil2Inflation (double fuelOil2Inflation)
 This cannot be set when use NIST fuel escalation rates is true. More...
 
void resetFuelOil2Inflation ()
 
bool setPropaneInflation (double propaneInflation)
 This cannot be set when use NIST fuel escalation rates is true. More...
 
void resetPropaneInflation ()
 
bool setWaterInflation (double waterInflation)
 This cannot be set when use NIST fuel escalation rates is true. More...
 
void resetWaterInflation ()
 
bool setOtherFuel1Inflation (double otherFuel1Inflation)
 This cannot be set when use NIST fuel escalation rates is true. More...
 
void resetOtherFuel1Inflation ()
 
bool setOtherFuel2Inflation (double otherFuel2Inflation)
 This cannot be set when use NIST fuel escalation rates is true. More...
 
void resetOtherFuel2Inflation ()
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType > allowableChildTypes () const
 Returns a vector of allowable children types. More...
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model. More...
 
virtual ~ParentObject ()
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()
 
ModelObject clone () const
 Creates a deep copy of this object, placing it in this object's model(). More...
 
ModelObject clone (Model model) const
 Creates a deep copy of this object, placing it in model. More...
 
Component createComponent () const
 Method for creating sharable Model snippets. More...
 
Model model () const
 Returns the Model that contains this object. More...
 
boost::optional< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
 
std::vector< ResourceObjectresources () const
 Get the resources directly used by this ModelObject. More...
 
template<typename T >
std::vector< T > getModelObjectSources () const
 Get all objects of type T that point to this object. More...
 
template<typename T >
std::vector< T > getModelObjectSources (IddObjectType iddObjectType) const
 Get all objects of type T that point to this object. More...
 
template<typename T >
boost::optional< T > getModelObjectTarget (unsigned index) const
 Get the object of type T pointed to by this object from field index. More...
 
template<typename T >
std::vector< T > getModelObjectTargets () const
 Get all objects of type T to which this object points. More...
 
const std::vector< std::string > & outputVariableNames () const
 Get all output variables names that could be associated with this object. More...
 
std::vector< OutputVariableoutputVariables () const
 Get all output variables associated with this object, must run simulation to generate data. More...
 
boost::optional
< openstudio::TimeSeries > 
getData (const OutputVariable &variable, const std::string &envPeriod) const
 Get data associated with this output variable and this object. More...
 
std::vector< LifeCycleCostlifeCycleCosts () const
 Returns the list of all LifeCycleCosts that refer to this object. More...
 
std::vector< IdfObject > removeLifeCycleCosts ()
 Removes all LifeCycleCosts that refer to this object. More...
 
IddObjectType iddObjectType () const
 This is a virtual function that will tell you the type of iddObject you are dealing with. More...
 
AdditionalProperties additionalProperties () const
 Returns this object's additional properties, constructing a new object if necessary. More...
 
bool hasAdditionalProperties () const
 Returns true if this object has additional properties. More...
 
std::vector< IdfObject > removeAdditionalProperties ()
 Removes all additional properties that refer to this object. More...
 
bool setParent (ParentObject &newParent)
 set the parent, child may have to call non-const methods on the parent More...
 
bool operator< (const ModelObject &right) const
 
bool operator== (const ModelObject &other) const
 equality test More...
 
bool operator!= (const ModelObject &other) const
 inequality test More...
 
std::vector< ScheduleTypeKeygetScheduleTypeKeys (const Schedule &schedule) const
 Return the ScheduleTypeKeys indicating how schedule is used in this object. More...
 
boost::optional< double > getAutosizedValue (std::string valueName, std::string unitString) const
 Gets the autosized component value from the sql file. More...
 
virtual std::vector
< EMSActuatorNames
emsActuatorNames () const
 Return the names of the available ems actuators. More...
 
virtual std::vector< std::string > emsInternalVariableNames () const
 Return the names of the available ems internal variables. More...
 
boost::optional< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 Returns the IddObjectType. More...
 
static std::vector< std::string > validAnalysisTypeValues ()
 Returns allowable values for analysisType. More...
 
static std::vector< std::string > validDepreciationMethodValues ()
 Returns allowable values for depreciationMethod. More...
 
static std::vector< std::string > validDiscountingConventionValues ()
 Returns allowable values for discountingConvention. More...
 
static std::vector< std::string > validInflationApproachValues ()
 Returns allowable values for inflationApproach. More...
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< LifeCycleCostParameters
LifeCycleCostParametersVector
 
typedef boost::optional
< LifeCycleCostParameters
OptionalLifeCycleCostParameters
 

Constructors and Destructors

virtual ~LifeCycleCostParameters ()
 
 LifeCycleCostParameters (const Model &model)
 Constructs a new LifeCycleCostParameters object in the model. More...
 

Getters

std::string analysisType () const
 
bool isAnalysisTypeDefaulted () const
 
bool isFEMPAnalysis () const
 returns true if analysis type is FEMP More...
 
std::string discountingConvention () const
 
bool isDiscountingConventionDefaulted () const
 
std::string inflationApproach () const
 
bool isInflationApproachDefaulted () const
 
bool isConstantDollarAnalysis () const
 
boost::optional< double > realDiscountRate () const
 
boost::optional< double > nominalDiscountRate () const
 
boost::optional< double > inflation () const
 
MonthOfYear baseDateMonth () const
 
bool isBaseDateMonthDefaulted () const
 
int baseDateYear () const
 
bool isBaseDateYearDefaulted () const
 
MonthOfYear serviceDateMonth () const
 
bool isServiceDateMonthDefaulted () const
 
int serviceDateYear () const
 
bool isServiceDateYearDefaulted () const
 
int lengthOfStudyPeriodInYears () const
 
bool isLengthOfStudyPeriodInYearsDefaulted () const
 
boost::optional< double > taxRate () const
 
std::string depreciationMethod () const
 
bool isDepreciationMethodDefaulted () const
 
bool useNISTFuelEscalationRates () const
 
bool isUseNISTFuelEscalationRatesDefaulted () const
 
boost::optional< std::string > nistRegion () const
 
std::vector< std::string > validNistRegionValues () const
 
bool isNISTRegionDefaulted () const
 
boost::optional< std::string > nistSector () const
 
std::vector< std::string > validNistSectorValues () const
 
bool isNISTSectorDefaulted () const
 
boost::optional< double > electricityInflation () const
 
boost::optional< double > naturalGasInflation () const
 
boost::optional< double > steamInflation () const
 
boost::optional< double > gasolineInflation () const
 
boost::optional< double > dieselInflation () const
 
boost::optional< double > coalInflation () const
 
boost::optional< double > fuelOil1Inflation () const
 
boost::optional< double > fuelOil2Inflation () const
 
boost::optional< double > propaneInflation () const
 
boost::optional< double > waterInflation () const
 
boost::optional< double > otherFuel1Inflation () const
 
boost::optional< double > otherFuel2Inflation () const
 
static int nistYear ()
 
static double fempRealDiscountRate ()
 
static double fempNominalDiscountRate ()
 
static double fempInflation ()
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 
- Protected Member Functions inherited from openstudio::model::ParentObject
 ParentObject (IddObjectType type, const Model &model)
 Constructs a new ParentObject object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::ModelObject
 ModelObject (IddObjectType type, const Model &model, bool fastName=false)
 
 ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl)
 

Detailed Description

LifeCycleCostParameters derives from ParentObject and is an interface to the OpenStudio IDD object named "OS:LifeCycleCost:Parameters".

LifeCycleCostParameters is a unique object which defines important parameters for life cycle analysis such as the length of the study, inflation rates, discounting convention, etc.

Constructor & Destructor Documentation

virtual openstudio::model::LifeCycleCostParameters::~LifeCycleCostParameters ( )
inlinevirtual
openstudio::model::LifeCycleCostParameters::LifeCycleCostParameters ( const Model model)
explicitprotected

Constructs a new LifeCycleCostParameters object in the model.

Member Function Documentation

std::string openstudio::model::LifeCycleCostParameters::analysisType ( ) const
MonthOfYear openstudio::model::LifeCycleCostParameters::baseDateMonth ( ) const
int openstudio::model::LifeCycleCostParameters::baseDateYear ( ) const
boost::optional<double> openstudio::model::LifeCycleCostParameters::coalInflation ( ) const
std::string openstudio::model::LifeCycleCostParameters::depreciationMethod ( ) const
boost::optional<double> openstudio::model::LifeCycleCostParameters::dieselInflation ( ) const
std::string openstudio::model::LifeCycleCostParameters::discountingConvention ( ) const
boost::optional<double> openstudio::model::LifeCycleCostParameters::electricityInflation ( ) const
static double openstudio::model::LifeCycleCostParameters::fempInflation ( )
static
static double openstudio::model::LifeCycleCostParameters::fempNominalDiscountRate ( )
static
static double openstudio::model::LifeCycleCostParameters::fempRealDiscountRate ( )
static
boost::optional<double> openstudio::model::LifeCycleCostParameters::fuelOil1Inflation ( ) const
boost::optional<double> openstudio::model::LifeCycleCostParameters::fuelOil2Inflation ( ) const
boost::optional<double> openstudio::model::LifeCycleCostParameters::gasolineInflation ( ) const
static IddObjectType openstudio::model::LifeCycleCostParameters::iddObjectType ( )
static

Returns the IddObjectType.

boost::optional<double> openstudio::model::LifeCycleCostParameters::inflation ( ) const
std::string openstudio::model::LifeCycleCostParameters::inflationApproach ( ) const
bool openstudio::model::LifeCycleCostParameters::isAnalysisTypeDefaulted ( ) const
bool openstudio::model::LifeCycleCostParameters::isBaseDateMonthDefaulted ( ) const
bool openstudio::model::LifeCycleCostParameters::isBaseDateYearDefaulted ( ) const
bool openstudio::model::LifeCycleCostParameters::isConstantDollarAnalysis ( ) const
bool openstudio::model::LifeCycleCostParameters::isDepreciationMethodDefaulted ( ) const
bool openstudio::model::LifeCycleCostParameters::isDiscountingConventionDefaulted ( ) const
bool openstudio::model::LifeCycleCostParameters::isFEMPAnalysis ( ) const

returns true if analysis type is FEMP

bool openstudio::model::LifeCycleCostParameters::isInflationApproachDefaulted ( ) const
bool openstudio::model::LifeCycleCostParameters::isLengthOfStudyPeriodInYearsDefaulted ( ) const
bool openstudio::model::LifeCycleCostParameters::isNISTRegionDefaulted ( ) const
bool openstudio::model::LifeCycleCostParameters::isNISTSectorDefaulted ( ) const
bool openstudio::model::LifeCycleCostParameters::isServiceDateMonthDefaulted ( ) const
bool openstudio::model::LifeCycleCostParameters::isServiceDateYearDefaulted ( ) const
bool openstudio::model::LifeCycleCostParameters::isUseNISTFuelEscalationRatesDefaulted ( ) const
int openstudio::model::LifeCycleCostParameters::lengthOfStudyPeriodInYears ( ) const
boost::optional<double> openstudio::model::LifeCycleCostParameters::naturalGasInflation ( ) const
boost::optional<std::string> openstudio::model::LifeCycleCostParameters::nistRegion ( ) const
boost::optional<std::string> openstudio::model::LifeCycleCostParameters::nistSector ( ) const
static int openstudio::model::LifeCycleCostParameters::nistYear ( )
static
boost::optional<double> openstudio::model::LifeCycleCostParameters::nominalDiscountRate ( ) const
boost::optional<double> openstudio::model::LifeCycleCostParameters::otherFuel1Inflation ( ) const
boost::optional<double> openstudio::model::LifeCycleCostParameters::otherFuel2Inflation ( ) const
boost::optional<double> openstudio::model::LifeCycleCostParameters::propaneInflation ( ) const
boost::optional<double> openstudio::model::LifeCycleCostParameters::realDiscountRate ( ) const
void openstudio::model::LifeCycleCostParameters::resetAnalysisType ( )
void openstudio::model::LifeCycleCostParameters::resetBaseDateMonth ( )
void openstudio::model::LifeCycleCostParameters::resetBaseDateYear ( )
void openstudio::model::LifeCycleCostParameters::resetCoalInflation ( )
void openstudio::model::LifeCycleCostParameters::resetDepreciationMethod ( )
void openstudio::model::LifeCycleCostParameters::resetDieselInflation ( )
void openstudio::model::LifeCycleCostParameters::resetDiscountingConvention ( )
void openstudio::model::LifeCycleCostParameters::resetElectricityInflation ( )
void openstudio::model::LifeCycleCostParameters::resetFuelOil1Inflation ( )
void openstudio::model::LifeCycleCostParameters::resetFuelOil2Inflation ( )
void openstudio::model::LifeCycleCostParameters::resetGasolineInflation ( )
void openstudio::model::LifeCycleCostParameters::resetInflationApproach ( )
void openstudio::model::LifeCycleCostParameters::resetLengthOfStudyPeriodInYears ( )
void openstudio::model::LifeCycleCostParameters::resetNaturalGasInflation ( )
void openstudio::model::LifeCycleCostParameters::resetNISTRegion ( )
void openstudio::model::LifeCycleCostParameters::resetNISTSector ( )
void openstudio::model::LifeCycleCostParameters::resetOtherFuel1Inflation ( )
void openstudio::model::LifeCycleCostParameters::resetOtherFuel2Inflation ( )
void openstudio::model::LifeCycleCostParameters::resetPropaneInflation ( )
void openstudio::model::LifeCycleCostParameters::resetServiceDateMonth ( )
void openstudio::model::LifeCycleCostParameters::resetServiceDateYear ( )
void openstudio::model::LifeCycleCostParameters::resetSteamInflation ( )
void openstudio::model::LifeCycleCostParameters::resetTaxRate ( )
void openstudio::model::LifeCycleCostParameters::resetUseNISTFuelEscalationRates ( )
void openstudio::model::LifeCycleCostParameters::resetWaterInflation ( )
MonthOfYear openstudio::model::LifeCycleCostParameters::serviceDateMonth ( ) const
int openstudio::model::LifeCycleCostParameters::serviceDateYear ( ) const
bool openstudio::model::LifeCycleCostParameters::setAnalysisType ( const std::string &  analysisType)
bool openstudio::model::LifeCycleCostParameters::setBaseDateMonth ( const MonthOfYear &  baseDateMonth)
bool openstudio::model::LifeCycleCostParameters::setBaseDateYear ( int  baseDateYear)
bool openstudio::model::LifeCycleCostParameters::setCoalInflation ( double  coalInflation)

This cannot be set when use NIST fuel escalation rates is true.

bool openstudio::model::LifeCycleCostParameters::setDepreciationMethod ( const std::string &  depreciationMethod)
bool openstudio::model::LifeCycleCostParameters::setDieselInflation ( double  dieselInflation)

This cannot be set when use NIST fuel escalation rates is true.

bool openstudio::model::LifeCycleCostParameters::setDiscountingConvention ( const std::string &  discountingConvention)
bool openstudio::model::LifeCycleCostParameters::setElectricityInflation ( double  electricityInflation)

This cannot be set when use NIST fuel escalation rates is true.

bool openstudio::model::LifeCycleCostParameters::setFuelOil1Inflation ( double  fuelOil1Inflation)

This cannot be set when use NIST fuel escalation rates is true.

bool openstudio::model::LifeCycleCostParameters::setFuelOil2Inflation ( double  fuelOil2Inflation)

This cannot be set when use NIST fuel escalation rates is true.

bool openstudio::model::LifeCycleCostParameters::setGasolineInflation ( double  gasolineInflation)

This cannot be set when use NIST fuel escalation rates is true.

bool openstudio::model::LifeCycleCostParameters::setInflation ( double  inflation)

This cannot be set when analysis type is FEMP or when inflation approach is "ConstantDollar".

bool openstudio::model::LifeCycleCostParameters::setInflationApproach ( const std::string &  inflationApproach)
bool openstudio::model::LifeCycleCostParameters::setLengthOfStudyPeriodInYears ( int  lengthOfStudyPeriodInYears)

This cannot be set greater than 25 years when analysis type is FEMP.

This cannot be set greater than 30 years when using NIST fuel escalation rates.

bool openstudio::model::LifeCycleCostParameters::setNaturalGasInflation ( double  naturalGasInflation)

This cannot be set when use NIST fuel escalation rates is true.

bool openstudio::model::LifeCycleCostParameters::setNISTRegion ( const std::string &  nistRegion)

This cannot be set when use NIST fuel escalation rates is false.

bool openstudio::model::LifeCycleCostParameters::setNISTSector ( const std::string &  nistSector)

This cannot be set when use NIST fuel escalation rates is false.

bool openstudio::model::LifeCycleCostParameters::setNominalDiscountRate ( double  nominalDiscountRate)

This cannot be set when analysis type is FEMP or when inflation approach is "ConstantDollar".

bool openstudio::model::LifeCycleCostParameters::setOtherFuel1Inflation ( double  otherFuel1Inflation)

This cannot be set when use NIST fuel escalation rates is true.

bool openstudio::model::LifeCycleCostParameters::setOtherFuel2Inflation ( double  otherFuel2Inflation)

This cannot be set when use NIST fuel escalation rates is true.

bool openstudio::model::LifeCycleCostParameters::setPropaneInflation ( double  propaneInflation)

This cannot be set when use NIST fuel escalation rates is true.

bool openstudio::model::LifeCycleCostParameters::setRealDiscountRate ( double  realDiscountRate)

This cannot be set when analysis type is FEMP or when inflation approach is "CurrentDollar".

bool openstudio::model::LifeCycleCostParameters::setServiceDateMonth ( const MonthOfYear &  serviceDateMonth)
bool openstudio::model::LifeCycleCostParameters::setServiceDateYear ( int  serviceDateYear)
bool openstudio::model::LifeCycleCostParameters::setSteamInflation ( double  steamInflation)

This cannot be set when use NIST fuel escalation rates is true.

bool openstudio::model::LifeCycleCostParameters::setTaxRate ( double  taxRate)
bool openstudio::model::LifeCycleCostParameters::setUseNISTFuelEscalationRates ( bool  useNISTFuelEscalationRates)

This cannot be set when analysis type is FEMP.

bool openstudio::model::LifeCycleCostParameters::setWaterInflation ( double  waterInflation)

This cannot be set when use NIST fuel escalation rates is true.

boost::optional<double> openstudio::model::LifeCycleCostParameters::steamInflation ( ) const
boost::optional<double> openstudio::model::LifeCycleCostParameters::taxRate ( ) const
bool openstudio::model::LifeCycleCostParameters::useNISTFuelEscalationRates ( ) const
static std::vector<std::string> openstudio::model::LifeCycleCostParameters::validAnalysisTypeValues ( )
static

Returns allowable values for analysisType.

static std::vector<std::string> openstudio::model::LifeCycleCostParameters::validDepreciationMethodValues ( )
static

Returns allowable values for depreciationMethod.

static std::vector<std::string> openstudio::model::LifeCycleCostParameters::validDiscountingConventionValues ( )
static

Returns allowable values for discountingConvention.

static std::vector<std::string> openstudio::model::LifeCycleCostParameters::validInflationApproachValues ( )
static

Returns allowable values for inflationApproach.

std::vector<std::string> openstudio::model::LifeCycleCostParameters::validNistRegionValues ( ) const
std::vector<std::string> openstudio::model::LifeCycleCostParameters::validNistSectorValues ( ) const
boost::optional<double> openstudio::model::LifeCycleCostParameters::waterInflation ( ) const

Friends And Related Function Documentation

typedef boost::optional<LifeCycleCostParameters> OptionalLifeCycleCostParameters
related