/////////////////////////////////////////////////////////////////////////////// // 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_IFCDOCUMENTINFORMATION_AUTO_IMPL_H #define _IFC2X3_IFCDOCUMENTINFORMATION_AUTO_IMPL_H #include "Ifc2x3BaseClass.h" #include "Ifc2x3Enum.h" #include "Ifc2x3SelectTypes.h" #include "Ifc2x3CollectionTypes.h" #include "IfcDateAndTimeAutoImpl.h" #include "IfcDocumentElectronicFormatAutoImpl.h" #include "IfcCalendarDateAutoImpl.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 IfcDocumentInformation captures metadata of an external document. The actual content of the document is not defined in this specification. Instead, it can be found using the Location attribute. */ class IFC2X3_EXPORT IfcDocumentInformation : public OdIfc2x3Instance { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc2x3::IfcDocumentInformation); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of DocumentId attribute. This attribute represents identifier that uniquely identifies a document. \returns Returns the value of DocumentId attribute. */ const OdAnsiString& getDocumentId() const; /** \details Sets the value of DocumentId attribute. This attribute represents identifier that uniquely identifies a document. \param DocumentId [in] Document id to set. */ void setDocumentId(const OdAnsiString& DocumentId); /** \details Returns the value of Name attribute. This attribute represents file name or document name assigned by owner. \returns Returns the value of Name attribute. */ const OdAnsiString& getName() const; /** \details Sets the value of Name attribute. This attribute represents file name or document name assigned by owner. \param Name [in] Name to set. */ void setName(const OdAnsiString& Name); /** \details Returns the value of Description attribute. This attribute represents description of document and its content. \returns Returns the value of Description attribute. */ const OdAnsiString& getDescription() const; /** \details Sets the value of Description attribute. This attribute represents description of document and its content. \param Description [in] Description to set. */ void setDescription(const OdAnsiString& Description); /** \details Gets the value of DocumentReferences attribute. This attribute represents information on the referenced document. \param DocumentReferences [out] Receives the document references. */ void getDocumentReferences(OdDAIObjectIds& DocumentReferences) const; /** \details Returns the value of DocumentReferences attribute. This attribute represents information on the referenced document. \returns Returns the value of DocumentReferences attribute. */ OdDAI::SetOfOdDAIObjectId& documentReferences(); /** \details Returns the value of Purpose attribute. This attribute represents purpose for this document. \returns Returns the value of Purpose attribute. */ const OdAnsiString& getPurpose() const; /** \details Sets the value of Purpose attribute. This attribute represents purpose for this document. \param Purpose [in] Purpose to set. */ void setPurpose(const OdAnsiString& Purpose); /** \details Returns the value of IntendedUse attribute. This attribute represents intended use for this document. \returns Returns the value of IntendedUse attribute. */ const OdAnsiString& getIntendedUse() const; /** \details Sets the value of IntendedUse attribute. This attribute represents intended use for this document. \param IntendedUse [in] Intended use to set. */ void setIntendedUse(const OdAnsiString& IntendedUse); /** \details Returns the value of Scope attribute. This attribute represents scope for this document. \returns Returns the value of Scope attribute. */ const OdAnsiString& getScope() const; /** \details Sets the value of Scope attribute. This attribute represents scope for this document. \param Scope [in] Scope to set. */ void setScope(const OdAnsiString& Scope); /** \details Returns the value of Revision attribute. This attribute represents document revision designation. \returns Returns the value of Revision attribute. */ const OdAnsiString& getRevision() const; /** \details Sets the value of Revision attribute. This attribute represents document revision designation. \param Revision [in] Revision to set. */ void setRevision(const OdAnsiString& Revision); /** \details Returns the value of DocumentOwner attribute. This attribute represents information about the person and/or organization acknowledged as the 'owner' of this document. In some contexts, the document owner determines who has access to or editing right to the document. \returns Returns the value of DocumentOwner attribute. */ IfcActorSelect documentOwner(); /** \details Gets the value of Editors attribute. This attribute represents the persons and/or organizations who have created this document or contributed to it. \param Editors [out] Editors to get. */ void getEditors(OdArray& Editors) const; /** \details Gets the value of Editors attribute. This attribute represents the persons and/or organizations who have created this document or contributed to it. \param Editors [out] Editors to get. */ void getEditorsWrapperArray(OdArray& Editors) const; /** \details Returns the value of Editors attribute. This attribute represents the persons and/or organizations who have created this document or contributed to it. \returns Returns the value of Editors attribute. */ OdDAI::SetOfSelect& editors(); /** \details Returns the value of CreationTime attribute. This attribute represents date and time stamp when the document was originally created. \returns Returns the value of CreationTime attribute. */ const OdDAIObjectId& getCreationTime() const; /** \details Sets the value of CreationTime attribute. This attribute represents date and time stamp when the document was originally created. \param CreationTime [in] Creation time to set. */ void setCreationTime(const OdDAIObjectId& CreationTime); /** \details Returns the value of LastRevisionTime attribute. This attribute represents date and time stamp when this document version was created. \returns Returns the value of LastRevisionTime attribute. */ const OdDAIObjectId& getLastRevisionTime() const; /** \details Sets the value of LastRevisionTime attribute. This attribute represents date and time stamp when this document version was created. \param LastRevisionTime [in] Last revision time to set. */ void setLastRevisionTime(const OdDAIObjectId& LastRevisionTime); /** \details Returns the value of ElectronicFormat attribute. This attribute represents describes the media type used in various internet protocols, also referred to as "Content-type", or "MIME-type" (Multipurpose Internet Mail Extension), of the document being referenced. It is composed of (at least) two parts, a type and a subtype. \returns Returns the value of ElectronicFormat attribute. \remarks The iana (Internet Assigned Numbers Authority) published the media types. For example, 'image/png' denotes an image type of png (Portable Network Graphics) subtype, 'application/pdf' denotes an application specific type of pdf (Portable Document Format) subtype. */ const OdDAIObjectId& getElectronicFormat() const; /** \details Sets the value of ElectronicFormat attribute. This attribute represents describes the media type used in various internet protocols, also referred to as "Content-type", or "MIME-type" (Multipurpose Internet Mail Extension), of the document being referenced. It is composed of (at least) two parts, a type and a subtype. \param ElectronicFormat [in] Electronic format to set. \remarks The iana (Internet Assigned Numbers Authority) published the media types. For example, 'image/png' denotes an image type of png (Portable Network Graphics) subtype, 'application/pdf' denotes an application specific type of pdf (Portable Document Format) subtype. */ void setElectronicFormat(const OdDAIObjectId& ElectronicFormat); /** \details Returns the value of ValidFrom attribute. This attribute represents date when the document becomes valid. \returns Returns the value of ValidFrom attribute. */ const OdDAIObjectId& getValidFrom() const; /** \details Sets the value of ValidFrom attribute. This attribute represents date when the document becomes valid. \param ValidFrom [in] ValidFrom attribute to set. */ void setValidFrom(const OdDAIObjectId& ValidFrom); /** \details Returns the value of ValidUntil attribute. This attribute represents date until which the document remains valid. \returns Returns the value of ValidUntil attribute. */ const OdDAIObjectId& getValidUntil() const; /** \details Sets the value of ValidUntil attribute. This attribute represents date until which the document remains valid. \param ValidUntil [in] ValidUntil attribute to set. */ void setValidUntil(const OdDAIObjectId& ValidUntil); /** \details Returns the value of Confidentiality attribute. This attribute represents the level of confidentiality of the document. \returns Returns the value of Confidentiality attribute. */ IfcDocumentConfidentialityEnum getConfidentiality() const; /** \details Sets the value of Confidentiality attribute. This attribute represents the level of confidentiality of the document. \param Confidentiality [in] Level of Confidentiality to set. */ void setConfidentiality(IfcDocumentConfidentialityEnum Confidentiality); /** \details Returns the value of Status attribute. This attribute represents the current status of the document. Examples of status values that might be used for a document information status include: * DRAFT * FINAL DRAFT * FINAL * REVISION \returns Returns the value of Status attribute. */ IfcDocumentStatusEnum getStatus() const; /** \details Sets the value of Status attribute. This attribute represents the current status of the document. Examples of status values that might be used for a document information status include: * DRAFT * FINAL DRAFT * FINAL * REVISION \param Status [in] Status to set. */ void setStatus(IfcDocumentStatusEnum Status); /** \details Returns the value of IsPointedTo attribute. This attribute represents an inverse relationship from the IfcDocumentInformationRelationship to the related documents. \param IsPointedTo [out] Receives the value of IsPointedTo attribute. */ void getInvIsPointedTo(OdDAIObjectIds& IsPointedTo) const; /** \details Returns the value of IsPointer attribute. This attribute represents an inverse relationship from the IfcDocumentInformationRelationship to the relating document. \param IsPointer [out] Receives the value of IsPointer attribute. */ void getInvIsPointer(OdDAIObjectIds& IsPointer) const; public: /** \details Default constructor for the IfcDocumentInformation class. */ IfcDocumentInformation(); /** \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_DocumentId; // IfcIdentifier OdAnsiString m_Name; // IfcLabel OdAnsiString m_Description; // IfcText [optional] OdDAI::SetOfOdDAIObjectId m_DocumentReferences; // SET [1:?] of IfcDocumentReference [optional] OdAnsiString m_Purpose; // IfcText [optional] OdAnsiString m_IntendedUse; // IfcText [optional] OdAnsiString m_Scope; // IfcText [optional] OdAnsiString m_Revision; // IfcLabel [optional] OdDAI::Select m_DocumentOwner; // IfcActorSelect [optional] OdDAI::SetOfSelect m_Editors; // SET [1:?] of IfcActorSelect [optional] OdDAIObjectId m_CreationTime; // IfcDateAndTime [optional] OdDAIObjectId m_LastRevisionTime; // IfcDateAndTime [optional] OdDAIObjectId m_ElectronicFormat; // IfcDocumentElectronicFormat [optional] OdDAIObjectId m_ValidFrom; // IfcCalendarDate [optional] OdDAIObjectId m_ValidUntil; // IfcCalendarDate [optional] OdDAI::Enum m_Confidentiality; // IfcDocumentConfidentialityEnum [optional] OdDAI::Enum m_Status; // IfcDocumentStatusEnum [optional] // Declare friend classes for inverse attributes functionality: friend class IfcDocumentInformationRelationship; friend class IfcDocumentInformationRelationship; }; /** \details A data type that represents a smart pointer to a IfcDocumentInformation object. */ typedef OdSmartPtr IfcDocumentInformationPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC2X3_IFCDOCUMENTINFORMATION_AUTO_IMPL_H