#include <InternalMassDefinition.hpp>

Inheritance diagram for openstudio::model::InternalMassDefinition:

Public Member Functions
Constructors and Destructors
	InternalMassDefinition (const Model &model)

virtual	~InternalMassDefinition ()

Getters
boost::optional< ConstructionBase >	construction () const
	Returns the construction object, if this object does not directly specify construction the hierarchy is searched. More...

bool	isConstructionDefaulted () const
	Returns true if the construction is not directly referenced by this surface . More...

std::string	designLevelCalculationMethod () const

boost::optional< double >	surfaceArea () const

boost::optional< double >	surfaceAreaperSpaceFloorArea () const

boost::optional< double >	surfaceAreaperPerson () const

Setters
bool	setConstruction (const ConstructionBase &construction)
	Sets the construction object. More...

void	resetConstruction ()
	Resets the construction object. More...

bool	setSurfaceArea (double surfaceArea)
	Sets designLevelCalculationMethod to 'SurfaceArea', clears surfaceAreaperSpaceFloorArea and surfaceAreaperPerson, and sets surfaceArea. More...

bool	setSurfaceAreaperSpaceFloorArea (double surfaceAreaperSpaceFloorArea)
	Sets designLevelCalculationMethod to 'SurfaceArea/Area', clears surfaceArea and surfaceAreaperPerson, and sets surfaceAreaperSpaceFloorArea. More...

bool	setSurfaceAreaperPerson (double surfaceAreaperPerson)
	Sets designLevelCalculationMethod to 'SurfaceArea/Person', clears surfaceArea and surfaceAreaperSpaceFloorArea, and sets surfaceAreaperPerson. More...

Other
double	getSurfaceArea (double floorArea, double numPeople) const
	Returns the construction surface area represented by this definition, assuming floorArea (m^2) and numPeople. More...

double	getSurfaceAreaPerFloorArea (double floorArea, double numPeople) const
	Returns the m^2/m^2 of construction surface area per floor area represented by this definition, assuming floorArea (m^2) and numPeople. More...

double	getSurfaceAreaPerPerson (double floorArea, double numPeople) const
	Returns the m^2/person of construction surface area represented by this definition, assuming floorArea (m^2) and numPeople. More...

bool	setDesignLevelCalculationMethod (const std::string &method, double floorArea, double numPeople)
	If method is a valid design level calculation method , changes this definition to an equivalent construction surface area, under the assumptions of floorArea (m^2) and numPeople. More...

Public Member Functions inherited from openstudio::model::SpaceLoadDefinition
double	floorArea () const
	Returns the floor area associated with instances of this space load definition. More...

std::vector< SpaceLoadInstance >	instances () const
	Returns all instances of this definition. More...

int	quantity () const
	Returns the number of instances of this space load. More...

virtual	~SpaceLoadDefinition ()

Public Member Functions inherited from openstudio::model::ResourceObject
unsigned	directUseCount (bool excludeChildren=false) const
	Returns the number of objects that use this resource directly. More...

unsigned	nonResourceObjectUseCount (bool excludeChildren=false) const
	Returns the number of non-ResourceObjects that use this resource either directly or indirectly. More...

virtual	~ResourceObject ()

Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType >	allowableChildTypes () const
	Returns a vector of allowable children types. More...

std::vector< ModelObject >	children () 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< ParentObject >	parent () const
	Return this object's parent in the hierarchy, if it has one. More...

std::vector< ResourceObject >	resources () 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< OutputVariable >	outputVariables () 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< LifeCycleCost >	lifeCycleCosts () 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< ScheduleTypeKey >	getScheduleTypeKeys (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< ModelObject >	connectedObject (unsigned port) const

boost::optional< unsigned >	connectedObjectPort (unsigned port) const

Static Public Member Functions
static IddObjectType	iddObjectType ()

static std::vector< std::string >	validDesignLevelCalculationMethodValues ()

Related Functions
(Note that these are not member functions.)
typedef std::vector < InternalMassDefinition >	InternalMassDefinitionVector

typedef boost::optional < InternalMassDefinition >	OptionalInternalMassDefinition

Related Functions inherited from openstudio::model::SpaceLoadDefinition
typedef boost::optional < SpaceLoadDefinition >	OptionalSpaceLoadDefinition

typedef std::vector < SpaceLoadDefinition >	SpaceLoadDefinitionVector

Related Functions inherited from openstudio::model::ResourceObject
typedef boost::optional < ResourceObject >	OptionalResourceObject

typedef std::vector < ResourceObject >	ResourceObjectVector

Related Functions inherited from openstudio::model::ParentObject
std::vector< ModelObject >	getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false, bool includeUsedResources=true)
	Returns object and all other objects accessible by calling children() on encountered ParentObjects . More...

std::vector< ModelObject >	getRecursiveChildrenAndResources (const ModelObject &object)
	Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More...

Related Functions inherited from openstudio::model::ModelObject
std::vector< ResourceObject >	getRecursiveResources (const ModelObject &object)
	Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More...

Additional Inherited Members
Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl	ImplType

Protected Member Functions inherited from openstudio::model::SpaceLoadDefinition
	SpaceLoadDefinition (IddObjectType type, const Model &model)
	Constructs a new SpaceLoadDefinition object in the model. More...

Protected Member Functions inherited from openstudio::model::ResourceObject
	ResourceObject (IddObjectType type, const Model &model)
	Constructs a new PlanarSurface object in the model. More...

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

InternalMassDefinition is a SpaceLoadDefinition that wraps the OpenStudio IDD object 'OS_InternalMass_Definition'.

Its fields are derived from the EnergyPlus IDD object 'InternalMass'.

See also: InternalMass

Constructor & Destructor Documentation

openstudio::model::InternalMassDefinition::InternalMassDefinition ( const Model & model )

explicit

virtual openstudio::model::InternalMassDefinition::~InternalMassDefinition ( )

inlinevirtual

Member Function Documentation

boost::optional<ConstructionBase> openstudio::model::InternalMassDefinition::construction ( ) const

Returns the construction object, if this object does not directly specify construction the hierarchy is searched.

std::string openstudio::model::InternalMassDefinition::designLevelCalculationMethod ( ) const

double openstudio::model::InternalMassDefinition::getSurfaceArea	(	double	floorArea,
		double	numPeople
	)		const

Returns the construction surface area represented by this definition, assuming floorArea (m^2) and numPeople.

double openstudio::model::InternalMassDefinition::getSurfaceAreaPerFloorArea	(	double	floorArea,
		double	numPeople
	)		const

Returns the m^2/m^2 of construction surface area per floor area represented by this definition, assuming floorArea (m^2) and numPeople.

double openstudio::model::InternalMassDefinition::getSurfaceAreaPerPerson	(	double	floorArea,
		double	numPeople
	)		const

Returns the m^2/person of construction surface area represented by this definition, assuming floorArea (m^2) and numPeople.

static IddObjectType openstudio::model::InternalMassDefinition::iddObjectType ( )

static

bool openstudio::model::InternalMassDefinition::isConstructionDefaulted ( ) const

Returns true if the construction is not directly referenced by this surface .

void openstudio::model::InternalMassDefinition::resetConstruction ( )

Resets the construction object.

bool openstudio::model::InternalMassDefinition::setConstruction ( const ConstructionBase & construction )

Sets the construction object.

bool openstudio::model::InternalMassDefinition::setDesignLevelCalculationMethod	(	const std::string &	method,
		double	floorArea,
		double	numPeople
	)

If method is a valid design level calculation method , changes this definition to an equivalent construction surface area, under the assumptions of floorArea (m^2) and numPeople.

bool openstudio::model::InternalMassDefinition::setSurfaceArea ( double surfaceArea )

Sets designLevelCalculationMethod to 'SurfaceArea', clears surfaceAreaperSpaceFloorArea and surfaceAreaperPerson, and sets surfaceArea.

bool openstudio::model::InternalMassDefinition::setSurfaceAreaperPerson ( double surfaceAreaperPerson )

Sets designLevelCalculationMethod to 'SurfaceArea/Person', clears surfaceArea and surfaceAreaperSpaceFloorArea, and sets surfaceAreaperPerson.

bool openstudio::model::InternalMassDefinition::setSurfaceAreaperSpaceFloorArea ( double surfaceAreaperSpaceFloorArea )

Sets designLevelCalculationMethod to 'SurfaceArea/Area', clears surfaceArea and surfaceAreaperPerson, and sets surfaceAreaperSpaceFloorArea.

boost::optional<double> openstudio::model::InternalMassDefinition::surfaceArea ( ) const

boost::optional<double> openstudio::model::InternalMassDefinition::surfaceAreaperPerson ( ) const

boost::optional<double> openstudio::model::InternalMassDefinition::surfaceAreaperSpaceFloorArea ( ) const

static std::vector<std::string> openstudio::model::InternalMassDefinition::validDesignLevelCalculationMethodValues ( )

static

Friends And Related Function Documentation

typedef std::vector<InternalMassDefinition> InternalMassDefinitionVector

Public Member Functions

Static Public Member Functions

Related Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation