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

#include <DaylightingDeviceTubular.hpp>

+ Inheritance diagram for openstudio::model::DaylightingDeviceTubular:

Public Member Functions

Constructors and Destructors
 DaylightingDeviceTubular (const SubSurface &dome, const SubSurface &diffuser, const ConstructionBase &construction, double diameter, double totalLength, double effectiveThermalResistance)
 
 DaylightingDeviceTubular (const SubSurface &dome, const SubSurface &diffuser, const ConstructionBase &construction)
 
virtual ~DaylightingDeviceTubular ()=default
 
 DaylightingDeviceTubular (const DaylightingDeviceTubular &other)=default
 
 DaylightingDeviceTubular (DaylightingDeviceTubular &&other)=default
 
DaylightingDeviceTubularoperator= (const DaylightingDeviceTubular &)=default
 
DaylightingDeviceTubularoperator= (DaylightingDeviceTubular &&)=default
 
Getters
SubSurface subSurfaceDome () const
 
SubSurface subSurfaceDiffuser () const
 
ConstructionBase construction () const
 
double diameter () const
 
double totalLength () const
 
double effectiveThermalResistance () const
 
std::vector< TransitionZonetransitionZones () const
 
unsigned int numberofTransitionZones () const
 
Setters
bool setConstruction (const ConstructionBase &construction)
 
bool setDiameter (double diameter)
 
bool setTotalLength (double totalLength)
 
bool setEffectiveThermalResistance (double effectiveThermalResistance)
 
bool addTransitionZone (const TransitionZone &transitionZone)
 
bool addTransitionZone (const ThermalZone &zone, double length)
 
void removeTransitionZone (int groupIndex)
 
void removeAllTransitionZones ()
 
bool addTransitionZones (const std::vector< TransitionZone > &transitionZones)
 
- 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 ()
 

Related Functions

(Note that these are not member functions.)

using DaylightingDeviceTubularVector = std::vector< DaylightingDeviceTubular >
 
using OptionalDaylightingDeviceTubular = boost::optional< DaylightingDeviceTubular >
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- 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

DaylightingDeviceTubular is a ModelObject that wraps the OpenStudio IDD object 'OS_DaylightingDevice_Tubular'.

Constructor & Destructor Documentation

openstudio::model::DaylightingDeviceTubular::DaylightingDeviceTubular ( const SubSurface dome,
const SubSurface diffuser,
const ConstructionBase construction,
double  diameter,
double  totalLength,
double  effectiveThermalResistance 
)
explicit
openstudio::model::DaylightingDeviceTubular::DaylightingDeviceTubular ( const SubSurface dome,
const SubSurface diffuser,
const ConstructionBase construction 
)
explicit
virtual openstudio::model::DaylightingDeviceTubular::~DaylightingDeviceTubular ( )
virtualdefault
openstudio::model::DaylightingDeviceTubular::DaylightingDeviceTubular ( const DaylightingDeviceTubular other)
default
openstudio::model::DaylightingDeviceTubular::DaylightingDeviceTubular ( DaylightingDeviceTubular &&  other)
default

Member Function Documentation

bool openstudio::model::DaylightingDeviceTubular::addTransitionZone ( const TransitionZone transitionZone)
bool openstudio::model::DaylightingDeviceTubular::addTransitionZone ( const ThermalZone zone,
double  length 
)
bool openstudio::model::DaylightingDeviceTubular::addTransitionZones ( const std::vector< TransitionZone > &  transitionZones)
ConstructionBase openstudio::model::DaylightingDeviceTubular::construction ( ) const
double openstudio::model::DaylightingDeviceTubular::diameter ( ) const
double openstudio::model::DaylightingDeviceTubular::effectiveThermalResistance ( ) const
static IddObjectType openstudio::model::DaylightingDeviceTubular::iddObjectType ( )
static
unsigned int openstudio::model::DaylightingDeviceTubular::numberofTransitionZones ( ) const
DaylightingDeviceTubular& openstudio::model::DaylightingDeviceTubular::operator= ( const DaylightingDeviceTubular )
default
DaylightingDeviceTubular& openstudio::model::DaylightingDeviceTubular::operator= ( DaylightingDeviceTubular &&  )
default
void openstudio::model::DaylightingDeviceTubular::removeAllTransitionZones ( )
void openstudio::model::DaylightingDeviceTubular::removeTransitionZone ( int  groupIndex)
bool openstudio::model::DaylightingDeviceTubular::setConstruction ( const ConstructionBase construction)
bool openstudio::model::DaylightingDeviceTubular::setDiameter ( double  diameter)
bool openstudio::model::DaylightingDeviceTubular::setEffectiveThermalResistance ( double  effectiveThermalResistance)
bool openstudio::model::DaylightingDeviceTubular::setTotalLength ( double  totalLength)
SubSurface openstudio::model::DaylightingDeviceTubular::subSurfaceDiffuser ( ) const
SubSurface openstudio::model::DaylightingDeviceTubular::subSurfaceDome ( ) const
double openstudio::model::DaylightingDeviceTubular::totalLength ( ) const
std::vector<TransitionZone> openstudio::model::DaylightingDeviceTubular::transitionZones ( ) const

Friends And Related Function Documentation