OpenStudio:model
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages

#include "AdditionalProperties.hpp"

Inheritance diagram for openstudio::model::AdditionalProperties:

Public Member Functions

void merge (const AdditionalProperties &other, bool overwrite=false)
virtual ~AdditionalProperties ()
ModelObject modelObject () const
std::vector< std::string > featureNames () const
bool hasFeature (const std::string &name) const
boost::optional< std::string > getFeatureDataType (const std::string &name) const
boost::optional< std::string > getFeatureAsString (const std::string &name) const
boost::optional< double > getFeatureAsDouble (const std::string &name) const
boost::optional< intgetFeatureAsInteger (const std::string &name) const
boost::optional< bool > getFeatureAsBoolean (const std::string &name) const
std::vector< std::string > suggestedFeatureNames () const
bool setFeature (const std::string &name, const std::string &value)
bool setFeature (const std::string &name, const char *value)
bool setFeature (const std::string &name, double value)
bool setFeature (const std::string &name, int value)
bool setFeature (const std::string &name, bool value)
bool resetFeature (const std::string &name)

Static Public Member Functions

static IddObjectType iddObjectType ()

Related Functions

typedef std::vector
< AdditionalProperties
AdditionalPropertiesVector
typedef boost::optional
< AdditionalProperties
OptionalAdditionalProperties

Constructor & Destructor Documentation

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

Member Function Documentation

std::vector<std::string> openstudio::model::AdditionalProperties::featureNames ( ) const

Returns the set of feature name strings.

boost::optional<bool> openstudio::model::AdditionalProperties::getFeatureAsBoolean ( const std::string &  name) const

Returns optional feature value as Boolean.

boost::optional<double> openstudio::model::AdditionalProperties::getFeatureAsDouble ( const std::string &  name) const

Returns optional feature value as Double.

boost::optional<int> openstudio::model::AdditionalProperties::getFeatureAsInteger ( const std::string &  name) const

Returns optional feature value as Integer.

boost::optional<std::string> openstudio::model::AdditionalProperties::getFeatureAsString ( const std::string &  name) const

Returns optional feature value as String.

boost::optional<std::string> openstudio::model::AdditionalProperties::getFeatureDataType ( const std::string &  name) const

Returns optional feature data type as String, Double, Boolean, or Integer.

bool openstudio::model::AdditionalProperties::hasFeature ( const std::string &  name) const

Returns true if a feature exists.

static IddObjectType openstudio::model::AdditionalProperties::iddObjectType ( )
static
void openstudio::model::AdditionalProperties::merge ( const AdditionalProperties other,
bool  overwrite = false 
)

Merge another AdditionalProperties object with this one If overwrite is true, the keys from other object overwrite keys from this.

ModelObject openstudio::model::AdditionalProperties::modelObject ( ) const

Returns the ModelObject this AdditionalProperties object refers to.

This method will throw if the ModelObject cannot be found.

bool openstudio::model::AdditionalProperties::resetFeature ( const std::string &  name)
bool openstudio::model::AdditionalProperties::setFeature ( const std::string &  name,
const std::string &  value 
)
bool openstudio::model::AdditionalProperties::setFeature ( const std::string &  name,
const char *  value 
)
bool openstudio::model::AdditionalProperties::setFeature ( const std::string &  name,
double  value 
)
bool openstudio::model::AdditionalProperties::setFeature ( const std::string &  name,
int  value 
)
bool openstudio::model::AdditionalProperties::setFeature ( const std::string &  name,
bool  value 
)
std::vector<std::string> openstudio::model::AdditionalProperties::suggestedFeatureNames ( ) const

Returns set of AdditionalProperties feature names already in the model.

Friends And Related Function Documentation

typedef std::vector<AdditionalProperties> AdditionalPropertiesVector
related
typedef boost::optional<AdditionalProperties> OptionalAdditionalProperties
related