#include <IfcAddressAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcAddress:

Public Member Functions
IfcAddressTypeEnum	getPurpose () const

void	setPurpose (IfcAddressTypeEnum Purpose)

const OdAnsiString &	getDescription () const

void	setDescription (const OdAnsiString &Description)

const OdAnsiString &	getUserDefinedPurpose () const

void	setUserDefinedPurpose (const OdAnsiString &UserDefinedPurpose)

void	getInvOfPerson (OdDAIObjectIds &OfPerson) const

void	getInvOfOrganization (OdDAIObjectIds &OfOrganization) const

	IfcAddress ()

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 OdIfc2x3::OdIfc2x3Instance
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::Enum	m_Purpose

OdAnsiString	m_Description

OdAnsiString	m_UserDefinedPurpose

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Friends
class	IfcPerson

class	IfcOrganization

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

This abstract entity represents various kinds of postal and telecom addresses.

Remarks: This definition may not be instantiated.

Definition at line 47 of file Ifc2x3/IfcAddressAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcAddress()

OdIfc2x3::IfcAddress::IfcAddress ( )

Default constructor for the IfcAddress class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcAddress::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 in OdIfc2x3::IfcPostalAddress, and OdIfc2x3::IfcTelecomAddress.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcAddress::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 in OdIfc2x3::IfcPostalAddress, and OdIfc2x3::IfcTelecomAddress.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcAddress::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcPostalAddress, and OdIfc2x3::IfcTelecomAddress.

◆ getDescription()

const OdAnsiString & OdIfc2x3::IfcAddress::getDescription ( ) const

Returns the value of Description attribute. This attribute represents text that relates the nature of the address.

Returns: Returns the value of Description attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcAddress::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 in OdIfc2x3::IfcPostalAddress, and OdIfc2x3::IfcTelecomAddress.

◆ getInvOfOrganization()

void OdIfc2x3::IfcAddress::getInvOfOrganization ( OdDAIObjectIds & OfOrganization ) const

Returns the value of OfOrganization attribute. This attribute represents the inverse relationship to Organization to whom address is associated.

Parameters

OfOrganization [out] Receives the value of OfOrganization attribute.

◆ getInvOfPerson()

void OdIfc2x3::IfcAddress::getInvOfPerson ( OdDAIObjectIds & OfPerson ) const

Returns the value of OfPerson attribute. This attribute represents the inverse relationship to Person to whom address is associated.

Parameters

OfPerson [out] Receives the value of OfPerson attribute.

◆ getPurpose()

IfcAddressTypeEnum OdIfc2x3::IfcAddress::getPurpose ( ) const

Returns the value of Purpose attribute. This attribute represents the logical location of the address.

Returns: Returns the value of Purpose attribute.

◆ getUserDefinedPurpose()

const OdAnsiString & OdIfc2x3::IfcAddress::getUserDefinedPurpose ( ) const

Returns the value of UserDefinedPurpose attribute. This attribute allows for specification of user-specific purpose of the address beyond the enumeration values provided by Purpose attribute of type IfcAddressTypeEnum.When a value is provided for attribute UserDefinedPurpose, in parallel the attribute Purpose has enumeration value USERDEFINED.

Returns: Returns the value of UserDefinedPurpose attribute.

◆ inFields()

virtual OdResult OdIfc2x3::IfcAddress::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 in OdIfc2x3::IfcPostalAddress, and OdIfc2x3::IfcTelecomAddress.

◆ isKindOf()

virtual bool OdIfc2x3::IfcAddress::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcPostalAddress, and OdIfc2x3::IfcTelecomAddress.

◆ outFields()

virtual OdResult OdIfc2x3::IfcAddress::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 in OdIfc2x3::IfcPostalAddress, and OdIfc2x3::IfcTelecomAddress.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcAddress::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcPostalAddress, and OdIfc2x3::IfcTelecomAddress.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcAddress::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcPostalAddress, and OdIfc2x3::IfcTelecomAddress.

◆ setDescription()

void OdIfc2x3::IfcAddress::setDescription ( const OdAnsiString & Description )

Sets the value of Description attribute. This attribute represents text that relates the nature of the address.

Parameters

Description [in] Description to set.

◆ setPurpose()

void OdIfc2x3::IfcAddress::setPurpose ( IfcAddressTypeEnum Purpose )

Sets the value of Purpose attribute. This attribute represents the logical location of the address.

Parameters

Purpose [in] Purpose to set.

◆ setUserDefinedPurpose()

void OdIfc2x3::IfcAddress::setUserDefinedPurpose ( const OdAnsiString & UserDefinedPurpose )

Sets the value of UserDefinedPurpose attribute. This attribute allows for specification of user-specific purpose of the address beyond the enumeration values provided by Purpose attribute of IfcAddressTypeEnum.When type a value is provided for attribute UserDefinedPurpose, in parallel the attribute Purpose has enumeration value USERDEFINED.

Parameters

UserDefinedPurpose [in] User-defined purpose to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcAddress::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcPostalAddress, and OdIfc2x3::IfcTelecomAddress.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcAddress::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcPostalAddress, and OdIfc2x3::IfcTelecomAddress.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcAddress::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcPostalAddress, and OdIfc2x3::IfcTelecomAddress.