|
|
| Luminaire (const LuminaireDefinition &luminaireDefinition) |
|
virtual | ~Luminaire () |
|
|
LuminaireDefinition | luminaireDefinition () const |
| Gets the LuminaireDefinition object. More...
|
|
boost::optional< Schedule > | schedule () const |
| Returns the (fractional) lighting schedule. More...
|
|
bool | isScheduleDefaulted () const |
| Returns true if this object does not specify a schedule directly. More...
|
|
double | positionXcoordinate () const |
|
Quantity | getPositionXcoordinate (bool returnIP=false) const |
|
double | positionYcoordinate () const |
|
Quantity | getPositionYcoordinate (bool returnIP=false) const |
|
double | positionZcoordinate () const |
|
Quantity | getPositionZcoordinate (bool returnIP=false) const |
|
double | psiRotationAroundXaxis () const |
|
Quantity | getPsiRotationAroundXaxis (bool returnIP=false) const |
|
bool | isPsiRotationAroundXaxisDefaulted () const |
|
double | thetaRotationAroundYaxis () const |
|
Quantity | getThetaRotationAroundYaxis (bool returnIP=false) const |
|
bool | isThetaRotationAroundYaxisDefaulted () const |
|
double | phiRotationAroundZaxis () const |
|
Quantity | getPhiRotationAroundZaxis (bool returnIP=false) const |
|
bool | isPhiRotationAroundZaxisDefaulted () const |
|
double | fractionReplaceable () const |
|
Quantity | getFractionReplaceable (bool returnIP=false) const |
|
bool | isFractionReplaceableDefaulted () const |
|
std::string | endUseSubcategory () const |
|
bool | isEndUseSubcategoryDefaulted () const |
|
|
bool | setLuminaireDefinition (const LuminaireDefinition &definition) |
| Sets the LuminaireDefinition object. More...
|
|
bool | setSchedule (Schedule &schedule) |
| Sets the (fractional) Schedule. More...
|
|
void | resetSchedule () |
| Resets the (fractional) Schedule. More...
|
|
void | setPositionXcoordinate (double positionXcoordinate) |
|
bool | setPositionXcoordinate (const Quantity &positionXcoordinate) |
|
void | setPositionYcoordinate (double positionYcoordinate) |
|
bool | setPositionYcoordinate (const Quantity &positionYcoordinate) |
|
void | setPositionZcoordinate (double positionZcoordinate) |
|
bool | setPositionZcoordinate (const Quantity &positionZcoordinate) |
|
void | setPsiRotationAroundXaxis (double psiRotationAroundXaxis) |
|
bool | setPsiRotationAroundXaxis (const Quantity &psiRotationAroundXaxis) |
|
void | resetPsiRotationAroundXaxis () |
|
void | setThetaRotationAroundYaxis (double thetaRotationAroundYaxis) |
|
bool | setThetaRotationAroundYaxis (const Quantity &thetaRotationAroundYaxis) |
|
void | resetThetaRotationAroundYaxis () |
|
void | setPhiRotationAroundZaxis (double phiRotationAroundZaxis) |
|
bool | setPhiRotationAroundZaxis (const Quantity &phiRotationAroundZaxis) |
|
void | resetPhiRotationAroundZaxis () |
|
bool | setFractionReplaceable (double fractionReplaceable) |
|
bool | setFractionReplaceable (const Quantity &fractionReplaceable) |
|
void | resetFractionReplaceable () |
|
bool | setMultiplier (double multiplier) |
|
void | resetMultiplier () |
|
void | setEndUseSubcategory (std::string endUseSubcategory) |
|
void | resetEndUseSubcategory () |
|
|
openstudio::Point3d | position () const |
| Returns a Point3d representing position only in meters relative to the Space. More...
|
|
bool | setPosition (const openstudio::Point3d &position) |
| Sets a Point3d representing position only position in meters relative to the Space. More...
|
|
openstudio::Transformation | transformation () const |
| Returns a Transformation representing position and orientation in meters relative to the Space. More...
|
|
bool | setTransformation (const openstudio::Transformation &transformation) |
| Sets a Transformation representing position and orientation in meters relative to the Space. More...
|
|
double | lightingPower () const |
| Returns the design level represented by this instance. More...
|
|
double | getPowerPerFloorArea (double floorArea) const |
| Returns the watts/m^2 represented by this instance, assuming floorArea (m^2). More...
|
|
double | getPowerPerPerson (double numPeople) const |
| Returns the watts/person represented by this instance, assuming numPeople. More...
|
|
SpaceLoadDefinition | definition () const |
| Returns the definition of this instance. More...
|
|
double | floorArea () const |
| Returns the floor area associated with this space load instance. More...
|
|
bool | isMultiplierDefaulted () const |
| Returns true if the multiplier is defaulted. More...
|
|
void | makeUnique () |
| Ensures that no other instances share this instances definition. More...
|
|
double | multiplier () const |
| Gets the multiplier for this space instance, defaults to 1. More...
|
|
int | quantity () const |
| Returns the number of instances this space load instance represents. More...
|
|
bool | setDefinition (const SpaceLoadDefinition &definition) |
| Sets the definition of this instance. More...
|
|
virtual | ~SpaceLoadInstance () |
|
bool | hardApplySchedules () |
| Directly applies default schedules to this space load if found. More...
|
|
bool | hardSize () |
| Converts space load levels to abosolute values rather than by per area, etc. More...
|
|
void | resetSpaceType () |
|
bool | setSpaceType (const SpaceType &spaceType) |
| Sets the parent SpaceType. More...
|
|
boost::optional< SpaceType > | spaceType () const |
| Returns the parent SpaceType. More...
|
|
virtual | ~SpaceLoad () |
|
void | resetSpace () |
|
bool | setSpace (const Space &space) |
| Sets the parent Space. More...
|
|
boost::optional< Space > | space () const |
| Returns the parent Space. More...
|
|
virtual | ~SpaceItem () |
|
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< Relationship > | relationships () const |
| Return all relationships for this ModelObject. More...
|
|
boost::optional< Relationship > | getRelationship (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< 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...
|
|
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< ModelObject > | connectedObject (unsigned port) const |
|
boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
|
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< WorkspaceObject > | getSources (IddObjectType type) const |
|
boost::optional< WorkspaceObject > | getTarget (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< WorkspaceObject > | sources () const |
|
std::vector< WorkspaceObject > | targets () const |
|
Workspace | workspace () const |
|
virtual | ~WorkspaceObject () |
|
std::string | briefDescription () const |
|
T | 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< IdfExtensibleGroup > | extensibleGroups () 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< int > | getInt (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 |
|
std::string | nameString (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 () |
|
IdfExtensibleGroup | pushExtensibleGroup (const std::vector< std::string > &values) |
|
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 () |
|