#include <SurfacePropertyGroundSurfaces.hpp>

Inheritance diagram for openstudio::model::SurfacePropertyGroundSurfaces:

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

virtual	~SurfacePropertyGroundSurfaces ()=default

	SurfacePropertyGroundSurfaces (const SurfacePropertyGroundSurfaces &other)=default

	SurfacePropertyGroundSurfaces (SurfacePropertyGroundSurfaces &&other)=default

SurfacePropertyGroundSurfaces &	operator= (const SurfacePropertyGroundSurfaces &)=default

SurfacePropertyGroundSurfaces &	operator= (SurfacePropertyGroundSurfaces &&)=default

Other
boost::optional < SurfacePropertyLocalEnvironment >	surfacePropertyLocalEnvironment () const

std::vector< GroundSurfaceGroup >	groundSurfaceGroups () const

unsigned int	numberofGroundSurfaceGroups () const

boost::optional< unsigned >	groundSurfaceGroupIndex (const GroundSurfaceGroup &groundSurfaceGroup) const
	Looks up by Surface Name (case-insensitive) More...

boost::optional< unsigned >	groundSurfaceGroupIndex (const std::string &groundSurfaceName) const

boost::optional < GroundSurfaceGroup >	getGroundSurfaceGroup (unsigned groupIndex) const

bool	addGroundSurfaceGroup (const GroundSurfaceGroup &groundSurfaceGroup)
	If a groundSurfaceGroup group is already present (cf `groundSurfaceGroupIndex()`), it will Warn and override the groundSurfaceGroup value. More...

bool	addGroundSurfaceGroup (const std::string &groundSurfaceName, double viewFactor, boost::optional< Schedule > temperatureSchedule=boost::none, boost::optional< Schedule > reflectanceSchedule=boost::none)

bool	addGroundSurfaceGroups (const std::vector< GroundSurfaceGroup > &groundSurfaceGroups)

bool	removeGroundSurfaceGroup (unsigned groupIndex)

void	removeAllGroundSurfaceGroups ()

Public Member Functions inherited from openstudio::model::ModelObject
virtual	~ModelObject ()=default

	ModelObject (const ModelObject &other)=default

	ModelObject (ModelObject &&other)=default

ModelObject &	operator= (const ModelObject &)=default

ModelObject &	operator= (ModelObject &&)=default

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...

boost::optional< std::string >	cadObjectId () const

bool	setCADObjectId (const std::string &cadObjectId)

boost::optional< std::string >	gbXMLId () const

bool	setGBXMLId (const std::string &gbXMLId)

boost::optional< std::string >	displayName () const

bool	setDisplayName (const std::string &displayName)

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 (const std::string &valueName, const std::string &units) 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 ()

Related Functions
(Note that these are not member functions.)
using	OptionalSurfacePropertyGroundSurfaces = boost::optional< SurfacePropertyGroundSurfaces >

using	SurfacePropertyGroundSurfacesVector = std::vector< SurfacePropertyGroundSurfaces >

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
using	ImplType = detail::ModelObject_Impl

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

SurfacePropertyGroundSurfaces is a ModelObject that wraps the OpenStudio IDD object 'OS:SurfaceProperty:GroundSurfaces'.

Constructor & Destructor Documentation

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

explicit

virtual openstudio::model::SurfacePropertyGroundSurfaces::~SurfacePropertyGroundSurfaces ( )

virtualdefault

openstudio::model::SurfacePropertyGroundSurfaces::SurfacePropertyGroundSurfaces ( const SurfacePropertyGroundSurfaces & other )

default

openstudio::model::SurfacePropertyGroundSurfaces::SurfacePropertyGroundSurfaces ( SurfacePropertyGroundSurfaces && other )

default

Member Function Documentation

bool openstudio::model::SurfacePropertyGroundSurfaces::addGroundSurfaceGroup ( const GroundSurfaceGroup & groundSurfaceGroup )

If a groundSurfaceGroup group is already present (cf groundSurfaceGroupIndex()), it will Warn and override the groundSurfaceGroup value.

bool openstudio::model::SurfacePropertyGroundSurfaces::addGroundSurfaceGroup	(	const std::string &	groundSurfaceName,
		double	viewFactor,
		boost::optional< Schedule >	temperatureSchedule = `boost::none`,
		boost::optional< Schedule >	reflectanceSchedule = `boost::none`
	)

bool openstudio::model::SurfacePropertyGroundSurfaces::addGroundSurfaceGroups ( const std::vector< GroundSurfaceGroup > & groundSurfaceGroups )

boost::optional<GroundSurfaceGroup> openstudio::model::SurfacePropertyGroundSurfaces::getGroundSurfaceGroup ( unsigned groupIndex ) const

boost::optional<unsigned> openstudio::model::SurfacePropertyGroundSurfaces::groundSurfaceGroupIndex ( const GroundSurfaceGroup & groundSurfaceGroup ) const

Looks up by Surface Name (case-insensitive)

boost::optional<unsigned> openstudio::model::SurfacePropertyGroundSurfaces::groundSurfaceGroupIndex ( const std::string & groundSurfaceName ) const

std::vector<GroundSurfaceGroup> openstudio::model::SurfacePropertyGroundSurfaces::groundSurfaceGroups ( ) const

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

static

unsigned int openstudio::model::SurfacePropertyGroundSurfaces::numberofGroundSurfaceGroups ( ) const

SurfacePropertyGroundSurfaces& openstudio::model::SurfacePropertyGroundSurfaces::operator= ( const SurfacePropertyGroundSurfaces & )

default

SurfacePropertyGroundSurfaces& openstudio::model::SurfacePropertyGroundSurfaces::operator= ( SurfacePropertyGroundSurfaces && )

default

void openstudio::model::SurfacePropertyGroundSurfaces::removeAllGroundSurfaceGroups ( )

bool openstudio::model::SurfacePropertyGroundSurfaces::removeGroundSurfaceGroup ( unsigned groupIndex )

boost::optional<SurfacePropertyLocalEnvironment> openstudio::model::SurfacePropertyGroundSurfaces::surfacePropertyLocalEnvironment ( ) const

Friends And Related Function Documentation

using OptionalSurfacePropertyGroundSurfaces = boost::optional<SurfacePropertyGroundSurfaces>

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