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

#include <LuminaireDefinition.hpp>

+ Inheritance diagram for openstudio::model::LuminaireDefinition:

Public Member Functions

Constructors and Destructors
 LuminaireDefinition (const Model &model)
virtual ~LuminaireDefinition ()
double lightingPower () const
bool isLightingPowerDefaulted () const
double fractionRadiant () const
bool isFractionRadiantDefaulted () const
double fractionVisible () const
bool isFractionVisibleDefaulted () const
double returnAirFraction () const
bool isReturnAirFractionDefaulted () const
bool returnAirFractionCalculatedfromPlenumTemperature () const
bool isReturnAirFractionCalculatedfromPlenumTemperatureDefaulted () const
double returnAirFractionFunctionofPlenumTemperatureCoefficient1 () const
bool isReturnAirFractionFunctionofPlenumTemperatureCoefficient1Defaulted () const
double returnAirFractionFunctionofPlenumTemperatureCoefficient2 () const
bool isReturnAirFractionFunctionofPlenumTemperatureCoefficient2Defaulted () const
bool setLightingPower (double lightingPower)
void resetLightingPower ()
bool setFractionRadiant (double fractionRadiant)
void resetFractionRadiant ()
bool setFractionVisible (double fractionVisible)
void resetFractionVisible ()
bool setReturnAirFraction (double returnAirFraction)
void resetReturnAirFraction ()
void setReturnAirFractionCalculatedfromPlenumTemperature (bool returnAirFractionCalculatedfromPlenumTemperature)
void resetReturnAirFractionCalculatedfromPlenumTemperature ()
bool setReturnAirFractionFunctionofPlenumTemperatureCoefficient1 (double returnAirFractionFunctionofPlenumTemperatureCoefficient1)
void resetReturnAirFractionFunctionofPlenumTemperatureCoefficient1 ()
bool setReturnAirFractionFunctionofPlenumTemperatureCoefficient2 (double returnAirFractionFunctionofPlenumTemperatureCoefficient2)
void resetReturnAirFractionFunctionofPlenumTemperatureCoefficient2 ()
- Public Member Functions inherited from openstudio::model::SpaceLoadDefinition
double floorArea () const
 Returns the floor area associated with instances of this space load definition. More...
std::vector< SpaceLoadInstanceinstances () const
 Returns all instances of this definition. More...
int quantity () const
 Returns the number of instances of this space load. More...
virtual ~SpaceLoadDefinition ()
- Public Member Functions inherited from openstudio::model::ResourceObject
unsigned directUseCount (bool excludeChildren=false) const
 Returns the number of objects that use this resource directly. More...
unsigned nonResourceObjectUseCount (bool excludeChildren=false) const
 Returns the number of non-ResourceObjects that use this resource either directly or indirectly. More...
virtual ~ResourceObject ()
- 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...
< openstudio::Attribute
attributes () const
 Return all Attributes for this ModelObject. More...
< 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...
< 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)
< 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 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 std::vector
< LuminaireDefinition
typedef boost::optional
< LuminaireDefinition

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional
< WorkspaceObject
typedef std::vector
< WorkspaceObject
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject,
typedef std::vector< IdfObjectIdfObjectVector
typedef boost::optional
< IdfObject
- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
- Protected Types inherited from openstudio::WorkspaceObject
- Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl ImplType
- Protected Member Functions inherited from openstudio::model::SpaceLoadDefinition
 SpaceLoadDefinition (IddObjectType type, const Model &model)
 Constructs a new SpaceLoadDefinition object in the model. More...
- Protected Member Functions inherited from openstudio::model::ResourceObject
 ResourceObject (IddObjectType type, const Model &model)
 Constructs a new PlanarSurface object in the model. More...
- 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

LuminaireDefinition is a SpaceLoadDefinition that wraps the OpenStudio IDD object 'OS_Luminaire_Definition'.

See also

Constructor & Destructor Documentation

openstudio::model::LuminaireDefinition::LuminaireDefinition ( const Model model)
virtual openstudio::model::LuminaireDefinition::~LuminaireDefinition ( )

Member Function Documentation

double openstudio::model::LuminaireDefinition::fractionRadiant ( ) const
double openstudio::model::LuminaireDefinition::fractionVisible ( ) const
static IddObjectType openstudio::model::LuminaireDefinition::iddObjectType ( )
bool openstudio::model::LuminaireDefinition::isFractionRadiantDefaulted ( ) const
bool openstudio::model::LuminaireDefinition::isFractionVisibleDefaulted ( ) const
bool openstudio::model::LuminaireDefinition::isLightingPowerDefaulted ( ) const
bool openstudio::model::LuminaireDefinition::isReturnAirFractionCalculatedfromPlenumTemperatureDefaulted ( ) const
bool openstudio::model::LuminaireDefinition::isReturnAirFractionDefaulted ( ) const
bool openstudio::model::LuminaireDefinition::isReturnAirFractionFunctionofPlenumTemperatureCoefficient1Defaulted ( ) const
bool openstudio::model::LuminaireDefinition::isReturnAirFractionFunctionofPlenumTemperatureCoefficient2Defaulted ( ) const
double openstudio::model::LuminaireDefinition::lightingPower ( ) const
void openstudio::model::LuminaireDefinition::resetFractionRadiant ( )
void openstudio::model::LuminaireDefinition::resetFractionVisible ( )
void openstudio::model::LuminaireDefinition::resetLightingPower ( )
void openstudio::model::LuminaireDefinition::resetReturnAirFraction ( )
void openstudio::model::LuminaireDefinition::resetReturnAirFractionCalculatedfromPlenumTemperature ( )
void openstudio::model::LuminaireDefinition::resetReturnAirFractionFunctionofPlenumTemperatureCoefficient1 ( )
void openstudio::model::LuminaireDefinition::resetReturnAirFractionFunctionofPlenumTemperatureCoefficient2 ( )
double openstudio::model::LuminaireDefinition::returnAirFraction ( ) const
bool openstudio::model::LuminaireDefinition::returnAirFractionCalculatedfromPlenumTemperature ( ) const
double openstudio::model::LuminaireDefinition::returnAirFractionFunctionofPlenumTemperatureCoefficient1 ( ) const
double openstudio::model::LuminaireDefinition::returnAirFractionFunctionofPlenumTemperatureCoefficient2 ( ) const
bool openstudio::model::LuminaireDefinition::setFractionRadiant ( double  fractionRadiant)
bool openstudio::model::LuminaireDefinition::setFractionVisible ( double  fractionVisible)
bool openstudio::model::LuminaireDefinition::setLightingPower ( double  lightingPower)
bool openstudio::model::LuminaireDefinition::setReturnAirFraction ( double  returnAirFraction)
void openstudio::model::LuminaireDefinition::setReturnAirFractionCalculatedfromPlenumTemperature ( bool  returnAirFractionCalculatedfromPlenumTemperature)
bool openstudio::model::LuminaireDefinition::setReturnAirFractionFunctionofPlenumTemperatureCoefficient1 ( double  returnAirFractionFunctionofPlenumTemperatureCoefficient1)
bool openstudio::model::LuminaireDefinition::setReturnAirFractionFunctionofPlenumTemperatureCoefficient2 ( double  returnAirFractionFunctionofPlenumTemperatureCoefficient2)

Friends And Related Function Documentation

typedef std::vector<LuminaireDefinition> LuminaireDefinitionVector
typedef boost::optional<LuminaireDefinition> OptionalLuminaireDefinition