OpenStudioCore:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends 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 ()
 
Getters
std::string shadingSurfaceType () const
 
Setters
bool setShadingSurfaceType (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::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...
 
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 ()
 
double directionofRelativeNorth () const
 
bool isDirectionofRelativeNorthDefaulted () const
 
double xOrigin () const
 
bool isXOriginDefaulted () const
 
double yOrigin () const
 
bool isYOriginDefaulted () const
 
double zOrigin () const
 
bool isZOriginDefaulted () const
 
void setDirectionofRelativeNorth (double directionofRelativeNorth)
 
void resetDirectionofRelativeNorth ()
 
void setXOrigin (double xOrigin)
 
void resetXOrigin ()
 
void setYOrigin (double yOrigin)
 
void resetYOrigin ()
 
void setZOrigin (double zOrigin)
 
void resetZOrigin ()
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectTypeallowableChildTypes () const
 Returns a vector of allowable children types. More...
 
std::vector< ModelObjectchildren () 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...
 
std::vector< std::string > relationshipNames () const
 Return all valid relationship names. More...
 
std::vector< Relationshiprelationships () const
 Return all relationships for this ModelObject. More...
 
boost::optional< RelationshipgetRelationship (const std::string &name) const
 Get the relationship named name, if it exists. More...
 
bool setRelationship (const std::string &name, boost::optional< ModelObject > relatedModelObject)
 Set this ModelObject's relationship name to point to relatedModelObject (or clear the relationship if relatedModelObject == boost::none). More...
 
bool setRelationship (const std::string &name, const Component &component)
 Inserts component into this model and sets this ModelObject's relationship name to point to component.primaryObject(). More...
 
std::vector< std::string > attributeNames () const
 Return all valid attribute names. More...
 
std::vector
< openstudio::Attribute
attributes () const
 Return all Attributes for this ModelObject. More...
 
boost::optional
< openstudio::Attribute
getAttribute (const std::string &name) const
 Get the attribute named name, if it exists. More...
 
bool isSettableAttribute (const std::string &name) const
 Is the named attribute settable. More...
 
bool isOptionalAttribute (const std::string &name) const
 Is the named attribute optional. More...
 
bool setAttribute (const std::string &name, bool value)
 Set the attribute named name, if it exists. More...
 
bool setAttribute (const std::string &name, int value)
 
bool setAttribute (const std::string &name, unsigned value)
 
bool setAttribute (const std::string &name, double value)
 
bool setAttribute (const std::string &name, const Quantity &value)
 
bool setAttribute (const std::string &name, const std::string &value)
 
bool setAttribute (const std::string &name, const char *value)
 
bool resetAttribute (const std::string &name)
 Reset the attribute named name. 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< IdfObjectremoveLifeCycleCosts ()
 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...
 
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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 
- Public Member Functions inherited from openstudio::WorkspaceObject
bool canBeSource () const
 
bool canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
 
std::vector< std::string > canBeTarget () const
 
std::vector< unsigned > getSourceIndices (const Handle &targetHandle) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
IdfObject idfObject ()
 
IdfObject idfObject () const
 
bool initialized () const
 
bool isSource () const
 
bool isTarget () const
 
unsigned numSources () const
 
bool objectListFieldsEqual (const WorkspaceObject &other) const
 
bool objectListFieldsNonConflicting (const WorkspaceObject &other) const
 
bool operator< (const WorkspaceObject &right) const
 
std::ostream & operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
 
std::vector
< openstudio::IdfObject
remove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
Workspace workspace () const
 
virtual ~WorkspaceObject ()
 
- Public Member Functions inherited from openstudio::IdfObject
std::string briefDescription () const
 
cast () const
 
std::vector< T > castVector (const std::vector< U > &objects)
 
std::vector< std::vector
< std::string > > 
clearExtensibleGroups ()
 
IdfObject clone (bool keepHandle=false) const
 
std::string comment () const
 
boost::optional< std::string > createName (bool overwrite=true)
 
std::vector< unsigned > dataFields () const
 
bool dataFieldsEqual (const IdfObject &other) const
 
std::vector< std::string > eraseExtensibleGroup (unsigned groupIndex)
 
std::vector< IdfExtensibleGroupextensibleGroups () const
 
boost::optional< std::string > fieldComment (unsigned index, bool returnDefault=false) const
 
boost::optional< double > getDouble (unsigned index, bool returnDefault=false) const
 
IdfExtensibleGroup getExtensibleGroup (unsigned groupIndex) const
 
std::vector< Handle > getHandles (const std::vector< T > &objects)
 
boost::optional< intgetInt (unsigned index, bool returnDefault=false) const
 
OSOptionalQuantity getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const
 
boost::optional< std::string > getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
 
boost::optional< unsigned > getUnsigned (unsigned index, bool returnDefault=false) const
 
boost::optional< QUrl > getURL (unsigned index, bool returnDefault=false) const
 
Handle handle () const
 
IddObject iddObject () const
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (const IdfObject &other)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
 
bool isDataField (unsigned index) const
 
bool isEmpty (unsigned index) const
 
bool isObjectListField (unsigned index) const
 
bool isValid (StrictnessLevel level) const
 
boost::optional< unsigned > maxExtensibleGroups () const
 
boost::optional< unsigned > maxFields () const
 
unsigned minExtensibleGroups () const
 
unsigned minFields () const
 
boost::optional< std::string > name (bool returnDefault=false) const
 
unsigned numExtensibleGroups () const
 
unsigned numFields () const
 
unsigned numNonextensibleFields () const
 
std::vector< unsigned > objectListFields () const
 
bool objectListFieldsEqual (const IdfObject &other) const
 
bool objectListFieldsNonConflicting (const IdfObject &other) const
 
bool operator!= (const IdfObject &other) const
 
std::ostream & operator<< (std::ostream &os, const IdfObject &IdfObject)
 
bool operator== (const IdfObject &other) const
 
boost::optional< T > optionalCast () const
 
std::vector< std::string > popExtensibleGroup ()
 
std::ostream & print (std::ostream &os) const
 
std::ostream & printField (std::ostream &os, unsigned index, bool isLastField=false) const
 
std::ostream & printName (std::ostream &os, bool hasFields=true) const
 
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
 
IdfExtensibleGroup pushExtensibleGroup ()
 
std::vector< unsigned > requiredFields () const
 
void setComment (const std::string &msg)
 
bool setDouble (unsigned index, double value)
 
bool setFieldComment (unsigned index, const std::string &cmnt)
 
bool setInt (unsigned index, int value)
 
boost::optional< std::string > setName (const std::string &newName)
 
bool setQuantity (unsigned index, const Quantity &q)
 
bool setString (unsigned index, const std::string &value)
 
bool setUnsigned (unsigned index, unsigned value)
 
std::vector< T > subsetCastVector (const std::vector< U > &original)
 
ValidityReport validityReport (StrictnessLevel level, bool checkNames=true) const
 
virtual ~IdfObject ()
 

Static Public Member Functions

Static Methods
static IddObjectType iddObjectType ()
 
static std::vector< std::string > validShadingSurfaceTypeValues ()
 
- Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObjectload (const std::string &text)
 
static boost::optional< IdfObjectload (const std::string &text, const IddObject &iddObject)
 
static int printedFieldSpace ()
 

Related Functions

(Note that these are not member functions.)

typedef boost::optional
< ShadingSurfaceGroup
OptionalShadingSurfaceGroup
 
typedef std::vector
< ShadingSurfaceGroup
ShadingSurfaceGroupVector
 

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional
< WorkspaceObject
OptionalWorkspaceObject
 
typedef std::vector
< WorkspaceObject
WorkspaceObjectVector
 
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject,
IdfObject
IdfObjectPair
 
typedef std::vector< IdfObjectIdfObjectVector
 
typedef boost::optional
< IdfObject
OptionalIdfObject
 
- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 
- Protected Types inherited from openstudio::WorkspaceObject
typedef
detail::WorkspaceObject_Impl 
ImplType
 
- Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl ImplType
 
- 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)
 
- Protected Member Functions inherited from openstudio::WorkspaceObject
 WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)
 
- Protected Member Functions inherited from openstudio::IdfObject
 IdfObject (std::shared_ptr< detail::IdfObject_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 ( )
inlinevirtual

Member Function Documentation

static IddObjectType openstudio::model::ShadingSurfaceGroup::iddObjectType ( )
static
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 ( 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

typedef boost::optional<ShadingSurfaceGroup> OptionalShadingSurfaceGroup
related
typedef std::vector<ShadingSurfaceGroup> ShadingSurfaceGroupVector
related