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

#include <UtilityCost_Charge_Block.hpp>

+ Inheritance diagram for openstudio::model::UtilityCost_Charge_Block:

Public Member Functions

unsigned maxNumBlocks () const
 Returns the maximum number of blocks for which data may be specified, e.g. the maximum number of extensible fields. More...
 
unsigned numBlocks () const
 Returns the number of blocks for which data is specified, e.g. the number of extensible fields. More...
 
Constructors and Destructors
 UtilityCost_Charge_Block (const Model &model)
 Constructs a new UtilityCost_Charge_Block object in the model. More...
 
virtual ~UtilityCost_Charge_Block ()
 
Getters
boost::optional< std::string > tariffName () const
 
boost::optional< std::string > sourceVariable () const
 
boost::optional< std::string > season () const
 
boost::optional< std::string > categoryVariableName () const
 
boost::optional< std::string > remainingIntoVariable () const
 
boost::optional< std::string > blockSizeValueOrVariableName (unsigned index) const
 Get the block size value or variable name at index. More...
 
boost::optional< std::string > blockCostPerUnitValueOrVariableName (unsigned index) const
 Get the cost per unit for block at index. More...
 
Setters
void setTariffName (const std::string &tariffName)
 
void setSourceVariable (const std::string &sourceVariable)
 
void setSeason (const std::string &season)
 
void setCategoryVariableName (const std::string &categoryVariableName)
 
void setRemainingIntoVariable (const std::string &remainingIntoVariable)
 
bool setBlockSizeValueOrVariableName (unsigned index, const std::string &blockSizeValueOrVariableName)
 Set the block size value or variable name at index. More...
 
bool setBlockCostPerUnitValueOrVariableName (unsigned index, const std::string &blockCostPerUnitValueOrVariableName)
 Set the cost per unit for block at index. More...
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectTypeallowableChildTypes () 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< 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, bool checkNames=false) 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=false) const
 
virtual ~IdfObject ()
 

Static Public Member Functions

static IddObjectType iddObjectType ()
 Returns the IddObjectType. 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 boost::optional
< UtilityCost_Charge_Block
OptionalUtilityCost_Charge_Block
 
typedef std::vector
< UtilityCost_Charge_Block
UtilityCost_Charge_BlockVector
 

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::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)
 
- 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

UtilityCost_Charge_Block derives from ParentObject and is an interface to the OpenStudio IDD object named "OS:UtilityCost:Charge:Block".

UtilityCost_Charge_Block is used to compute energy and demand charges that are structured in blocks of charges. It may also be used for taxes, surcharges and any other charges that occur on a utility bill but those are more commonly simple flat charges so UtilityCost_Charge_Simple is more commonly used for those functions. As many UtilityCost_Charge_Block objects as needed may be defined for a single tariff and they will be added together. Blocks are a structure used by almost all utilities for calculating energy and demand charges and they allow the utility to charge more or less per unit of energy or demand if more units are used.

Constructor & Destructor Documentation

openstudio::model::UtilityCost_Charge_Block::UtilityCost_Charge_Block ( const Model model)
explicit

Constructs a new UtilityCost_Charge_Block object in the model.

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

Member Function Documentation

boost::optional<std::string> openstudio::model::UtilityCost_Charge_Block::blockCostPerUnitValueOrVariableName ( unsigned  index) const

Get the cost per unit for block at index.

Indexing starts at 0.

boost::optional<std::string> openstudio::model::UtilityCost_Charge_Block::blockSizeValueOrVariableName ( unsigned  index) const

Get the block size value or variable name at index.

Indexing starts at 0.

boost::optional<std::string> openstudio::model::UtilityCost_Charge_Block::categoryVariableName ( ) const
static IddObjectType openstudio::model::UtilityCost_Charge_Block::iddObjectType ( )
static

Returns the IddObjectType.

unsigned openstudio::model::UtilityCost_Charge_Block::maxNumBlocks ( ) const

Returns the maximum number of blocks for which data may be specified, e.g. the maximum number of extensible fields.

unsigned openstudio::model::UtilityCost_Charge_Block::numBlocks ( ) const

Returns the number of blocks for which data is specified, e.g. the number of extensible fields.

boost::optional<std::string> openstudio::model::UtilityCost_Charge_Block::remainingIntoVariable ( ) const
boost::optional<std::string> openstudio::model::UtilityCost_Charge_Block::season ( ) const
bool openstudio::model::UtilityCost_Charge_Block::setBlockCostPerUnitValueOrVariableName ( unsigned  index,
const std::string &  blockCostPerUnitValueOrVariableName 
)

Set the cost per unit for block at index.

Indexing starts at 0.

bool openstudio::model::UtilityCost_Charge_Block::setBlockSizeValueOrVariableName ( unsigned  index,
const std::string &  blockSizeValueOrVariableName 
)

Set the block size value or variable name at index.

Indexing starts at 0.

void openstudio::model::UtilityCost_Charge_Block::setCategoryVariableName ( const std::string &  categoryVariableName)
void openstudio::model::UtilityCost_Charge_Block::setRemainingIntoVariable ( const std::string &  remainingIntoVariable)
void openstudio::model::UtilityCost_Charge_Block::setSeason ( const std::string &  season)
void openstudio::model::UtilityCost_Charge_Block::setSourceVariable ( const std::string &  sourceVariable)
void openstudio::model::UtilityCost_Charge_Block::setTariffName ( const std::string &  tariffName)
boost::optional<std::string> openstudio::model::UtilityCost_Charge_Block::sourceVariable ( ) const
boost::optional<std::string> openstudio::model::UtilityCost_Charge_Block::tariffName ( ) const

Friends And Related Function Documentation