#include <IfcPostalAddressAutoImpl.h>

Inheritance diagram for OdIfc2x2_final::IfcPostalAddress:

Public Member Functions
const OdAnsiString &	getInternalLocation () const

void	setInternalLocation (const OdAnsiString &InternalLocation)

void	getAddressLines (OdArray< OdAnsiString > &AddressLines) const

OdDAI::ListOfOdAnsiString &	addressLines ()

const OdAnsiString &	getPostalBox () const

void	setPostalBox (const OdAnsiString &PostalBox)

const OdAnsiString &	getTown () const

void	setTown (const OdAnsiString &Town)

const OdAnsiString &	getRegion () const

void	setRegion (const OdAnsiString &Region)

const OdAnsiString &	getPostalCode () const

void	setPostalCode (const OdAnsiString &PostalCode)

const OdAnsiString &	getCountry () const

void	setCountry (const OdAnsiString &Country)

	IfcPostalAddress ()

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 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 OdIfc2x2_final::IfcAddress
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 ()

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
OdAnsiString	m_InternalLocation

OdDAI::ListOfOdAnsiString	m_AddressLines

OdAnsiString	m_PostalBox

OdAnsiString	m_Town

OdAnsiString	m_Region

OdAnsiString	m_PostalCode

OdAnsiString	m_Country

Protected Attributes inherited from OdIfc2x2_final::IfcAddress
OdDAI::Enum	m_Purpose

OdAnsiString	m_Description

OdAnsiString	m_UserDefinedPurpose

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

This entity represents an address for delivery of paper based mail and other postal deliveries.

Remarks: This definition is DEPRECATED. Use Pset_Address instead, which is applicable to IfcActor, IfcBuilding and IfcSite.

Definition at line 43 of file Ifc2x2_Final/IfcPostalAddressAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcPostalAddress()

OdIfc2x2_final::IfcPostalAddress::IfcPostalAddress ( )

Default constructor for the IfcPostalAddress class.

Member Function Documentation

◆ addressLines()

OdDAI::ListOfOdAnsiString & OdIfc2x2_final::IfcPostalAddress::addressLines ( )

Returns the value of AddressLines attribute. This attribute represents the postal address.

Returns: Returns the value of AddressLines attribute.

Remarks: A postal address can occupy several lines (or elements) when recorded. It is expected that normal usage will incorporate relevant elements of the following address concepts: A location within a building (e.g. 3rd Floor) Building name (e.g. Interoperability House) Street number (e.g. 6400) Street name (e.g. Alliance Boulevard). Typical content of address lines can vary in different countries.

◆ getAddressLines()

void OdIfc2x2_final::IfcPostalAddress::getAddressLines ( OdArray< OdAnsiString > & AddressLines ) const

Sets the value of AddressLines attribute. This attribute represents the postal address.

Parameters

AddressLines [out] Receives the AddressLines attribute.

Remarks: A postal address can occupy several lines (or elements) when recorded. It is expected that normal usage will incorporate relevant elements of the following address concepts: A location within a building (e.g. 3rd Floor) Building name (e.g. Interoperability House) Street number (e.g. 6400) Street name (e.g. Alliance Boulevard). Typical content of address lines can vary in different countries.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x2_final::IfcPostalAddress::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 OdIfc2x2_final::IfcAddress.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x2_final::IfcPostalAddress::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 OdIfc2x2_final::IfcAddress.

◆ getCountry()

const OdAnsiString & OdIfc2x2_final::IfcPostalAddress::getCountry ( ) const

Returns the value of Country attribute. This attribute represents the name of a country.

Returns: Returns the value of Country attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x2_final::IfcPostalAddress::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 OdIfc2x2_final::IfcAddress.

◆ getInternalLocation()

const OdAnsiString & OdIfc2x2_final::IfcPostalAddress::getInternalLocation ( ) const

Returns the value of InternalLocation attribute. This attribute represents an organization defined address for internal mail delivery.

Returns: Returns the value of InternalLocation attribute.

◆ getPostalBox()

const OdAnsiString & OdIfc2x2_final::IfcPostalAddress::getPostalBox ( ) const

Returns the value of PostalBox attribute. This attribute represents an address that is implied by an identifiable mail drop.

Returns: Returns the value of PostalBox attribute.

◆ getPostalCode()

const OdAnsiString & OdIfc2x2_final::IfcPostalAddress::getPostalCode ( ) const

Returns the value of PostalCode attribute. This attribute represents the code that is used by the country's postal service.

Returns: Returns the value of PostalCode attribute.

◆ getRegion()

const OdAnsiString & OdIfc2x2_final::IfcPostalAddress::getRegion ( ) const

Returns the value of Region attribute. This attribute represents the name of a region.

Returns: Returns the value of Region attribute.

Remarks: The counties of the United Kingdom and the states of North America are examples of regions.

◆ getTown()

const OdAnsiString & OdIfc2x2_final::IfcPostalAddress::getTown ( ) const

Returns the value of Town attribute. This attribute represents the name of a town.

Returns: Returns the value of Town attribute.

◆ inFields()

virtual OdResult OdIfc2x2_final::IfcPostalAddress::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 OdIfc2x2_final::IfcAddress.

◆ isKindOf()

virtual bool OdIfc2x2_final::IfcPostalAddress::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 OdIfc2x2_final::IfcAddress.

◆ outFields()

virtual OdResult OdIfc2x2_final::IfcPostalAddress::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 OdIfc2x2_final::IfcAddress.

◆ putAttr() [1/2]

virtual bool OdIfc2x2_final::IfcPostalAddress::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 OdIfc2x2_final::IfcAddress.

◆ putAttr() [2/2]

virtual bool OdIfc2x2_final::IfcPostalAddress::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 OdIfc2x2_final::IfcAddress.

◆ setCountry()

void OdIfc2x2_final::IfcPostalAddress::setCountry ( const OdAnsiString & Country )

Sets the value of Country attribute. This attribute represents the name of a country.

Parameters

Country [in] Country to set.

◆ setInternalLocation()

void OdIfc2x2_final::IfcPostalAddress::setInternalLocation ( const OdAnsiString & InternalLocation )

Sets the value of InternalLocation attribute. This attribute represents an organization defined address for internal mail delivery.

Parameters

InternalLocation [in] Internal location to set.

◆ setPostalBox()

void OdIfc2x2_final::IfcPostalAddress::setPostalBox ( const OdAnsiString & PostalBox )

Sets the value of PostalBox attribute. This attribute represents an address that is implied by an identifiable mail drop.

Parameters

PostalBox [in] Postal box to set.

◆ setPostalCode()

void OdIfc2x2_final::IfcPostalAddress::setPostalCode ( const OdAnsiString & PostalCode )

Sets the value of PostalCode attribute. This attribute represents the code that is used by the country's postal service.

Parameters

PostalCode [in] Postal code to set.

◆ setRegion()

void OdIfc2x2_final::IfcPostalAddress::setRegion ( const OdAnsiString & Region )

Sets the value of Region attribute. This attribute represents the name of a region.

Parameters

Region [in] Region to set.

Remarks: The counties of the United Kingdom and the states of North America are examples of regions.

◆ setTown()

void OdIfc2x2_final::IfcPostalAddress::setTown ( const OdAnsiString & Town )

Sets the value of Town attribute. This attribute represents the name of a town.

Parameters

Town	[in] Town to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x2_final::IfcPostalAddress::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 OdIfc2x2_final::IfcAddress.

◆ testAttr() [2/2]

virtual bool OdIfc2x2_final::IfcPostalAddress::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 OdIfc2x2_final::IfcAddress.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x2_final::IfcPostalAddress::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 OdIfc2x2_final::IfcAddress.

◆ unsetAttr() [1/2]

virtual void OdIfc2x2_final::IfcPostalAddress::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc2x2_final::IfcAddress.

◆ unsetAttr() [2/2]

virtual void OdIfc2x2_final::IfcPostalAddress::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 OdIfc2x2_final::IfcAddress.

Member Data Documentation

◆ m_AddressLines

OdDAI::ListOfOdAnsiString OdIfc2x2_final::IfcPostalAddress::m_AddressLines

protected

Definition at line 287 of file Ifc2x2_Final/IfcPostalAddressAutoImpl.h.

◆ m_Country

OdAnsiString OdIfc2x2_final::IfcPostalAddress::m_Country

protected

Definition at line 293 of file Ifc2x2_Final/IfcPostalAddressAutoImpl.h.

◆ m_InternalLocation

OdAnsiString OdIfc2x2_final::IfcPostalAddress::m_InternalLocation

protected

Definition at line 286 of file Ifc2x2_Final/IfcPostalAddressAutoImpl.h.

◆ m_PostalBox

OdAnsiString OdIfc2x2_final::IfcPostalAddress::m_PostalBox

protected

Definition at line 289 of file Ifc2x2_Final/IfcPostalAddressAutoImpl.h.

◆ m_PostalCode

OdAnsiString OdIfc2x2_final::IfcPostalAddress::m_PostalCode

protected

Definition at line 292 of file Ifc2x2_Final/IfcPostalAddressAutoImpl.h.

◆ m_Region

OdAnsiString OdIfc2x2_final::IfcPostalAddress::m_Region

protected

Definition at line 291 of file Ifc2x2_Final/IfcPostalAddressAutoImpl.h.

◆ m_Town

OdAnsiString OdIfc2x2_final::IfcPostalAddress::m_Town

protected

Definition at line 290 of file Ifc2x2_Final/IfcPostalAddressAutoImpl.h.

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

Ifc2x2_Final/IfcPostalAddressAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcPostalAddress()

Member Function Documentation

◆ addressLines()

◆ getAddressLines()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getCountry()

◆ getInstanceType()

◆ getInternalLocation()

◆ getPostalBox()

◆ getPostalCode()

◆ getRegion()

◆ getTown()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setCountry()

◆ setInternalLocation()

◆ setPostalBox()

◆ setPostalCode()

◆ setRegion()

◆ setTown()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_AddressLines

◆ m_Country

◆ m_InternalLocation

◆ m_PostalBox

◆ m_PostalCode

◆ m_Region

◆ m_Town