OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | Related Functions | List of all members
openstudio::model::ShadingSurfaceGroup Class Reference

#include <ShadingSurfaceGroup.hpp>

+ Inheritance diagram for openstudio::model::ShadingSurfaceGroup:

Public Member Functions

void resetShadedObject ()
 Resets the sub surface shaded by this group. More...
 
void resetSpace ()
 If (space()), calls setShadingSurfaceType("Building") to remove the relationship. More...
 
bool setShadedSubSurface (const SubSurface &subSurface)
 Sets the specifc sub surface shaded by this group, sub surface must be in the same parent space. More...
 
bool setShadedSurface (const Surface &surface)
 Sets the surface shaded by this group, surface must be in the same parent space. More...
 
bool setSpace (const Space &space)
 Sets the parent Space. More...
 
boost::optional< SubSurfaceshadedSubSurface () const
 Returns the specific sub surface shaded by this group if specified. More...
 
boost::optional< SurfaceshadedSurface () const
 Returns the surface shaded by this group if specified. More...
 
std::vector< ShadingSurfaceshadingSurfaces () const
 Returns child shading surfaces. More...
 
boost::optional< Spacespace () const
 Returns the parent Space. More...
 
Constructors and Destructors
 ShadingSurfaceGroup (const Model &model)
 
virtual ~ShadingSurfaceGroup ()=default
 
 ShadingSurfaceGroup (const ShadingSurfaceGroup &other)=default
 
 ShadingSurfaceGroup (ShadingSurfaceGroup &&other)=default
 
ShadingSurfaceGroupoperator= (const ShadingSurfaceGroup &)=default
 
ShadingSurfaceGroupoperator= (ShadingSurfaceGroup &&)=default
 
Getters
std::string shadingSurfaceType () const
 
Setters
bool setShadingSurfaceType (const std::string &shadingSurfaceType)
 this will fail if "Space" and space is not set, use setSpace instead More...
 
- Public Member Functions inherited from openstudio::model::PlanarSurfaceGroup
openstudio::BoundingBox boundingBox () const
 Get the BoundingBox in local coordinates. More...
 
openstudio::BoundingBox boundingBoxBuildingCoordinates () const
 Get the BoundingBox in building coordinates. More...
 
openstudio::BoundingBox boundingBoxParentCoordinates () const
 Get the BoundingBox in parent coordinates. More...
 
openstudio::BoundingBox boundingBoxSiteCoordinates () const
 Get the BoundingBox in site coordinates. More...
 
openstudio::Transformation buildingTransformation () const
 Returns the transformation from local coordinates to building coordinates. More...
 
bool changeTransformation (const openstudio::Transformation &transformation)
 Changes the transformation from local coordinates to parent coordinates, this method alter geometry of children relative to the group so that it stays in the same place with the new transformation. More...
 
PlanarSurfaceGroupoperator= (const PlanarSurfaceGroup &)=default
 
PlanarSurfaceGroupoperator= (PlanarSurfaceGroup &&)=default
 
 PlanarSurfaceGroup (const PlanarSurfaceGroup &other)=default
 
 PlanarSurfaceGroup (PlanarSurfaceGroup &&other)=default
 
bool setTransformation (const openstudio::Transformation &transformation)
 Sets the transformation from local coordinates to parent coordinates, this method can be used to move the group. More...
 
openstudio::Transformation siteTransformation () const
 Returns the transformation from local coordinates to site coordinates. More...
 
openstudio::Transformation transformation () const
 Returns the transformation from local coordinates to parent coordinates. More...
 
virtual ~PlanarSurfaceGroup ()=default
 
double directionofRelativeNorth () const
 
bool isDirectionofRelativeNorthDefaulted () const
 
double xOrigin () const
 
bool isXOriginDefaulted () const
 
double yOrigin () const
 
bool isYOriginDefaulted () const
 
double zOrigin () const
 
bool isZOriginDefaulted () const
 
bool setDirectionofRelativeNorth (double directionofRelativeNorth)
 
void resetDirectionofRelativeNorth ()
 
bool setXOrigin (double xOrigin)
 
void resetXOrigin ()
 
bool setYOrigin (double yOrigin)
 
void resetYOrigin ()
 
bool setZOrigin (double zOrigin)
 
void resetZOrigin ()
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType > allowableChildTypes () const
 Returns a vector of allowable children types. More...
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model. More...
 
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject ()=default
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()=default
 
 ModelObject (const ModelObject &other)=default
 
 ModelObject (ModelObject &&other)=default
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (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< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
 
std::vector< ResourceObjectresources () 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< OutputVariableoutputVariables () 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< LifeCycleCostlifeCycleCosts () 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< ScheduleTypeKeygetScheduleTypeKeys (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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 

Static Public Member Functions

Static Methods
static IddObjectType iddObjectType ()
 
static std::vector< std::string > validShadingSurfaceTypeValues ()
 

Related Functions

(Note that these are not member functions.)

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

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- Protected Member Functions inherited from openstudio::model::PlanarSurfaceGroup
 PlanarSurfaceGroup (IddObjectType iddObjectType, const Model &model)
 
- 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

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