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

#include <PlanarSurfaceGroup.hpp>

+ Inheritance diagram for openstudio::model::PlanarSurfaceGroup:

Public Member Functions

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...
 
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 ()
 
Getters
double directionofRelativeNorth () const
 
bool isDirectionofRelativeNorthDefaulted () const
 
double xOrigin () const
 
bool isXOriginDefaulted () const
 
double yOrigin () const
 
bool isYOriginDefaulted () const
 
double zOrigin () const
 
bool isZOriginDefaulted () const
 
Setters
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...
 
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< 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 (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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 

Protected Member Functions

Constructors and Destructors
 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)
 

Related Functions

(Note that these are not member functions.)

typedef boost::optional
< PlanarSurfaceGroup
OptionalPlanarSurfaceGroup
 
typedef std::vector
< PlanarSurfaceGroup
PlanarSurfaceGroupVector
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 

Detailed Description

PlanarSurfaceGroup is an abstract class representing a group that holds many PlanarSurfaces.

Constructor & Destructor Documentation

virtual openstudio::model::PlanarSurfaceGroup::~PlanarSurfaceGroup ( )
inlinevirtual
openstudio::model::PlanarSurfaceGroup::PlanarSurfaceGroup ( IddObjectType  iddObjectType,
const Model model 
)
explicitprotected

Member Function Documentation

openstudio::BoundingBox openstudio::model::PlanarSurfaceGroup::boundingBox ( ) const

Get the BoundingBox in local coordinates.

openstudio::BoundingBox openstudio::model::PlanarSurfaceGroup::boundingBoxBuildingCoordinates ( ) const

Get the BoundingBox in building coordinates.

openstudio::BoundingBox openstudio::model::PlanarSurfaceGroup::boundingBoxParentCoordinates ( ) const

Get the BoundingBox in parent coordinates.

openstudio::BoundingBox openstudio::model::PlanarSurfaceGroup::boundingBoxSiteCoordinates ( ) const

Get the BoundingBox in site coordinates.

openstudio::Transformation openstudio::model::PlanarSurfaceGroup::buildingTransformation ( ) const

Returns the transformation from local coordinates to building coordinates.

bool openstudio::model::PlanarSurfaceGroup::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.

double openstudio::model::PlanarSurfaceGroup::directionofRelativeNorth ( ) const
bool openstudio::model::PlanarSurfaceGroup::isDirectionofRelativeNorthDefaulted ( ) const
bool openstudio::model::PlanarSurfaceGroup::isXOriginDefaulted ( ) const
bool openstudio::model::PlanarSurfaceGroup::isYOriginDefaulted ( ) const
bool openstudio::model::PlanarSurfaceGroup::isZOriginDefaulted ( ) const
void openstudio::model::PlanarSurfaceGroup::resetDirectionofRelativeNorth ( )
void openstudio::model::PlanarSurfaceGroup::resetXOrigin ( )
void openstudio::model::PlanarSurfaceGroup::resetYOrigin ( )
void openstudio::model::PlanarSurfaceGroup::resetZOrigin ( )
bool openstudio::model::PlanarSurfaceGroup::setDirectionofRelativeNorth ( double  directionofRelativeNorth)
bool openstudio::model::PlanarSurfaceGroup::setTransformation ( const openstudio::Transformation &  transformation)

Sets the transformation from local coordinates to parent coordinates, this method can be used to move the group.

bool openstudio::model::PlanarSurfaceGroup::setXOrigin ( double  xOrigin)
bool openstudio::model::PlanarSurfaceGroup::setYOrigin ( double  yOrigin)
bool openstudio::model::PlanarSurfaceGroup::setZOrigin ( double  zOrigin)
openstudio::Transformation openstudio::model::PlanarSurfaceGroup::siteTransformation ( ) const

Returns the transformation from local coordinates to site coordinates.

openstudio::Transformation openstudio::model::PlanarSurfaceGroup::transformation ( ) const

Returns the transformation from local coordinates to parent coordinates.

double openstudio::model::PlanarSurfaceGroup::xOrigin ( ) const
double openstudio::model::PlanarSurfaceGroup::yOrigin ( ) const
double openstudio::model::PlanarSurfaceGroup::zOrigin ( ) const

Friends And Related Function Documentation

typedef boost::optional<PlanarSurfaceGroup> OptionalPlanarSurfaceGroup
related
typedef std::vector<PlanarSurfaceGroup> PlanarSurfaceGroupVector
related