#include <IfcSiteAutoImpl.h>

Inheritance diagram for OdIfc4x3_add2::IfcSite:

Public Member Functions
void	getRefLatitude (OdArray< int > &RefLatitude) const

OdDAI::ListOfInt &	refLatitude ()

void	getRefLongitude (OdArray< int > &RefLongitude) const

OdDAI::ListOfInt &	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) override

virtual OdResult	outFields (OdDAI::OdSpfFilerBase *wrFiler) override

virtual OdDAI::Entity *	getInstanceType () const override

virtual OdRxValue	getAttr (const char *attrName) const override

virtual bool	comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const override

virtual void	unsetAttr (const char *explicitAttrName) override

virtual bool	testAttr (const char *explicitAttrName) const override

virtual bool	putAttr (const char *explicitAttrName, const OdRxValue &val) override

virtual bool	isKindOf (OdIfc::OdIfcEntityType entityType) const override

virtual OdIfc::OdIfcEntityType	type () const override

virtual OdRxValue	getAttr (const OdIfc::OdIfcAttribute attrDef) const override

virtual void	unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef) override

virtual bool	testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const override

virtual bool	putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override

Public Member Functions inherited from OdIfc4x3_add2::IfcSpatialStructureElement
IfcElementCompositionEnum	getCompositionType () const

void	setCompositionType (IfcElementCompositionEnum CompositionType)

	IfcSpatialStructureElement ()

Public Member Functions inherited from OdIfc4x3_add2::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

void	getInvIsInterferedByElements (OdDAIObjectIds &IsInterferedByElements) const

void	getInvInterferesElements (OdDAIObjectIds &InterferesElements) const

	IfcSpatialElement ()

Public Member Functions inherited from OdIfc4x3_add2::IfcProduct
const OdDAIObjectId &	getObjectPlacement () const

void	setObjectPlacement (const OdDAIObjectId &ObjectPlacement)

const OdDAIObjectId &	getRepresentation () const

void	setRepresentation (const OdDAIObjectId &Representation)

void	getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const

void	getInvPositionedRelativeTo (OdDAIObjectIds &PositionedRelativeTo) const

void	getInvReferencedInStructures (OdDAIObjectIds &ReferencedInStructures) const

virtual void	setInverseCounterParts () override

Public Member Functions inherited from OdIfc4x3_add2::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 ()

Public Member Functions inherited from OdIfc4x3_add2::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

Public Member Functions inherited from OdIfc4x3_add2::IfcRoot
OdDAI::CompressedGUID	getGlobalId () const

void	setGlobalId (OdDAI::CompressedGUID 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 ()

Public Member Functions inherited from OdIfc4x3_add2::OdIfc4x3Instance
void	setInverseCounterParts () override

Public Member Functions inherited from OdIfc::OdIfcInstance
	ODRX_DECLARE_MEMBERS (OdIfcInstance)

	OdIfcInstance ()

	~OdIfcInstance ()

bool	isInstanceOf (OdIfcEntityType entityType) const

IfcOpResult	resolved ()

void	resolve (IfcOpResult resolved, void *resPtr)

void	unresolve ()

virtual void	setGsNode (OdGsCache *pGsNode)

virtual OdGsCache *	gsNode () const

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const

virtual OdDbStub *	ownerId () const

Protected Attributes
OdDAI::ListOfInt	m_RefLatitude

OdDAI::ListOfInt	m_RefLongitude

double	m_RefElevation

OdAnsiString	m_LandTitleNumber

OdDAIObjectId	m_SiteAddress

Protected Attributes inherited from OdIfc4x3_add2::IfcSpatialStructureElement
OdDAI::Enum	m_CompositionType

Protected Attributes inherited from OdIfc4x3_add2::IfcSpatialElement
OdAnsiString	m_LongName

Protected Attributes inherited from OdIfc4x3_add2::IfcProduct
OdDAIObjectId	m_ObjectPlacement

OdDAIObjectId	m_Representation

Protected Attributes inherited from OdIfc4x3_add2::IfcObject
OdAnsiString	m_ObjectType

Protected Attributes inherited from OdIfc4x3_add2::IfcRoot
OdDAI::CompressedGUID	m_GlobalId

OdDAIObjectId	m_OwnerHistory

OdAnsiString	m_Name

OdAnsiString	m_Description

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Additional Inherited Members
Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3d *	asPoint3d (const OdIfcInstance *inst)

static const OdGePoint2d *	asPoint2d (const OdIfcInstance *inst)

static const OdGeVector3d *	asVector3d (const OdIfcInstance *inst)

static const OdGeVector2d *	asVector2d (const OdIfcInstance *inst)

static const OdGeMatrix2d *	asMatrix2d (const OdIfcInstance *inst)

static const OdGeMatrix3d *	asMatrix3d (const OdIfcInstance *inst)

static OdIfcCompoundPtr	asCompound (OdSmartPtr< OdIfcInstance > inst)

static const OdCmEntityColor *	asRgbColor (const OdIfcInstance *inst)

Detailed Description

A site is a defined area of land, possibly covered with water, on which the project construction is to be completed. A site can be used to erect, retrofit or turn down building(s), or for other construction related developments.

Details - A site can 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, can 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.

\changes

IFC4X3_RC1 changes: Attribute LandTitleNumber is deprecated, use property LandTitleID at Pset_LandRegistration instead. Attribute SiteAddress is deprecated, use Pset_Address instead.

Definition at line 67 of file Ifc4x3/IfcSiteAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcSite()

OdIfc4x3_add2::IfcSite::IfcSite ( )

Default constructor for the IfcSite class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x3_add2::IfcSite::comparedToEarlyImpl	(	const OdDAI::ApplicationInstance *	pOther,
		OdRx::Ordering &	ordering ) const

overridevirtual

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 OdIfc4x3_add2::IfcSpatialStructureElement.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x3_add2::IfcSite::getAttr ( const char * attrName ) const

overridevirtual

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 OdIfc4x3_add2::IfcSpatialStructureElement.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x3_add2::IfcSite::getAttr ( const OdIfc::OdIfcAttribute attrDef ) const

overridevirtual

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 OdIfc4x3_add2::IfcSpatialStructureElement.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x3_add2::IfcSite::getInstanceType ( ) const

overridevirtual

Returns a type of a class instance.

Returns: Pointer to the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdDAI__Entity.html>>OdDAI::Entity</exref> type that determines an entity definition within a schema.

Reimplemented from OdIfc4x3_add2::IfcSpatialStructureElement.

◆ getLandTitleNumber()

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

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

Returns: Land title number.

Remarks: IFC4x3: This attribute will not be used for export, use property LandTitleID at Pset_LandRegistration instead.

◆ getRefElevation()

double OdIfc4x3_add2::IfcSite::getRefElevation ( ) const

Retrieves datum elevation relative to sea level.

Returns: Datum elevation relative to sea level.

◆ getRefLatitude()

void OdIfc4x3_add2::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 OdIfc4x3_add2::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 & OdIfc4x3_add2::IfcSite::getSiteAddress ( ) const

Returns the postal address of the site.

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

Remarks: IFC4x3: This attribute will not be used for export, use property LandTitleID at Pset_LandRegistration instead.

◆ inFields()

virtual OdResult OdIfc4x3_add2::IfcSite::inFields ( OdDAI::OdSpfFilerBase * rdFiler )

overridevirtual

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 OdIfc4x3_add2::IfcSpatialStructureElement.

◆ isKindOf()

virtual bool OdIfc4x3_add2::IfcSite::isKindOf ( OdIfc::OdIfcEntityType entityType ) const

overridevirtual

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 OdIfc4x3_add2::IfcSpatialStructureElement.

◆ outFields()

virtual OdResult OdIfc4x3_add2::IfcSite::outFields ( OdDAI::OdSpfFilerBase * wrFiler )

overridevirtual

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 OdIfc4x3_add2::IfcSpatialStructureElement.

◆ putAttr() [1/2]

virtual bool OdIfc4x3_add2::IfcSite::putAttr	(	const char *	explicitAttrName,
		const OdRxValue &	val )

overridevirtual

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 OdIfc4x3_add2::IfcSpatialStructureElement.

◆ putAttr() [2/2]

virtual bool OdIfc4x3_add2::IfcSite::putAttr	(	const OdIfc::OdIfcAttribute	explicitAttrDef,
		const OdRxValue &	val )

overridevirtual

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 OdIfc4x3_add2::IfcSpatialStructureElement.

◆ refLatitude()

OdDAI::ListOfInt & OdIfc4x3_add2::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::ListOfInt & OdIfc4x3_add2::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 OdIfc4x3_add2::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.

Remarks: IFC4x3: This attribute will not be used for export, use property LandTitleID at Pset_LandRegistration instead.

◆ setRefElevation()

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

Sets the datum elevation value relative to sea level.

Parameters

RefElevation [in] Datum elevation relative to sea level.

◆ setSiteAddress()

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

Sets the postal address of the site.

Parameters

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

Remarks: IFC4x3: This attribute will not be used for export, use property LandTitleID at Pset_LandRegistration instead.

◆ testAttr() [1/2]

virtual bool OdIfc4x3_add2::IfcSite::testAttr ( const char * explicitAttrName ) const

overridevirtual

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 OdIfc4x3_add2::IfcSpatialStructureElement.

◆ testAttr() [2/2]

virtual bool OdIfc4x3_add2::IfcSite::testAttr ( const OdIfc::OdIfcAttribute explicitAttrDef ) const

overridevirtual

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 OdIfc4x3_add2::IfcSpatialStructureElement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x3_add2::IfcSite::type ( ) const

overridevirtual

Returns the type of this entity.

Returns: A value of the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdIfc__OdIfcEntityType.html>>OdIfc::OdIfcEntityType</exref> type that represents type of this entity.

Reimplemented from OdIfc4x3_add2::IfcSpatialStructureElement.

◆ unsetAttr() [1/2]

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

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc4x3_add2::IfcSpatialStructureElement.

◆ unsetAttr() [2/2]

virtual void OdIfc4x3_add2::IfcSite::unsetAttr ( const OdIfc::OdIfcAttribute explicitAttrDef )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc4x3_add2::IfcSpatialStructureElement.

Member Data Documentation

◆ m_LandTitleNumber

OdAnsiString OdIfc4x3_add2::IfcSite::m_LandTitleNumber

protected

Definition at line 293 of file Ifc4x3/IfcSiteAutoImpl.h.

◆ m_RefElevation

double OdIfc4x3_add2::IfcSite::m_RefElevation

protected

Definition at line 292 of file Ifc4x3/IfcSiteAutoImpl.h.

◆ m_RefLatitude

OdDAI::ListOfInt OdIfc4x3_add2::IfcSite::m_RefLatitude

protected

Definition at line 288 of file Ifc4x3/IfcSiteAutoImpl.h.

◆ m_RefLongitude

OdDAI::ListOfInt OdIfc4x3_add2::IfcSite::m_RefLongitude

protected

Definition at line 290 of file Ifc4x3/IfcSiteAutoImpl.h.

◆ m_SiteAddress

OdDAIObjectId OdIfc4x3_add2::IfcSite::m_SiteAddress

protected

Definition at line 294 of file Ifc4x3/IfcSiteAutoImpl.h.

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

Ifc4x3/IfcSiteAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcSite()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getLandTitleNumber()

◆ getRefElevation()

◆ getRefLatitude()

◆ getRefLongitude()

◆ getSiteAddress()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ refLatitude()

◆ refLongitude()

◆ setLandTitleNumber()

◆ setRefElevation()

◆ setSiteAddress()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_LandTitleNumber

◆ m_RefElevation

◆ m_RefLatitude

◆ m_RefLongitude

◆ m_SiteAddress