/////////////////////////////////////////////////////////////////////////////// // 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 _IFC4X4_IFCPOSTALADDRESS_AUTO_IMPL_H #define _IFC4X4_IFCPOSTALADDRESS_AUTO_IMPL_H #include "IfcAddressAutoImpl.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC4X4 express schema definitions. */ namespace OdIfc4x4 { /** \details 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. */ class IFC4X4_EXPORT IfcPostalAddress : public IfcAddress { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc4x4::IfcPostalAddress); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of InternalLocation attribute. This attribute represents an organization defined address for internal mail delivery. \returns Returns the value of InternalLocation attribute. */ const OdAnsiString& getInternalLocation() const; /** \details Sets the value of InternalLocation attribute. This attribute represents an organization defined address for internal mail delivery. \param InternalLocation [in] Internal location to set. */ void setInternalLocation(const OdAnsiString& InternalLocation); /** \details Sets the value of AddressLines attribute. This attribute represents the postal address. \param 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. */ void getAddressLines(OdArray& AddressLines) const; /** \details 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. */ OdDAI::ListOfOdAnsiString& addressLines(); /** \details 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. */ const OdAnsiString& getPostalBox() const; /** \details Sets the value of PostalBox attribute. This attribute represents an address that is implied by an identifiable mail drop. \param PostalBox [in] Postal box to set. */ void setPostalBox(const OdAnsiString& PostalBox); /** \details Returns the value of Town attribute. This attribute represents the name of a town. \returns Returns the value of Town attribute. */ const OdAnsiString& getTown() const; /** \details Sets the value of Town attribute. This attribute represents the name of a town. \param Town [in] Town to set. */ void setTown(const OdAnsiString& Town); /** \details 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. */ const OdAnsiString& getRegion() const; /** \details Sets the value of Region attribute. This attribute represents the name of a region. \param Region [in] Region to set. \remarks The counties of the United Kingdom and the states of North America are examples of regions. */ void setRegion(const OdAnsiString& Region); /** \details 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. */ const OdAnsiString& getPostalCode() const; /** \details Sets the value of PostalCode attribute. This attribute represents the code that is used by the country's postal service. \param PostalCode [in] Postal code to set. */ void setPostalCode(const OdAnsiString& PostalCode); /** \details Returns the value of Country attribute. This attribute represents the name of a country. \returns Returns the value of Country attribute. */ const OdAnsiString& getCountry() const; /** \details Sets the value of Country attribute. This attribute represents the name of a country. \param Country [in] Country to set. */ void setCountry(const OdAnsiString& Country); public: /** \details Default constructor for the IfcPostalAddress class. */ IfcPostalAddress(); /** \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 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_InternalLocation; // IfcLabel [optional] OdDAI::ListOfOdAnsiString m_AddressLines; // LIST [1:?] of IfcLabel [optional] OdAnsiString m_PostalBox; // IfcLabel [optional] OdAnsiString m_Town; // IfcLabel [optional] OdAnsiString m_Region; // IfcLabel [optional] OdAnsiString m_PostalCode; // IfcLabel [optional] OdAnsiString m_Country; // IfcLabel [optional] }; /** \details A data type that represents a smart pointer to a IfcPostalAddress object. */ typedef OdSmartPtr IfcPostalAddressPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC4X4_IFCPOSTALADDRESS_AUTO_IMPL_H