/////////////////////////////////////////////////////////////////////////////// // Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). // All rights reserved. // // This software and its documentation and related materials are owned by // the Alliance. The software may only be incorporated into application // programs owned by members of the Alliance, subject to a signed // Membership Agreement and Supplemental Software License Agreement with the // Alliance. The structure and organization of this software are the valuable // trade secrets of the Alliance and its suppliers. The software is also // protected by copyright law and international treaty provisions. Application // programs incorporating this software must include the following statement // with their copyright notices: // // This application incorporates Open Design Alliance software pursuant to a license // agreement with Open Design Alliance. // Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. // All rights reserved. // // By use of this software, its documentation or related materials, you // acknowledge and accept the above terms. /////////////////////////////////////////////////////////////////////////////// // This file is generated automatically. #ifndef _IFC2X3_IFCPERSON_AUTO_IMPL_H #define _IFC2X3_IFCPERSON_AUTO_IMPL_H #include "Ifc2x3BaseClass.h" #include "Ifc2x3Enum.h" #include "Ifc2x3SelectTypes.h" #include "Ifc2x3CollectionTypes.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC2X3 express schema definitions. */ namespace OdIfc2x3 { /** \details This entity represents an individual human being. */ class IFC2X3_EXPORT IfcPerson : public OdIfc2x3Instance { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc2x3::IfcPerson); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of Id attribute. This attribute represents identification of the person. \returns Returns the value of Id attribute. */ const OdAnsiString& getId() const; /** \details Sets the value of Id attribute. This attribute represents identification of the person. \param Id [in] Identification to set. */ void setId(const OdAnsiString& Id); /** \details 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. */ const OdAnsiString& getFamilyName() const; /** \details Sets the value of FamilyName attribute. This attribute represents the name by which the family identity of the person can be recognized. \param 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. */ void setFamilyName(const OdAnsiString& FamilyName); /** \details 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. */ const OdAnsiString& getGivenName() const; /** \details 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. \param 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. */ void setGivenName(const OdAnsiString& GivenName); /** \details 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. \param 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. */ void getMiddleNames(OdArray& MiddleNames) const; /** \details 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. */ OdDAI::ListOfOdAnsiString& middleNames(); /** \details 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. \param PrefixTitles [out] Receives the PrefixTitles attribute. */ void getPrefixTitles(OdArray& PrefixTitles) const; /** \details 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. */ OdDAI::ListOfOdAnsiString& prefixTitles(); /** \details 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. \param SuffixTitles [out] Receives the SuffixTitles attribute. */ void getSuffixTitles(OdArray& SuffixTitles) const; /** \details 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. */ OdDAI::ListOfOdAnsiString& suffixTitles(); /** \details Gets the value of Roles attribute. This attribute represents roles played by the person. \param Roles [out] Receives the Roles attribute. */ void getRoles(OdDAIObjectIds& Roles) const; /** \details Returns the value of Roles attribute. This attribute represents roles played by the person. \returns Returns the value of Roles attribute. */ OdDAI::ListOfOdDAIObjectId& roles(); /** \details Sets the value of Addresses attribute. This attribute represents postal and telecommunication addresses of a person. \param Addresses [out] Receives the Addresses attribute. \remarks A person can have several addresses. */ void getAddresses(OdDAIObjectIds& Addresses) const; /** \details 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. */ OdDAI::ListOfOdDAIObjectId& addresses(); /** \details Returns the value of EngagedIn attribute. This attribute represents the inverse relationship to IfcPersonAndOrganization relationships in which IfcPerson is engaged. \param EngagedIn [out] Receives the value of EngagedIn attribute. */ void getInvEngagedIn(OdDAIObjectIds& EngagedIn) const; public: /** \details Default constructor for the IfcPerson class. */ IfcPerson(); /** \details Reads object's data from the specified filer. \param 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. */ virtual OdResult inFields(OdDAI::OdSpfFilerBase* rdFiler) override; /** \details Writes object's data the the specified filer. \param 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. */ virtual OdResult outFields(OdDAI::OdSpfFilerBase* wrFiler) override; /** \details Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes. */ virtual void setInverseCounterParts() override; /** \details Returns a type of a class instance. \returns Pointer to the OdDAI::Entity type that determines an entity definition within a schema. */ virtual OdDAI::Entity* getInstanceType() const override; /** \details Returns an attribute value for the specified attribute name. \param attrName [in] Name of an attribute to query. \returns OdRxValue object that represents a generic variant type value. */ virtual OdRxValue getAttr(const char * attrName) const override; /** \details Early-bound version of instances comparison. \param pOther [in] Other application instance. \param 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: Name 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.
*/ virtual bool comparedToEarlyImpl(const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const override; /** \details Resets a value for the specified attribute. \param explicitAttrName [in] Explicit name of the attribute to reset. */ virtual void unsetAttr(const char * explicitAttrName) override; /** \details Checks whether the specified attribute is set. \param explicitAttrName [in] Explicit name of the attribute to test. \returns true if the specified attribute is set, false otherwise. */ virtual bool testAttr(const char * explicitAttrName) const override; /** \details Sets the specified attribute with a given value. \param explicitAttrName [in] Explicit name of the attribute to set. \param val [in] Value to set. \returns true if the value is successfully set for the specified attribute, false otherwise. */ virtual bool putAttr(const char * explicitAttrName, const OdRxValue &val) override; /** \details Checks whether the specified instance is the object derived from or belongs to this class. \param entityType [in] Entity to check. \returns true if the specified instance is the object derived from or belongs to this class, false otherwise. */ virtual bool isKindOf(OdIfc::OdIfcEntityType entityType) const override; /** \details Returns the type of this entity. \returns A value of the OdIfc::OdIfcEntityType type that represents type of this entity. */ virtual OdIfc::OdIfcEntityType type() const override; /** \details Returns an attribute value for the specified attribute definition. \param attrDef [in] Attribute definition to query. \returns OdRxValue object that represents a generic variant type value. */ virtual OdRxValue getAttr(const OdIfc::OdIfcAttribute attrDef) const override; /** \details Resets a value for the specified attribute. \param explicitAttrDef [in] Explicit definition that represents an attribute to reset. */ virtual void unsetAttr(const OdIfc::OdIfcAttribute explicitAttrDef) override; /** \details Checks whether the specified attribute is set. \param explicitAttrDef [in] Attribute definition to test. \returns true if the specified attribute is set, false otherwise. */ virtual bool testAttr(const OdIfc::OdIfcAttribute explicitAttrDef) const override; /** \details Sets the specified attribute with a given value. \param explicitAttrDef [in] Explicit attribute definition to set. \param val [in] Value to set. \returns true if the value is successfully set for the specified attribute, false otherwise. */ virtual bool putAttr(const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override; protected: // Fields declaration: OdAnsiString m_Id; // IfcIdentifier [optional] OdAnsiString m_FamilyName; // IfcLabel [optional] OdAnsiString m_GivenName; // IfcLabel [optional] OdDAI::ListOfOdAnsiString m_MiddleNames; // LIST [1:?] of IfcLabel [optional] OdDAI::ListOfOdAnsiString m_PrefixTitles; // LIST [1:?] of IfcLabel [optional] OdDAI::ListOfOdAnsiString m_SuffixTitles; // LIST [1:?] of IfcLabel [optional] OdDAI::ListOfOdDAIObjectId m_Roles; // LIST [1:?] of IfcActorRole [optional] OdDAI::ListOfOdDAIObjectId m_Addresses; // LIST [1:?] of IfcAddress [optional] // Declare friend classes for inverse attributes functionality: friend class IfcPersonAndOrganization; }; /** \details A data type that represents a smart pointer to a IfcPerson object. */ typedef OdSmartPtr IfcPersonPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC2X3_IFCPERSON_AUTO_IMPL_H