CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x1::IfcPerson Class Reference

#include <IfcPersonAutoImpl.h>

Inheritance diagram for OdIfc4x1::IfcPerson:
OdIfc4x1::OdIfc4x1Instance OdIfc::OdIfcInstance

Public Member Functions

const OdAnsiString & getIdentification () const
 
void setIdentification (const OdAnsiString &Identification)
 
const OdAnsiString & getFamilyName () const
 
void setFamilyName (const OdAnsiString &FamilyName)
 
const OdAnsiString & getGivenName () const
 
void setGivenName (const OdAnsiString &GivenName)
 
void getMiddleNames (OdArray< OdAnsiString > &MiddleNames) const
 
OdDAI::ListOfOdAnsiString & middleNames ()
 
void getPrefixTitles (OdArray< OdAnsiString > &PrefixTitles) const
 
OdDAI::ListOfOdAnsiString & prefixTitles ()
 
void getSuffixTitles (OdArray< OdAnsiString > &SuffixTitles) const
 
OdDAI::ListOfOdAnsiString & suffixTitles ()
 
void getRoles (OdDAIObjectIds &Roles) const
 
OdDAI::ListOfOdDAIObjectId & roles ()
 
void getAddresses (OdDAIObjectIds &Addresses) const
 
OdDAI::ListOfOdDAIObjectId & addresses ()
 
void getInvEngagedIn (OdDAIObjectIds &EngagedIn) const
 
 IfcPerson ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) override
 
virtual void setInverseCounterParts () 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 OdIfc4x1::OdIfc4x1Instance
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 OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdAnsiString m_Identification
 
OdAnsiString m_FamilyName
 
OdAnsiString m_GivenName
 
OdDAI::ListOfOdAnsiString m_MiddleNames
 
OdDAI::ListOfOdAnsiString m_PrefixTitles
 
OdDAI::ListOfOdAnsiString m_SuffixTitles
 
OdDAI::ListOfOdDAIObjectId m_Roles
 
OdDAI::ListOfOdDAIObjectId m_Addresses
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcPersonAndOrganization
 

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 individual human being.

\changes

IFC4 changes: Attribute Id renamed to Identification.

Definition at line 49 of file Ifc4x1/IfcPersonAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcPerson()

OdIfc4x1::IfcPerson::IfcPerson ( )

Default constructor for the IfcPerson class.

Member Function Documentation

◆ addresses()

OdDAI::ListOfOdDAIObjectId & OdIfc4x1::IfcPerson::addresses ( )

Returns the value of Addresses attribute. This attribute represents postal and telecommunication addresses of a person.

Returns
Returns the value of Addresses attribute.
Remarks
A person can have several addresses.

◆ getAddresses()

void OdIfc4x1::IfcPerson::getAddresses ( OdDAIObjectIds & Addresses) const

Sets the value of Addresses attribute. This attribute represents postal and telecommunication addresses of a person.

Parameters
Addresses[out] Receives the Addresses attribute.
Remarks
A person can have several addresses.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x1::IfcPerson::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.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x1::IfcPerson::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.

◆ getFamilyName()

const OdAnsiString & OdIfc4x1::IfcPerson::getFamilyName ( ) const

Returns the value of FamilyName attribute. This attribute represents the name by which the family identity of the person can be recognized.

Returns
Returns the value of FamilyName attribute.
Remarks
Depending on geographical location and culture, family name can appear either as the first or last component of a name.

◆ getGivenName()

const OdAnsiString & OdIfc4x1::IfcPerson::getGivenName ( ) const

Returns the value of GivenName attribute. This attribute represents the name by which a person is known within a family and by which he or she can be recognized.

Returns
Returns the value of GivenName attribute.
Remarks
Depending on geographical location and culture, given name can appear either as the first or last component of a name.

◆ getIdentification()

const OdAnsiString & OdIfc4x1::IfcPerson::getIdentification ( ) const

Returns the value of Identification attribute. This attribute represents identification of the person.

Returns
Returns the value of Identification attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x1::IfcPerson::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.

◆ getInvEngagedIn()

void OdIfc4x1::IfcPerson::getInvEngagedIn ( OdDAIObjectIds & EngagedIn) const

Returns the value of EngagedIn attribute. This attribute represents the inverse relationship to IfcPersonAndOrganization relationships in which IfcPerson is engaged.

Parameters
EngagedIn[out] Receives the value of EngagedIn attribute.

◆ getMiddleNames()

void OdIfc4x1::IfcPerson::getMiddleNames ( OdArray< OdAnsiString > & MiddleNames) const

Gets the value of MiddleNames attribute. This attribute represents additional names given to a person that enable their identification apart from others who can have the same or similar family and given names.

Parameters
MiddleNames[out] Receives the MiddleNames attribute.
Remarks
Middle names are not normally used in familiar communication but can be asserted to provide additional identification of a particular person if necessary. They can be particularly useful in situations where the person has a family name that occurs commonly in the geographical region.

◆ getPrefixTitles()

void OdIfc4x1::IfcPerson::getPrefixTitles ( OdArray< OdAnsiString > & PrefixTitles) const

Sets the value of PrefixTitles attribute. This attribute represents the word, or group of words, which specify the person's social and/or professional standing and appear before his/her names.

Parameters
PrefixTitles[out] Receives the PrefixTitles attribute.

◆ getRoles()

void OdIfc4x1::IfcPerson::getRoles ( OdDAIObjectIds & Roles) const

Gets the value of Roles attribute. This attribute represents roles played by the person.

Parameters
Roles[out] Receives the Roles attribute.

◆ getSuffixTitles()

void OdIfc4x1::IfcPerson::getSuffixTitles ( OdArray< OdAnsiString > & SuffixTitles) const

Gets the value of SuffixTitles attribute. This attribute represents the word, or group of words, which specify the person's social and/or professional standing and appear after his/her names.

Parameters
SuffixTitles[out] Receives the SuffixTitles attribute.

◆ inFields()

virtual OdResult OdIfc4x1::IfcPerson::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.

◆ isKindOf()

virtual bool OdIfc4x1::IfcPerson::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.

◆ middleNames()

OdDAI::ListOfOdAnsiString & OdIfc4x1::IfcPerson::middleNames ( )

Returns the value of MiddleNames attribute. This attribute represents additional names given to a person that enable their identification apart from others who can have the same or similar family and given names.

Returns
Returns the value of MiddleNames attribute.
Remarks
Middle names are not normally used in familiar communication but can be asserted to provide additional identification of a particular person if necessary. They can be particularly useful in situations where the person has a family name that occurs commonly in the geographical region.

◆ outFields()

virtual OdResult OdIfc4x1::IfcPerson::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.

◆ prefixTitles()

OdDAI::ListOfOdAnsiString & OdIfc4x1::IfcPerson::prefixTitles ( )

Returns the value of PrefixTitles attribute. This attribute represents the word, or group of words, which specify the person's social and/or professional standing and appear before his/her names.

Returns
Returns the value of PrefixTitles attribute.

◆ putAttr() [1/2]

virtual bool OdIfc4x1::IfcPerson::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.

◆ putAttr() [2/2]

virtual bool OdIfc4x1::IfcPerson::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.

◆ roles()

OdDAI::ListOfOdDAIObjectId & OdIfc4x1::IfcPerson::roles ( )

Returns the value of Roles attribute. This attribute represents roles played by the person.

Returns
Returns the value of Roles attribute.

◆ setFamilyName()

void OdIfc4x1::IfcPerson::setFamilyName ( const OdAnsiString & FamilyName)

Sets the value of FamilyName attribute. This attribute represents the name by which the family identity of the person can be recognized.

Parameters
FamilyName[in] Family name to set.
Remarks
Depending on geographical location and culture, family name can appear either as the first or last component of a name.

◆ setGivenName()

void OdIfc4x1::IfcPerson::setGivenName ( const OdAnsiString & GivenName)

Sets the value of GivenName attribute. This attribute represents the name by which a person is known within a family and by which he or she can be recognized.

Parameters
GivenName[in] Given name to set.
Remarks
Depending on geographical location and culture, given name can appear either as the first or last component of a name.

◆ setIdentification()

void OdIfc4x1::IfcPerson::setIdentification ( const OdAnsiString & Identification)

Sets the value of Identification attribute. This attribute represents identification of the person.

Parameters
Identification[in] Identification to set.

◆ setInverseCounterParts()

virtual void OdIfc4x1::IfcPerson::setInverseCounterParts ( )
overridevirtual

Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.

◆ suffixTitles()

OdDAI::ListOfOdAnsiString & OdIfc4x1::IfcPerson::suffixTitles ( )

Returns the value of SuffixTitles attribute. This attribute represents the word, or group of words, which specify the person's social and/or professional standing and appear after his/her names.

Returns
Returns the value of SuffixTitles attribute.

◆ testAttr() [1/2]

virtual bool OdIfc4x1::IfcPerson::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.

◆ testAttr() [2/2]

virtual bool OdIfc4x1::IfcPerson::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.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x1::IfcPerson::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.

◆ unsetAttr() [1/2]

virtual void OdIfc4x1::IfcPerson::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc::OdIfcInstance.

◆ unsetAttr() [2/2]

virtual void OdIfc4x1::IfcPerson::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 OdIfc::OdIfcInstance.

Friends And Related Symbol Documentation

◆ IfcPersonAndOrganization

friend class IfcPersonAndOrganization
friend

Definition at line 346 of file Ifc4x1/IfcPersonAutoImpl.h.

Member Data Documentation

◆ m_Addresses

OdDAI::ListOfOdDAIObjectId OdIfc4x1::IfcPerson::m_Addresses
protected

Definition at line 342 of file Ifc4x1/IfcPersonAutoImpl.h.

◆ m_FamilyName

OdAnsiString OdIfc4x1::IfcPerson::m_FamilyName
protected

Definition at line 332 of file Ifc4x1/IfcPersonAutoImpl.h.

◆ m_GivenName

OdAnsiString OdIfc4x1::IfcPerson::m_GivenName
protected

Definition at line 333 of file Ifc4x1/IfcPersonAutoImpl.h.

◆ m_Identification

OdAnsiString OdIfc4x1::IfcPerson::m_Identification
protected

Definition at line 331 of file Ifc4x1/IfcPersonAutoImpl.h.

◆ m_MiddleNames

OdDAI::ListOfOdAnsiString OdIfc4x1::IfcPerson::m_MiddleNames
protected

Definition at line 334 of file Ifc4x1/IfcPersonAutoImpl.h.

◆ m_PrefixTitles

OdDAI::ListOfOdAnsiString OdIfc4x1::IfcPerson::m_PrefixTitles
protected

Definition at line 336 of file Ifc4x1/IfcPersonAutoImpl.h.

◆ m_Roles

OdDAI::ListOfOdDAIObjectId OdIfc4x1::IfcPerson::m_Roles
protected

Definition at line 340 of file Ifc4x1/IfcPersonAutoImpl.h.

◆ m_SuffixTitles

OdDAI::ListOfOdAnsiString OdIfc4x1::IfcPerson::m_SuffixTitles
protected

Definition at line 338 of file Ifc4x1/IfcPersonAutoImpl.h.


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