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

#include <IfcSiteAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcSite:
OdIfc2x_final::IfcSpatialStructureElement OdIfc2x_final::IfcProduct OdIfc2x_final::IfcObject OdIfc2x_final::IfcRoot OdIfc::OdIfcEntity

Public Member Functions

void getRefLatitude (OdArray< int > &RefLatitude) const
 
OdDAI::IntList & refLatitude ()
 
void getRefLongitude (OdArray< int > &RefLongitude) const
 
OdDAI::IntList & refLongitude ()
 
double getRefElevation () const
 
void setRefElevation (double RefElevation)
 
const OdAnsiString & getLandTitleNumber () const
 
void setLandTitleNumber (const OdAnsiString &LandTitleNumber)
 
const OdDAIObjectId & getSiteAddress () const
 
void setSiteAddress (const OdDAIObjectId &SiteAddress)
 
 IfcSite ()
 
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 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 OdIfc2x_final::IfcSpatialStructureElement
const OdAnsiString & getLongName () const
 
void setLongName (const OdAnsiString &LongName)
 
IfcElementCompositionEnum getCompositionType () const
 
void setCompositionType (IfcElementCompositionEnum CompositionType)
 
void getInvContainsElements (OdDAIObjectIds &ContainsElements) const
 
 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 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 OdIfc2x_final::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 OdDAI::Entity * getInstanceType () const
 
virtual OdRxValue getAttr (const char *attrName) 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 OdIfc2x_final::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) 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 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 OdIfc2x_final::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 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

OdDAI::IntList m_RefLatitude
 
OdDAI::IntList m_RefLongitude
 
double m_RefElevation
 
OdAnsiString m_LandTitleNumber
 
OdDAIObjectId m_SiteAddress
 
- Protected Attributes inherited from OdIfc2x_final::IfcSpatialStructureElement
OdAnsiString m_LongName
 
OdDAI::Enum m_CompositionType
 
- Protected Attributes inherited from OdIfc2x_final::IfcProduct
OdDAIObjectId m_ObjectPlacement
 
OdDAIObjectId m_Representation
 
- Protected Attributes inherited from OdIfc2x_final::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc2x_final::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)
 

Detailed Description

A site may include a definition of the single geographic reference point for this site (global position using WGS84 with Longitude, Latitude and Elevation). The precision is provided up to millionth of a second and it provides an absolute placement in relation to the real world as used in exchange with geospational information systems. If asserted, the Longitude, Latitude and Elevation establish the point in WGS84 where the point 0.,0.,0. of the LocalPlacement of IfcSite is situated.

The geometrical placement of the site, defined by the IfcLocalPlacement, shall be always relative to the spatial structure element, in which this site is included, or absolute, i.e. to the world coordinate system, as established by the geometric representation context of the project. The world coordinate system, established at the IfcProject.RepresentationContexts, may include a definition of the true north within the XY plane of the world coordinate system, if provided, it can be obtained at IfcGeometricRepresentationContext.TrueNorth.

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

The following image shows the heights and elevations of the IfcSite. <IMAGE ifc_ifcSite_elevation>

Definition at line 60 of file Ifc2x_Final/IfcSiteAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcSite()

OdIfc2x_final::IfcSite::IfcSite ( )

Default constructor for the IfcSite class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x_final::IfcSite::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x_final::IfcSite::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x_final::IfcSite::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ getLandTitleNumber()

const OdAnsiString & OdIfc2x_final::IfcSite::getLandTitleNumber ( ) const

Retrieves the land title number that designates of the site within a regional system.

Returns
Land title number.

◆ getRefElevation()

double OdIfc2x_final::IfcSite::getRefElevation ( ) const

Retrieves datum elevation relative to sea level.

Returns
Datum elevation relative to sea level.

◆ getRefLatitude()

void OdIfc2x_final::IfcSite::getRefLatitude ( OdArray< int > &  RefLatitude) const

Retrieves the World Latitude at reference point.

Parameters
RefLatitude[out] Receives an array of integer values for degrees, minutes, seconds, and, optionally, millionths of seconds with respect to the world geodetic system WGS84.

◆ getRefLongitude()

void OdIfc2x_final::IfcSite::getRefLongitude ( OdArray< int > &  RefLongitude) const

Retrieves the World Longitude at reference point.

Parameters
RefLongitude[out] Receives an array of integer values for degrees, minutes, seconds, and, optionally, millionths of seconds with respect to the world geodetic system WGS84.
Remarks
Latitudes are measured relative to the geodetic equator, north of the equator by positive values - from 0 till +90, south of the equator by negative values - from 0 till -90.

◆ getSiteAddress()

const OdDAIObjectId & OdIfc2x_final::IfcSite::getSiteAddress ( ) const

Returns the postal address of the site.

Returns
Identifier of the object that represents a postal address of the site.

◆ inFields()

virtual OdResult OdIfc2x_final::IfcSite::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ isKindOf()

virtual bool OdIfc2x_final::IfcSite::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ outFields()

virtual OdResult OdIfc2x_final::IfcSite::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::IfcSite::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcSite::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ refLatitude()

OdDAI::IntList & OdIfc2x_final::IfcSite::refLatitude ( )

Returns the World Latitude at reference point.

Returns
Integer list of values for degrees, minutes, seconds, and, optionally, millionths of seconds with respect to the world geodetic system WGS84.

◆ refLongitude()

OdDAI::IntList & OdIfc2x_final::IfcSite::refLongitude ( )

Returns the World Longitude at reference point.

Returns
Integer list of values for degrees, minutes, seconds, and, optionally, millionths of seconds with respect to the world geodetic system WGS84.
Remarks
Longitudes are measured relative to the geodetic zero meridian, nominally the same as the Greenwich prime meridian: longitudes west of the zero meridian have negative values - from 0 till -180, longitudes east of the zero meridian have positive values - from 0 till -180.

◆ setLandTitleNumber()

void OdIfc2x_final::IfcSite::setLandTitleNumber ( const OdAnsiString &  LandTitleNumber)

Sets the land title number that designates of the site within a regional system.

Parameters
LandTitleNumber[in] Land title number.

◆ setRefElevation()

void OdIfc2x_final::IfcSite::setRefElevation ( double  RefElevation)

Sets the datum elevation value relative to sea level.

Parameters
RefElevation[in] Datum elevation relative to sea level.

◆ setSiteAddress()

void OdIfc2x_final::IfcSite::setSiteAddress ( const OdDAIObjectId &  SiteAddress)

Sets the postal address of the site.

Parameters
PostalAddress[in] Identifier of the postal address of the site.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcSite::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcSite::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcSite::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 OdIfc2x_final::IfcSpatialStructureElement.

◆ unsetAttr() [1/2]

virtual void OdIfc2x_final::IfcSite::unsetAttr ( const char *  explicitAttrName)
virtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc2x_final::IfcSpatialStructureElement.

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcSite::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 OdIfc2x_final::IfcSpatialStructureElement.

Member Data Documentation

◆ m_LandTitleNumber

OdAnsiString OdIfc2x_final::IfcSite::m_LandTitleNumber
protected

Definition at line 259 of file Ifc2x_Final/IfcSiteAutoImpl.h.

◆ m_RefElevation

double OdIfc2x_final::IfcSite::m_RefElevation
protected

Definition at line 258 of file Ifc2x_Final/IfcSiteAutoImpl.h.

◆ m_RefLatitude

OdDAI::IntList OdIfc2x_final::IfcSite::m_RefLatitude
protected

Definition at line 254 of file Ifc2x_Final/IfcSiteAutoImpl.h.

◆ m_RefLongitude

OdDAI::IntList OdIfc2x_final::IfcSite::m_RefLongitude
protected

Definition at line 256 of file Ifc2x_Final/IfcSiteAutoImpl.h.

◆ m_SiteAddress

OdDAIObjectId OdIfc2x_final::IfcSite::m_SiteAddress
protected

Definition at line 260 of file Ifc2x_Final/IfcSiteAutoImpl.h.


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