#include <LuminaireDefinition.hpp>
Public Member Functions | |
Constructors and Destructors | |
LuminaireDefinition (const Model &model) | |
virtual | ~LuminaireDefinition () |
Getters | |
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 |
Setters | |
bool | setLightingPower (double lightingPower) |
void | resetLightingPower () |
bool | setFractionRadiant (double fractionRadiant) |
void | resetFractionRadiant () |
bool | setFractionVisible (double fractionVisible) |
void | resetFractionVisible () |
bool | setReturnAirFraction (double returnAirFraction) |
void | resetReturnAirFraction () |
bool | 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< SpaceLoadInstance > | instances () 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< IddObjectType > | allowableChildTypes () const |
Returns a vector of allowable children types. More... | |
std::vector< ModelObject > | children () 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< ParentObject > | parent () const |
Return this object's parent in the hierarchy, if it has one. More... | |
std::vector< ResourceObject > | resources () 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< OutputVariable > | outputVariables () 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< LifeCycleCost > | lifeCycleCosts () 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... | |
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< ScheduleTypeKey > | getScheduleTypeKeys (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< ModelObject > | connectedObject (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.) | |
typedef std::vector < LuminaireDefinition > | LuminaireDefinitionVector |
typedef boost::optional < LuminaireDefinition > | OptionalLuminaireDefinition |
Related Functions inherited from openstudio::model::SpaceLoadDefinition | |
typedef boost::optional < SpaceLoadDefinition > | OptionalSpaceLoadDefinition |
typedef std::vector < SpaceLoadDefinition > | SpaceLoadDefinitionVector |
Related Functions inherited from openstudio::model::ResourceObject | |
typedef boost::optional < ResourceObject > | OptionalResourceObject |
typedef std::vector < ResourceObject > | ResourceObjectVector |
Related Functions inherited from openstudio::model::ParentObject | |
std::vector< ModelObject > | getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false) |
Returns object and all other objects accessible by calling children() on encountered ParentObjects . More... | |
std::vector< ModelObject > | getRecursiveChildrenAndResources (const ModelObject &object) |
Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More... | |
Related Functions inherited from openstudio::model::ModelObject | |
std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
typedef std::pair< std::string, std::string > | ScheduleTypeKey |
Typedef for ScheduleTypeRegistry key. More... | |
typedef std::pair< std::string, std::string > | ScheduleTypeKey |
Typedef for ScheduleTypeRegistry key. More... | |
Additional Inherited Members | |
Protected Types inherited from openstudio::model::ModelObject | |
typedef detail::ModelObject_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) | |
LuminaireDefinition is a SpaceLoadDefinition that wraps the OpenStudio IDD object 'OS_Luminaire_Definition'.
|
explicit |
|
inlinevirtual |
double openstudio::model::LuminaireDefinition::fractionRadiant | ( | ) | const |
double openstudio::model::LuminaireDefinition::fractionVisible | ( | ) | const |
|
static |
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 | ) |
bool openstudio::model::LuminaireDefinition::setReturnAirFractionCalculatedfromPlenumTemperature | ( | bool | returnAirFractionCalculatedfromPlenumTemperature | ) |
bool openstudio::model::LuminaireDefinition::setReturnAirFractionFunctionofPlenumTemperatureCoefficient1 | ( | double | returnAirFractionFunctionofPlenumTemperatureCoefficient1 | ) |
bool openstudio::model::LuminaireDefinition::setReturnAirFractionFunctionofPlenumTemperatureCoefficient2 | ( | double | returnAirFractionFunctionofPlenumTemperatureCoefficient2 | ) |
|
related |
|
related |