CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
OdIfc4::IfcBuilding Class Reference

#include <IfcBuildingAutoImpl.h>

Inheritance diagram for OdIfc4::IfcBuilding:
OdIfc4::IfcSpatialStructureElement OdIfc4::IfcSpatialElement OdIfc4::IfcProduct OdIfc4::IfcObject OdIfc4::IfcObjectDefinition OdIfc4::IfcRoot OdIfc::OdIfcEntity

Public Member Functions

double getElevationOfRefHeight () const
 
void setElevationOfRefHeight (double ElevationOfRefHeight)
 
double getElevationOfTerrain () const
 
void setElevationOfTerrain (double ElevationOfTerrain)
 
const OdDAIObjectId & getBuildingAddress () const
 
void setBuildingAddress (const OdDAIObjectId &BuildingAddress)
 
 IfcBuilding ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual OdRxValue getAttr (const char *attrName) const
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
- Public Member Functions inherited from OdIfc4::IfcSpatialStructureElement
IfcElementCompositionEnum getCompositionType () const
 
void setCompositionType (IfcElementCompositionEnum CompositionType)
 
 IfcSpatialStructureElement ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual OdRxValue getAttr (const char *attrName) const
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
- Public Member Functions inherited from OdIfc4::IfcSpatialElement
const OdAnsiString & getLongName () const
 
void setLongName (const OdAnsiString &LongName)
 
void getInvContainsElements (OdDAIObjectIds &ContainsElements) const
 
void getInvServicedBySystems (OdDAIObjectIds &ServicedBySystems) const
 
void getInvReferencesElements (OdDAIObjectIds &ReferencesElements) const
 
 IfcSpatialElement ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual OdRxValue getAttr (const char *attrName) const
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
- Public Member Functions inherited from OdIfc4::IfcProduct
const OdDAIObjectId & getObjectPlacement () const
 
void setObjectPlacement (const OdDAIObjectId &ObjectPlacement)
 
const OdDAIObjectId & getRepresentation () const
 
void setRepresentation (const OdDAIObjectId &Representation)
 
void getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual void setInverseCounterParts ()
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual OdRxValue getAttr (const char *attrName) const
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
- Public Member Functions inherited from OdIfc4::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDeclaredBy (OdDAIObjectIds &IsDeclaredBy) const
 
void getInvDeclares (OdDAIObjectIds &Declares) const
 
void getInvIsTypedBy (OdDAIObjectIds &IsTypedBy) const
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
 IfcObject ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual OdRxValue getAttr (const char *attrName) const
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
- Public Member Functions inherited from OdIfc4::IfcObjectDefinition
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvNests (OdDAIObjectIds &Nests) const
 
void getInvIsNestedBy (OdDAIObjectIds &IsNestedBy) const
 
void getInvHasContext (OdDAIObjectIds &HasContext) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
- Public Member Functions inherited from OdIfc4::IfcRoot
OdIfcGUID getGlobalId () const
 
void setGlobalId (OdIfcGUID GlobalId)
 
const OdDAIObjectId & getOwnerHistory () const
 
void setOwnerHistory (const OdDAIObjectId &OwnerHistory)
 
const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
 IfcRoot ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual OdRxValue getAttr (const char *attrName) const
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
- Public Member Functions inherited from OdIfc::OdIfcEntity
 ODRX_DECLARE_MEMBERS (OdIfcEntity)
 
 OdIfcEntity ()
 
 ~OdIfcEntity ()
 
virtual bool isKindOf (OdIfcEntityType entityType) const
 
bool isInstanceOf (OdIfcEntityType entityType) const
 
virtual OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfcAttribute attrDef) const
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool testAttr (const OdIfcAttribute explicitAttrDef) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual void unsetAttr (const OdIfcAttribute explicitAttrDef)
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool putAttr (const OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
IfcOpResult resolved ()
 
void resolve (IfcOpResult resolved, void *resPtr)
 
void unresolve ()
 
virtual void setGsNode (OdGsCache *pGsNode)
 
virtual OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 

Protected Attributes

double m_ElevationOfRefHeight
 
double m_ElevationOfTerrain
 
OdDAIObjectId m_BuildingAddress
 
- Protected Attributes inherited from OdIfc4::IfcSpatialStructureElement
OdDAI::Enum m_CompositionType
 
- Protected Attributes inherited from OdIfc4::IfcSpatialElement
OdAnsiString m_LongName
 
- Protected Attributes inherited from OdIfc4::IfcProduct
OdDAIObjectId m_ObjectPlacement
 
OdDAIObjectId m_Representation
 
- Protected Attributes inherited from OdIfc4::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc4::IfcRoot
OdIfcGUID m_GlobalId
 
OdDAIObjectId m_OwnerHistory
 
OdAnsiString m_Name
 
OdAnsiString m_Description
 
- Protected Attributes inherited from OdIfc::OdIfcEntity
voidm_resPtr
 
IfcOpResult m_resolved
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcEntity
static const OdGePoint3dasPoint3d (const OdIfcEntity *pEnt)
 
static const OdGePoint2dasPoint2d (const OdIfcEntity *pEnt)
 
static const OdGeVector3dasVector3d (const OdIfcEntity *pEnt)
 
static const OdGeVector2dasVector2d (const OdIfcEntity *pEnt)
 
static const OdGeMatrix2dasMatrix2d (const OdIfcEntity *pEnt)
 
static const OdGeMatrix3dasMatrix3d (const OdIfcEntity *pEnt)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcEntity > pEnt)
 
static const OdCmEntityColorasRgbColor (const OdIfcEntity *pEnt)
 
- Protected Member Functions inherited from OdIfc4::IfcObjectDefinition
virtual OdRxValue getAttr (const char *attrName) const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 

Detailed Description

A building represents a structure that provides shelter for its occupants or contents and stands in one place. The building also provides a basic element within the spatial structure hierarchy for the components of a building project (together with site, storey, and space). A building is (if specified) associated to a site. The site can include a collection of buildings that are organized as a building complex. A building can be decomposed in parts to define a building sections: COMPLEX: building complex ELEMENT: building PARTIAL: building section

The IfcBuilding is used to build the spatial structure of a building (that serves as the primary project breakdown and is required to be hierarchical).

Remarks
All statically defined property set entities are no longer subtypes of IfcPropertySet starting from Ifc4.

Definition at line 52 of file Ifc4/IfcBuildingAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcBuilding()

OdIfc4::IfcBuilding::IfcBuilding ( )

Default constructor for the IfcBuilding class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcBuilding::comparedToEarlyImpl ( const OdDAI::ApplicationInstance *  pOther,
OdRx::Ordering ordering 
) const
virtual

Early-bound version of instances comparison.

Parameters
pOther[in] Other application instance.
ordering[out] Receives the ordering (comparison) status.
Returns
true if comparison was performed, false if method has no implementation, so late-bound version could be applied.
Remarks
If the method returns true, the ordering parameter can receive one of the following statuses:
Value Description kLessThan -1 This object < Other Object. kEqual 0 This object = Other Object. kGreaterThan 1 This object > Other Object. kNotOrderable 2 This class is not orderable.

Reimplemented from OdIfc4::IfcSpatialStructureElement.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcBuilding::getAttr ( const char *  attrName) const
virtual

Returns an attribute value for the specified attribute name.

Parameters
attrName[in] Name of an attribute to query.
Returns
OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc4::IfcSpatialStructureElement.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcBuilding::getAttr ( const OdIfc::OdIfcAttribute  attrDef) const
virtual

Returns an attribute value for the specified attribute definition.

Parameters
attrDef[in] Attribute definition to query.
Returns
OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc4::IfcSpatialStructureElement.

◆ getBuildingAddress()

const OdDAIObjectId & OdIfc4::IfcBuilding::getBuildingAddress ( ) const

Returns the postal address of the building.

Returns
Identifier of the object that represents the postal address of the building.

◆ getElevationOfRefHeight()

double OdIfc4::IfcBuilding::getElevationOfRefHeight ( ) const

Returns the elevation above sea level of the reference height used for all storey elevation measures.

Returns
Elevation of the reference height that is usually the ground floor level.

◆ getElevationOfTerrain()

double OdIfc4::IfcBuilding::getElevationOfTerrain ( ) const

Returns the elevation above the minimal terrain level around the foot print of the building, given in elevation above sea level.

Returns
Elevation above the minimal terrain level.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcBuilding::getInstanceType ( ) const
virtual

Returns a type of a class instance.

Returns
Pointer to the <link OdDAI__Entity, OdDAI::Entity> type that determines an entity definition within a schema.

Reimplemented from OdIfc4::IfcSpatialStructureElement.

◆ inFields()

virtual OdResult OdIfc4::IfcBuilding::inFields ( OdDAI::OdSpfFilerBase *  rdFiler)
virtual

Reads object's data from the specified filer.

Parameters
rdFiler[in] Pointer to a filer from which to read the data.
Returns
A value of OdResult type that contains the result of the method execution.

Reimplemented from OdIfc4::IfcSpatialStructureElement.

◆ isKindOf()

virtual bool OdIfc4::IfcBuilding::isKindOf ( OdIfc::OdIfcEntityType  entityType) const
virtual

Checks whether the specified instance is the object derived from or belongs to this class.

Parameters
entityType[in] Entity to check.
Returns
true if the specified instance is the object derived from or belongs to this class, false otherwise.

Reimplemented from OdIfc4::IfcSpatialStructureElement.

◆ outFields()

virtual OdResult OdIfc4::IfcBuilding::outFields ( OdDAI::OdSpfFilerBase *  wrFiler)
virtual

Writes object's data the the specified filer.

Parameters
wrFiler[in] Pointer to a filer to which to write the data.
Returns
A value of OdResult type that contains the result of the method execution.

Reimplemented from OdIfc4::IfcSpatialStructureElement.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcBuilding::putAttr ( const char *  explicitAttrName,
const OdRxValue val 
)
virtual

Sets the specified attribute with a given value.

Parameters
explicitAttrName[in] Explicit name of the attribute to set.
val[in] Value to set.
Returns
true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc4::IfcSpatialStructureElement.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcBuilding::putAttr ( const OdIfc::OdIfcAttribute  explicitAttrDef,
const OdRxValue val 
)
virtual

Sets the specified attribute with a given value.

Parameters
explicitAttrDef[in] Explicit attribute definition to set.
val[in] Value to set.
Returns
true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc4::IfcSpatialStructureElement.

◆ setBuildingAddress()

void OdIfc4::IfcBuilding::setBuildingAddress ( const OdDAIObjectId &  BuildingAddress)

Sets the postal address of the building.

Parameters
BuildingAddress[in] Identifier of the object that represents the postal address of the building.

◆ setElevationOfRefHeight()

void OdIfc4::IfcBuilding::setElevationOfRefHeight ( double  ElevationOfRefHeight)

Sets the elevation above sea level of the reference height used for all storey elevation measures.

Parameters
ElevationOfRefHeight[in] Elevation of the reference height.

◆ setElevationOfTerrain()

void OdIfc4::IfcBuilding::setElevationOfTerrain ( double  ElevationOfTerrain)

Sets the elevation above the minimal terrain level around the foot print of the building, given in elevation above sea level.

Parameters
ElevationOfTerrain[in] Elevation above the minimal terrain level.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcBuilding::testAttr ( const char *  explicitAttrName) const
virtual

Checks whether the specified attribute is set.

Parameters
explicitAttrName[in] Explicit name of the attribute to test.
Returns
true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc4::IfcSpatialStructureElement.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcBuilding::testAttr ( const OdIfc::OdIfcAttribute  explicitAttrDef) const
virtual

Checks whether the specified attribute is set.

Parameters
explicitAttrDef[in] Attribute definition to test.
Returns
true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc4::IfcSpatialStructureElement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcBuilding::type ( ) const
virtual

Returns the type of this entity.

Returns
A value of the <link OdIfc__OdIfcEntityType, OdIfc::OdIfcEntityType> type that represents type of this entity.

Reimplemented from OdIfc4::IfcSpatialStructureElement.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcBuilding::unsetAttr ( const char *  explicitAttrName)
virtual

Resets a value for the specified attribute.

Parameters
explicitAttrName[in] Explicit name of the attribute to reset.

Reimplemented from OdIfc4::IfcSpatialStructureElement.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcBuilding::unsetAttr ( const OdIfc::OdIfcAttribute  explicitAttrDef)
virtual

Resets a value for the specified attribute.

Parameters
explicitAttrDef[in] Explicit definition that represents an attribute to reset.

Reimplemented from OdIfc4::IfcSpatialStructureElement.

Member Data Documentation

◆ m_BuildingAddress

OdDAIObjectId OdIfc4::IfcBuilding::m_BuildingAddress
protected

Definition at line 236 of file Ifc4/IfcBuildingAutoImpl.h.

◆ m_ElevationOfRefHeight

double OdIfc4::IfcBuilding::m_ElevationOfRefHeight
protected

Definition at line 234 of file Ifc4/IfcBuildingAutoImpl.h.

◆ m_ElevationOfTerrain

double OdIfc4::IfcBuilding::m_ElevationOfTerrain
protected

Definition at line 235 of file Ifc4/IfcBuildingAutoImpl.h.


The documentation for this class was generated from the following file: