CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x_final::IfcTelecomAddress Class Reference

#include <IfcTelecomAddressAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcTelecomAddress:
OdIfc2x_final::IfcAddress OdIfc2x_final::OdIfc2x_FinalInstance OdIfc::OdIfcInstance

Public Member Functions

void getTelephoneNumbers (OdArray< OdAnsiString > &TelephoneNumbers) const
 
OdDAI::ListOfOdAnsiString & telephoneNumbers ()
 
void getFacsimileNumbers (OdArray< OdAnsiString > &FacsimileNumbers) const
 
OdDAI::ListOfOdAnsiString & facsimileNumbers ()
 
const OdAnsiString & getPagerNumber () const
 
void setPagerNumber (const OdAnsiString &PagerNumber)
 
void getElectronicMailAddresses (OdArray< OdAnsiString > &ElectronicMailAddresses) const
 
OdDAI::ListOfOdAnsiString & electronicMailAddresses ()
 
const OdAnsiString & getWWWHomePageURL () const
 
void setWWWHomePageURL (const OdAnsiString &WWWHomePageURL)
 
 IfcTelecomAddress ()
 
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 OdIfc2x_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 OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdDAI::ListOfOdAnsiString m_TelephoneNumbers
 
OdDAI::ListOfOdAnsiString m_FacsimileNumbers
 
OdAnsiString m_PagerNumber
 
OdDAI::ListOfOdAnsiString m_ElectronicMailAddresses
 
OdAnsiString m_WWWHomePageURL
 
- Protected Attributes inherited from OdIfc2x_final::IfcAddress
OdDAI::Enum m_Purpose
 
OdAnsiString m_Description
 
OdAnsiString m_UserDefinedPurpose
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3dasPoint3d (const OdIfcInstance *inst)
 
static const OdGePoint2dasPoint2d (const OdIfcInstance *inst)
 
static const OdGeVector3dasVector3d (const OdIfcInstance *inst)
 
static const OdGeVector2dasVector2d (const OdIfcInstance *inst)
 
static const OdGeMatrix2dasMatrix2d (const OdIfcInstance *inst)
 
static const OdGeMatrix3dasMatrix3d (const OdIfcInstance *inst)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcInstance > inst)
 
static const OdCmEntityColorasRgbColor (const OdIfcInstance *inst)
 

Detailed Description

This entity represents an address to which telephone, electronic mail and other forms of telecommunications should be addressed.

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

Definition at line 43 of file Ifc2x_Final/IfcTelecomAddressAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcTelecomAddress()

OdIfc2x_final::IfcTelecomAddress::IfcTelecomAddress ( )

Default constructor for the IfcTelecomAddress class.

Member Function Documentation

◆ electronicMailAddresses()

OdDAI::ListOfOdAnsiString & OdIfc2x_final::IfcTelecomAddress::electronicMailAddresses ( )

◆ facsimileNumbers()

OdDAI::ListOfOdAnsiString & OdIfc2x_final::IfcTelecomAddress::facsimileNumbers ( )

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x_final::IfcTelecomAddress::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 OdIfc2x_final::IfcAddress.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x_final::IfcTelecomAddress::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 OdIfc2x_final::IfcAddress.

◆ getElectronicMailAddresses()

void OdIfc2x_final::IfcTelecomAddress::getElectronicMailAddresses ( OdArray< OdAnsiString > & ElectronicMailAddresses) const

Returns the value of ElectronicMailAddresses attribute. This attribute represents the list of email addresses at which email messages can be received.

Returns
Returns the value of ElectronicMailAddresses attribute.

◆ getFacsimileNumbers()

void OdIfc2x_final::IfcTelecomAddress::getFacsimileNumbers ( OdArray< OdAnsiString > & FacsimileNumbers) const

Returns the value of FacsimileNumbers attribute. This attribute represents the list of fax numbers at which fax messages can be received.

Returns
Returns the value of FacsimileNumbers attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x_final::IfcTelecomAddress::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 OdIfc2x_final::IfcAddress.

◆ getPagerNumber()

const OdAnsiString & OdIfc2x_final::IfcTelecomAddress::getPagerNumber ( ) const

Returns the value of PagerNumber attribute. This attribute represents the pager number at which paging messages can be received.

Returns
Returns the value of PagerNumber attribute.

◆ getTelephoneNumbers()

void OdIfc2x_final::IfcTelecomAddress::getTelephoneNumbers ( OdArray< OdAnsiString > & TelephoneNumbers) const

Sets the value of TelephoneNumbers attribute. This attribute represents the list of telephone numbers at which telephone messages can be received.

Parameters
TelephoneNumbers[in] Telephone numbers to set.

◆ getWWWHomePageURL()

const OdAnsiString & OdIfc2x_final::IfcTelecomAddress::getWWWHomePageURL ( ) const

Returns the value of WWWHomePageURL attribute. This attribute represents the world wide web address at which the preliminary page of information for the person or organization can be located.

Returns
Returns the value of WWWHomePageURL attribute.
Remarks
Information on the world wide web for a person or organization can be separated into a number of pages and across a number of host sites, all of which can be linked together. It is assumed that all such information can be referenced from a single page that is termed the home page for that person or organization.

◆ inFields()

virtual OdResult OdIfc2x_final::IfcTelecomAddress::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 OdIfc2x_final::IfcAddress.

◆ isKindOf()

virtual bool OdIfc2x_final::IfcTelecomAddress::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 OdIfc2x_final::IfcAddress.

◆ outFields()

virtual OdResult OdIfc2x_final::IfcTelecomAddress::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 OdIfc2x_final::IfcAddress.

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::IfcTelecomAddress::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 OdIfc2x_final::IfcAddress.

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcTelecomAddress::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 OdIfc2x_final::IfcAddress.

◆ setPagerNumber()

void OdIfc2x_final::IfcTelecomAddress::setPagerNumber ( const OdAnsiString & PagerNumber)

Sets the value of PagerNumber attribute. This attribute represents the pager number at which paging messages can be received.

Parameters
PagerNumber[in] Pager number to set.

◆ setWWWHomePageURL()

void OdIfc2x_final::IfcTelecomAddress::setWWWHomePageURL ( const OdAnsiString & WWWHomePageURL)

Sets the value of WWWHomePageURL attribute. This attribute represents the world wide web address at which the preliminary page of information for the person or organization can be located.

Parameters
WWWHomePageURL[in] WWWHomePageURL to set.
Remarks
Information on the world wide web for a person or organization can be separated into a number of pages and across a number of host sites, all of which can be linked together. It is assumed that all such information can be referenced from a single page that is termed the home page for that person or organization.

◆ telephoneNumbers()

OdDAI::ListOfOdAnsiString & OdIfc2x_final::IfcTelecomAddress::telephoneNumbers ( )

Returns the value of TelephoneNumbers attribute. This attribute represents the list of telephone numbers at which telephone messages can be received.

Returns
Returns the value of TelephoneNumbers attribute.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcTelecomAddress::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 OdIfc2x_final::IfcAddress.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcTelecomAddress::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 OdIfc2x_final::IfcAddress.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcTelecomAddress::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 OdIfc2x_final::IfcAddress.

◆ unsetAttr() [1/2]

virtual void OdIfc2x_final::IfcTelecomAddress::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc2x_final::IfcAddress.

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcTelecomAddress::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 OdIfc2x_final::IfcAddress.

Member Data Documentation

◆ m_ElectronicMailAddresses

OdDAI::ListOfOdAnsiString OdIfc2x_final::IfcTelecomAddress::m_ElectronicMailAddresses
protected

Definition at line 247 of file Ifc2x_Final/IfcTelecomAddressAutoImpl.h.

◆ m_FacsimileNumbers

OdDAI::ListOfOdAnsiString OdIfc2x_final::IfcTelecomAddress::m_FacsimileNumbers
protected

Definition at line 244 of file Ifc2x_Final/IfcTelecomAddressAutoImpl.h.

◆ m_PagerNumber

OdAnsiString OdIfc2x_final::IfcTelecomAddress::m_PagerNumber
protected

Definition at line 246 of file Ifc2x_Final/IfcTelecomAddressAutoImpl.h.

◆ m_TelephoneNumbers

OdDAI::ListOfOdAnsiString OdIfc2x_final::IfcTelecomAddress::m_TelephoneNumbers
protected

Definition at line 242 of file Ifc2x_Final/IfcTelecomAddressAutoImpl.h.

◆ m_WWWHomePageURL

OdAnsiString OdIfc2x_final::IfcTelecomAddress::m_WWWHomePageURL
protected

Definition at line 249 of file Ifc2x_Final/IfcTelecomAddressAutoImpl.h.


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