ShadingSurfaceGroup Class Reference

#include "ShadingSurfaceGroup.hpp"

Inheritance diagram for openstudio::model::ShadingSurfaceGroup:

Public Member Functions
void	resetShadedObject ()
void	resetSpace ()
bool	setShadedSubSurface (const SubSurface &subSurface)
bool	setShadedSurface (const Surface &surface)
bool	setSpace (const Space &space)
boost::optional< SubSurface >	shadedSubSurface () const
boost::optional< Surface >	shadedSurface () const
std::vector< ShadingSurface >	shadingSurfaces () const
boost::optional< Space >	space () const
	ShadingSurfaceGroup (const Model &model)
virtual	~ShadingSurfaceGroup ()=default
	ShadingSurfaceGroup (const ShadingSurfaceGroup &other)=default
	ShadingSurfaceGroup (ShadingSurfaceGroup &&other)=default
ShadingSurfaceGroup &	operator= (const ShadingSurfaceGroup &)=default
ShadingSurfaceGroup &	operator= (ShadingSurfaceGroup &&)=default
std::string	shadingSurfaceType () const
bool	setShadingSurfaceType (const std::string &shadingSurfaceType)

Static Public Member Functions
static IddObjectType	iddObjectType ()
static std::vector< std::string >	validShadingSurfaceTypeValues ()

Related Functions
using	OptionalShadingSurfaceGroup = boost::optional< ShadingSurfaceGroup >
using	ShadingSurfaceGroupVector = std::vector< ShadingSurfaceGroup >

Detailed Description

ShadingSurfaceGroup is a PlanarSurfaceGroup that wraps the OpenStudio IDD object 'OS_ShadingSurfaceGroup'.

Constructor & Destructor Documentation

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

explicit

virtual openstudio::model::ShadingSurfaceGroup::~ShadingSurfaceGroup ( )

virtualdefault

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

default

openstudio::model::ShadingSurfaceGroup::ShadingSurfaceGroup ( ShadingSurfaceGroup &&  other )

default

Member Function Documentation

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

static

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

default

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

default

void openstudio::model::ShadingSurfaceGroup::resetShadedObject

(

)

Resets the sub surface shaded by this group.

void openstudio::model::ShadingSurfaceGroup::resetSpace

(

)

If (space()), calls setShadingSurfaceType("Building") to remove the relationship.

bool openstudio::model::ShadingSurfaceGroup::setShadedSubSurface

(

const SubSurface &

subSurface

)

Sets the specifc sub surface shaded by this group, sub surface must be in the same parent space.

bool openstudio::model::ShadingSurfaceGroup::setShadedSurface

(

const Surface &

surface

)

Sets the surface shaded by this group, surface must be in the same parent space.

bool openstudio::model::ShadingSurfaceGroup::setShadingSurfaceType

(

const std::string &

shadingSurfaceType

)

this will fail if "Space" and space is not set, use setSpace instead

bool openstudio::model::ShadingSurfaceGroup::setSpace

(

const Space &

space

)

Sets the parent Space.

boost::optional<SubSurface> openstudio::model::ShadingSurfaceGroup::shadedSubSurface

(

)

const

Returns the specific sub surface shaded by this group if specified.

boost::optional<Surface> openstudio::model::ShadingSurfaceGroup::shadedSurface

(

)

const

Returns the surface shaded by this group if specified.

std::vector<ShadingSurface> openstudio::model::ShadingSurfaceGroup::shadingSurfaces

(

)

const

Returns child shading surfaces.

std::string openstudio::model::ShadingSurfaceGroup::shadingSurfaceType

(

)

const

boost::optional<Space> openstudio::model::ShadingSurfaceGroup::space

(

)

const

Returns the parent Space.

static std::vector<std::string> openstudio::model::ShadingSurfaceGroup::validShadingSurfaceTypeValues ( )

static

Friends And Related Function Documentation

using OptionalShadingSurfaceGroup = boost::optional<ShadingSurfaceGroup>

related

using ShadingSurfaceGroupVector = std::vector<ShadingSurfaceGroup>

related