OpenStudioCore:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Related Functions | List of all members
openstudio::model::LifeCycleCost Class Reference

#include <LifeCycleCost.hpp>

+ Inheritance diagram for openstudio::model::LifeCycleCost:

Public Member Functions

bool convertToCostPerEach ()
 Attemps to convert cost units to "CostPerEach" and set cost to totalCost. More...
 
boost::optional< double > costedArea () const
 Compute the area that would be used for CostPerArea. More...
 
boost::optional< intcostedQuantity () const
 Compute the number of objects that would be used for CostPerEach. More...
 
boost::optional< intcostedThermalZones () const
 Compute the number of ThermalZone objects that would be used for CostPerThermalZone. More...
 
double totalCost () const
 Returns the total cost based on number of units. More...
 
Constructors and Destructors
 LifeCycleCost (const ModelObject &modelObject)
 Constructs a new LifeCycleCost object in the model. More...
 
virtual ~LifeCycleCost ()
 
Getters
std::string category () const
 Returns the category. More...
 
std::string itemType () const
 Returns the type of ModelObject this LifeCycleCost applies to. More...
 
ModelObject item () const
 Returns the ModelObject this LifeCycleCost applies to. More...
 
double cost () const
 Returns the cost. More...
 
std::vector< std::string > validCostUnitsValues () const
 Returns a list of valid cost units based on lineItemType. More...
 
std::string costUnits () const
 Returns the cost units. More...
 
int yearsFromStart () const
 Years from start is added to months from start to give the time at which the costs start to occur. More...
 
bool isYearsFromStartDefaulted () const
 
int monthsFromStart () const
 
bool isMonthsFromStartDefaulted () const
 
int repeatPeriodYears () const
 Repeat period years is added to repeat period months to give the interval at which this cost reccurs. More...
 
bool isRepeatPeriodYearsDefaulted () const
 
int repeatPeriodMonths () const
 
bool isRepeatPeriodMonthsDefaulted () const
 
Setters
bool setCategory (const std::string &category)
 
bool setCost (double cost)
 
bool setCostUnits (const std::string &costUnits)
 
bool setYearsFromStart (int yearsFromStart)
 
void resetYearsFromStart ()
 
bool setMonthsFromStart (int monthsFromStart)
 
void resetMonthsFromStart ()
 
bool setRepeatPeriodYears (int repeatPeriodYears)
 
void resetRepeatPeriodYears ()
 
bool setRepeatPeriodMonths (int repeatPeriodMonths)
 
void resetRepeatPeriodMonths ()
 
- 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...
 
std::vector< std::string > relationshipNames () const
 Return all valid relationship names. More...
 
std::vector< Relationshiprelationships () const
 Return all relationships for this ModelObject. More...
 
boost::optional< RelationshipgetRelationship (const std::string &name) const
 Get the relationship named name, if it exists. More...
 
bool setRelationship (const std::string &name, boost::optional< ModelObject > relatedModelObject)
 Set this ModelObject's relationship name to point to relatedModelObject (or clear the relationship if relatedModelObject == boost::none). More...
 
bool setRelationship (const std::string &name, const Component &component)
 Inserts component into this model and sets this ModelObject's relationship name to point to component.primaryObject(). More...
 
std::vector< std::string > attributeNames () const
 Return all valid attribute names. More...
 
std::vector
< openstudio::Attribute
attributes () const
 Return all Attributes for this ModelObject. More...
 
boost::optional
< openstudio::Attribute
getAttribute (const std::string &name) const
 Get the attribute named name, if it exists. More...
 
bool isSettableAttribute (const std::string &name) const
 Is the named attribute settable. More...
 
bool isOptionalAttribute (const std::string &name) const
 Is the named attribute optional. More...
 
bool setAttribute (const std::string &name, bool value)
 Set the attribute named name, if it exists. More...
 
bool setAttribute (const std::string &name, int value)
 
bool setAttribute (const std::string &name, unsigned value)
 
bool setAttribute (const std::string &name, double value)
 
bool setAttribute (const std::string &name, const Quantity &value)
 
bool setAttribute (const std::string &name, const std::string &value)
 
bool setAttribute (const std::string &name, const char *value)
 
bool resetAttribute (const std::string &name)
 Reset the attribute named name. 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< IdfObjectremoveLifeCycleCosts ()
 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...
 
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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 
- Public Member Functions inherited from openstudio::WorkspaceObject
bool canBeSource () const
 
bool canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
 
std::vector< std::string > canBeTarget () const
 
std::vector< unsigned > getSourceIndices (const Handle &targetHandle) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
IdfObject idfObject ()
 
IdfObject idfObject () const
 
bool initialized () const
 
bool isSource () const
 
bool isTarget () const
 
unsigned numSources () const
 
bool objectListFieldsEqual (const WorkspaceObject &other) const
 
bool objectListFieldsNonConflicting (const WorkspaceObject &other) const
 
bool operator< (const WorkspaceObject &right) const
 
std::ostream & operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
 
std::vector
< openstudio::IdfObject
remove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
Workspace workspace () const
 
virtual ~WorkspaceObject ()
 
- Public Member Functions inherited from openstudio::IdfObject
std::string briefDescription () const
 
cast () const
 
std::vector< T > castVector (const std::vector< U > &objects)
 
std::vector< std::vector
< std::string > > 
clearExtensibleGroups ()
 
IdfObject clone (bool keepHandle=false) const
 
std::string comment () const
 
boost::optional< std::string > createName (bool overwrite=true)
 
std::vector< unsigned > dataFields () const
 
bool dataFieldsEqual (const IdfObject &other) const
 
std::vector< std::string > eraseExtensibleGroup (unsigned groupIndex)
 
std::vector< IdfExtensibleGroupextensibleGroups () const
 
boost::optional< std::string > fieldComment (unsigned index, bool returnDefault=false) const
 
boost::optional< double > getDouble (unsigned index, bool returnDefault=false) const
 
IdfExtensibleGroup getExtensibleGroup (unsigned groupIndex) const
 
std::vector< Handle > getHandles (const std::vector< T > &objects)
 
boost::optional< intgetInt (unsigned index, bool returnDefault=false) const
 
OSOptionalQuantity getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const
 
boost::optional< std::string > getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
 
boost::optional< unsigned > getUnsigned (unsigned index, bool returnDefault=false) const
 
boost::optional< QUrl > getURL (unsigned index, bool returnDefault=false) const
 
Handle handle () const
 
IddObject iddObject () const
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (const IdfObject &other)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
 
bool isDataField (unsigned index) const
 
bool isEmpty (unsigned index) const
 
bool isObjectListField (unsigned index) const
 
bool isValid (StrictnessLevel level) const
 
boost::optional< unsigned > maxExtensibleGroups () const
 
boost::optional< unsigned > maxFields () const
 
unsigned minExtensibleGroups () const
 
unsigned minFields () const
 
boost::optional< std::string > name (bool returnDefault=false) const
 
std::string nameString (bool returnDefault=false) const
 
unsigned numExtensibleGroups () const
 
unsigned numFields () const
 
unsigned numNonextensibleFields () const
 
std::vector< unsigned > objectListFields () const
 
bool objectListFieldsEqual (const IdfObject &other) const
 
bool objectListFieldsNonConflicting (const IdfObject &other) const
 
bool operator!= (const IdfObject &other) const
 
std::ostream & operator<< (std::ostream &os, const IdfObject &IdfObject)
 
bool operator== (const IdfObject &other) const
 
boost::optional< T > optionalCast () const
 
std::vector< std::string > popExtensibleGroup ()
 
std::ostream & print (std::ostream &os) const
 
std::ostream & printField (std::ostream &os, unsigned index, bool isLastField=false) const
 
std::ostream & printName (std::ostream &os, bool hasFields=true) const
 
IdfExtensibleGroup pushExtensibleGroup ()
 
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
 
std::vector< unsigned > requiredFields () const
 
void setComment (const std::string &msg)
 
bool setDouble (unsigned index, double value)
 
bool setFieldComment (unsigned index, const std::string &cmnt)
 
bool setInt (unsigned index, int value)
 
boost::optional< std::string > setName (const std::string &newName)
 
bool setQuantity (unsigned index, const Quantity &q)
 
bool setString (unsigned index, const std::string &value)
 
bool setUnsigned (unsigned index, unsigned value)
 
std::vector< T > subsetCastVector (const std::vector< U > &original)
 
ValidityReport validityReport (StrictnessLevel level, bool checkNames=true) const
 
virtual ~IdfObject ()
 

Static Public Member Functions

Static Methods
static IddObjectType iddObjectType ()
 
static std::vector< std::string > validCategoryValues ()
 
static std::vector< std::string > validItemTypeValues ()
 
static boost::optional
< LifeCycleCost
createLifeCycleCost (const std::string &name, const ModelObject &modelObject, double cost, const std::string &costUnits, const std::string &category, int repeatPeriodYears=0, int yearsFromStart=0)
 Create a LifeCycleCost for the given ModelObject with cost, costUnits, category, and optional repeatPeriodYear. More...
 
- Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObjectload (const std::string &text)
 
static boost::optional< IdfObjectload (const std::string &text, const IddObject &iddObject)
 
static int printedFieldSpace ()
 

Related Functions

(Note that these are not member functions.)

typedef std::vector
< LifeCycleCost
LifeCycleCostVector
 
typedef boost::optional
< LifeCycleCost
OptionalLifeCycleCost
 

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional
< WorkspaceObject
OptionalWorkspaceObject
 
typedef std::vector
< WorkspaceObject
WorkspaceObjectVector
 
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject,
IdfObject
IdfObjectPair
 
typedef std::vector< IdfObjectIdfObjectVector
 
typedef boost::optional
< IdfObject
OptionalIdfObject
 
- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 
- Protected Types inherited from openstudio::WorkspaceObject
typedef
detail::WorkspaceObject_Impl 
ImplType
 
- Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl ImplType
 
- 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)
 
- Protected Member Functions inherited from openstudio::WorkspaceObject
 WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)
 
- Protected Member Functions inherited from openstudio::IdfObject
 IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl)
 

Detailed Description

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

LifeCycleCost objects are used to add costs related to building construction and operation. The LifeCycleCost's lineItemType will be set based on the type of ModelObject.

Constructor & Destructor Documentation

openstudio::model::LifeCycleCost::LifeCycleCost ( const ModelObject modelObject)
explicit

Constructs a new LifeCycleCost object in the model.

This will throw if the object type is not known

virtual openstudio::model::LifeCycleCost::~LifeCycleCost ( )
inlinevirtual

Member Function Documentation

std::string openstudio::model::LifeCycleCost::category ( ) const

Returns the category.

bool openstudio::model::LifeCycleCost::convertToCostPerEach ( )

Attemps to convert cost units to "CostPerEach" and set cost to totalCost.

double openstudio::model::LifeCycleCost::cost ( ) const

Returns the cost.

boost::optional<double> openstudio::model::LifeCycleCost::costedArea ( ) const

Compute the area that would be used for CostPerArea.

Includes space and instance multipliers.

boost::optional<int> openstudio::model::LifeCycleCost::costedQuantity ( ) const

Compute the number of objects that would be used for CostPerEach.

Includes space and instance multipliers.

boost::optional<int> openstudio::model::LifeCycleCost::costedThermalZones ( ) const

Compute the number of ThermalZone objects that would be used for CostPerThermalZone.

Includes space and instance multipliers.

std::string openstudio::model::LifeCycleCost::costUnits ( ) const

Returns the cost units.

static boost::optional<LifeCycleCost> openstudio::model::LifeCycleCost::createLifeCycleCost ( const std::string &  name,
const ModelObject modelObject,
double  cost,
const std::string &  costUnits,
const std::string &  category,
int  repeatPeriodYears = 0,
int  yearsFromStart = 0 
)
static

Create a LifeCycleCost for the given ModelObject with cost, costUnits, category, and optional repeatPeriodYear.

Will return an empty result if ModelObject type is unknown or if costUnits or category are not valid

static IddObjectType openstudio::model::LifeCycleCost::iddObjectType ( )
static
bool openstudio::model::LifeCycleCost::isMonthsFromStartDefaulted ( ) const
bool openstudio::model::LifeCycleCost::isRepeatPeriodMonthsDefaulted ( ) const
bool openstudio::model::LifeCycleCost::isRepeatPeriodYearsDefaulted ( ) const
bool openstudio::model::LifeCycleCost::isYearsFromStartDefaulted ( ) const
ModelObject openstudio::model::LifeCycleCost::item ( ) const

Returns the ModelObject this LifeCycleCost applies to.

std::string openstudio::model::LifeCycleCost::itemType ( ) const

Returns the type of ModelObject this LifeCycleCost applies to.

int openstudio::model::LifeCycleCost::monthsFromStart ( ) const
int openstudio::model::LifeCycleCost::repeatPeriodMonths ( ) const
int openstudio::model::LifeCycleCost::repeatPeriodYears ( ) const

Repeat period years is added to repeat period months to give the interval at which this cost reccurs.

If both repeat period years and repeat period months are zero (default), this cost does not recurr.

void openstudio::model::LifeCycleCost::resetMonthsFromStart ( )
void openstudio::model::LifeCycleCost::resetRepeatPeriodMonths ( )
void openstudio::model::LifeCycleCost::resetRepeatPeriodYears ( )
void openstudio::model::LifeCycleCost::resetYearsFromStart ( )
bool openstudio::model::LifeCycleCost::setCategory ( const std::string &  category)
bool openstudio::model::LifeCycleCost::setCost ( double  cost)
bool openstudio::model::LifeCycleCost::setCostUnits ( const std::string &  costUnits)
bool openstudio::model::LifeCycleCost::setMonthsFromStart ( int  monthsFromStart)
bool openstudio::model::LifeCycleCost::setRepeatPeriodMonths ( int  repeatPeriodMonths)
bool openstudio::model::LifeCycleCost::setRepeatPeriodYears ( int  repeatPeriodYears)
bool openstudio::model::LifeCycleCost::setYearsFromStart ( int  yearsFromStart)
double openstudio::model::LifeCycleCost::totalCost ( ) const

Returns the total cost based on number of units.

static std::vector<std::string> openstudio::model::LifeCycleCost::validCategoryValues ( )
static
std::vector<std::string> openstudio::model::LifeCycleCost::validCostUnitsValues ( ) const

Returns a list of valid cost units based on lineItemType.

static std::vector<std::string> openstudio::model::LifeCycleCost::validItemTypeValues ( )
static
int openstudio::model::LifeCycleCost::yearsFromStart ( ) const

Years from start is added to months from start to give the time at which the costs start to occur.

Friends And Related Function Documentation

typedef std::vector<LifeCycleCost> LifeCycleCostVector
related
typedef boost::optional<LifeCycleCost> OptionalLifeCycleCost
related