#include <ShadingSurface.hpp>

Inheritance diagram for openstudio::model::ShadingSurface:

Public Member Functions
boost::optional < DaylightingDeviceShelf >	daylightingDeviceShelf () const

Constructors and Destructors
	ShadingSurface (const std::vector< Point3d > &vertices, const Model &model)

virtual	~ShadingSurface ()

Getters
boost::optional < ShadingSurfaceGroup >	shadingSurfaceGroup () const
	get the shading group More...

boost::optional< Schedule >	transmittanceSchedule () const

boost::optional< double >	numberofVertices () const

bool	isNumberofVerticesDefaulted () const

bool	isNumberofVerticesAutocalculated () const

Setters
bool	setShadingSurfaceGroup (const ShadingSurfaceGroup &shadingSurfaceGroup)
	set the exterior shading group More...

void	resetShadingSurfaceGroup ()

bool	setTransmittanceSchedule (Schedule &transmittanceSchedule)
	set the transmittance schedule More...

void	resetTransmittanceSchedule ()
	reset the transmittance schedule More...

bool	setNumberofVertices (boost::optional< double > numberofVertices)

bool	setNumberofVertices (double numberofVertices)

void	resetNumberofVertices ()

void	autocalculateNumberofVertices ()

Public Member Functions inherited from openstudio::model::PlanarSurface
double	azimuth () const
	Returns the surface's azimuth measured clockwise as angle between outward normal and local North (radians). More...

Point3d	centroid () const
	Return the centroid of this planar surface's vertices. More...

bool	equalVertices (const PlanarSurface &other) const
	Check if this planar surface's vertices are equal to the other's in the building coordinate system. More...

boost::optional< double >	exteriorVisibleAbsorptance () const
	Returns exterior visible absorptance (unitless), if available. More...

std::vector < GeneratorPhotovoltaic >	generatorPhotovoltaics () const
	Returns any generator photovoltaics associated with this surface. More...

double	grossArea () const
	Computes the surface's gross area (m^2). More...

boost::optional< double >	heatCapacity () const

boost::optional< double >	interiorVisibleAbsorptance () const

bool	isAirWall () const
	Checks if this surface is an air wall, returns true if the Construction includes a single layer of type MaterialAirWall. More...

double	netArea () const
	Computes the surface's net area (m^2). More...

Vector3d	outwardNormal () const
	Returns the outward normal vector in local coordinates. More...

Plane	plane () const
	Get the plane, throws openstudio::Exception if cannot compute plane for this surface. More...

bool	reverseEqualVertices (const PlanarSurface &other) const
	Check if this planar surface's vertices are reverse equal to the other's in the building coordinate system. More...

bool	setThermalConductance (double value)

bool	setUFactor (double value)
	Sets the u-factor of this surface in W/m^2*K, if possible. More...

std::vector< ModelObject >	solarCollectors () const
	Returns any solar hot water collectors associated with this surface. More...

bool	subtractFromGrossArea () const
	Reports if user should subtract this surface's net area from parent's gross area to compute parent's net area (e.g. More...

std::vector < SurfacePropertyConvectionCoefficients >	surfacePropertyConvectionCoefficients () const
	Returns any SurfacePropertyConvectionCoefficients associated with this surface, does not return SurfacePropertyConvectionCoefficientsMultipleSurface. More...

boost::optional< double >	thermalConductance () const

double	tilt () const
	Returns the surface's tilt measured as angle between outward normal and local up (radians). More...

virtual std::vector < std::vector< Point3d > >	triangulation () const
	Get a triangulation of this surface, subsurfaces will be replaced by holes in the triangulation. More...

boost::optional< double >	uFactor () const

boost::optional< double >	visibleTransmittance () const
	Returns visible transmittance (unitless), if available. More...

boost::optional< ConstructionBase >	construction () const
	Returns the construction object. More...

boost::optional< std::pair < ConstructionBase, int > >	constructionWithSearchDistance () const
	Returns the construction object and the search distance that was needed to find the construction. More...

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

boost::optional < PlanarSurfaceGroup >	planarSurfaceGroup () const
	Returns the containing PlanarSurfaceGroup if available. More...

boost::optional< Space >	space () const
	Returns the containing Space if available. More...

std::vector< Point3d >	vertices () const
	Returns the vertices. More...

bool	setVertices (const std::vector< Point3d > &vertices)
	Sets the vertices. More...

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

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

virtual	~PlanarSurface ()

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

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 (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 Methods
static IddObjectType	iddObjectType ()

Static Public Member Functions inherited from openstudio::model::PlanarSurface
static double	filmResistance (const FilmResistanceType &type)
	Film resistances from ASHRAE Fundamentals, Chapter 25, Table 1 for non-reflective surfaces. More...

static std::vector< PlanarSurface >	findPlanarSurfaces (const std::vector< PlanarSurface > &planarSurfaces, boost::optional< double > minDegreesFromNorth, boost::optional< double > maxDegreesFromNorth, boost::optional< double > minDegreesTilt, boost::optional< double > maxDegreesTilt, double tol=1)
	Find PlanarSurfaces within angular range, specified in degrees in the site coordinate system, an unset optional means no limit. More...

static double	stillAirFilmResistance (double tilt)
	Film resistance of still air on surface with tilt (rad). More...

Related Functions
(Note that these are not member functions.)
typedef boost::optional < ShadingSurface >	OptionalShadingSurface

typedef std::vector < ShadingSurface >	ShadingSurfaceVector

Related Functions inherited from openstudio::model::PlanarSurface
typedef boost::optional < PlanarSurface >	OptionalPlanarSurface

typedef std::vector < PlanarSurface >	PlanarSurfaceVector

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::PlanarSurface
	PlanarSurface (IddObjectType type, const std::vector< Point3d > &vertices, 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

ShadingSurface is a PlanarSurface that wraps the OpenStudio IDD object 'OS:ShadingSurface'.

Constructor & Destructor Documentation

openstudio::model::ShadingSurface::ShadingSurface	(	const std::vector< Point3d > &	vertices,
		const Model &	model
	)

explicit

virtual openstudio::model::ShadingSurface::~ShadingSurface ( )

inlinevirtual

Member Function Documentation

void openstudio::model::ShadingSurface::autocalculateNumberofVertices ( )

boost::optional<DaylightingDeviceShelf> openstudio::model::ShadingSurface::daylightingDeviceShelf ( ) const

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

static

bool openstudio::model::ShadingSurface::isNumberofVerticesAutocalculated ( ) const

bool openstudio::model::ShadingSurface::isNumberofVerticesDefaulted ( ) const

boost::optional<double> openstudio::model::ShadingSurface::numberofVertices ( ) const

void openstudio::model::ShadingSurface::resetNumberofVertices ( )

void openstudio::model::ShadingSurface::resetShadingSurfaceGroup ( )

void openstudio::model::ShadingSurface::resetTransmittanceSchedule ( )

reset the transmittance schedule

bool openstudio::model::ShadingSurface::setNumberofVertices ( boost::optional< double > numberofVertices )

bool openstudio::model::ShadingSurface::setNumberofVertices ( double numberofVertices )

bool openstudio::model::ShadingSurface::setShadingSurfaceGroup ( const ShadingSurfaceGroup & shadingSurfaceGroup )

set the exterior shading group

bool openstudio::model::ShadingSurface::setTransmittanceSchedule ( Schedule & transmittanceSchedule )

set the transmittance schedule

boost::optional<ShadingSurfaceGroup> openstudio::model::ShadingSurface::shadingSurfaceGroup ( ) const

get the shading group

boost::optional<Schedule> openstudio::model::ShadingSurface::transmittanceSchedule ( ) const

Friends And Related Function Documentation

typedef boost::optional<ShadingSurface> OptionalShadingSurface

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