|
CFx SDK Documentation 2026 SP0
|
#include <IfcDocumentInformationAutoImpl.h>
Public Member Functions | |
| const OdAnsiString & | getDocumentId () const |
| void | setDocumentId (const OdAnsiString &DocumentId) |
| const OdAnsiString & | getName () const |
| void | setName (const OdAnsiString &Name) |
| const OdAnsiString & | getDescription () const |
| void | setDescription (const OdAnsiString &Description) |
| void | getDocumentReferences (OdDAIObjectIds &DocumentReferences) const |
| OdDAI::SetOfOdDAIObjectId & | documentReferences () |
| const OdAnsiString & | getPurpose () const |
| void | setPurpose (const OdAnsiString &Purpose) |
| const OdAnsiString & | getIntendedUse () const |
| void | setIntendedUse (const OdAnsiString &IntendedUse) |
| const OdAnsiString & | getScope () const |
| void | setScope (const OdAnsiString &Scope) |
| const OdAnsiString & | getRevision () const |
| void | setRevision (const OdAnsiString &Revision) |
| IfcActorSelect | documentOwner () |
| void | getEditors (OdArray< OdDAI::Select > &Editors) const |
| void | getEditorsWrapperArray (OdArray< IfcActorSelect > &Editors) const |
| OdDAI::SetOfSelect & | editors () |
| const OdDAIObjectId & | getCreationTime () const |
| void | setCreationTime (const OdDAIObjectId &CreationTime) |
| const OdDAIObjectId & | getLastRevisionTime () const |
| void | setLastRevisionTime (const OdDAIObjectId &LastRevisionTime) |
| const OdDAIObjectId & | getElectronicFormat () const |
| void | setElectronicFormat (const OdDAIObjectId &ElectronicFormat) |
| const OdDAIObjectId & | getValidFrom () const |
| void | setValidFrom (const OdDAIObjectId &ValidFrom) |
| const OdDAIObjectId & | getValidUntil () const |
| void | setValidUntil (const OdDAIObjectId &ValidUntil) |
| IfcDocumentConfidentialityEnum | getConfidentiality () const |
| void | setConfidentiality (IfcDocumentConfidentialityEnum Confidentiality) |
| IfcDocumentStatusEnum | getStatus () const |
| void | setStatus (IfcDocumentStatusEnum Status) |
| void | getInvIsPointedTo (OdDAIObjectIds &IsPointedTo) const |
| void | getInvIsPointer (OdDAIObjectIds &IsPointer) const |
| IfcDocumentInformation () | |
| 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 bool | comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) 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 OdIfc2x3::OdIfc2x3Instance | |
| 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 OdGsCache * | gsNode () const |
| virtual OdUInt32 | subSetAttributes (OdGiDrawableTraits *traits) const |
| virtual bool | subWorldDraw (OdGiWorldDraw *wd) const |
| virtual OdDbStub * | ownerId () const |
Protected Attributes | |
| OdAnsiString | m_DocumentId |
| OdAnsiString | m_Name |
| OdAnsiString | m_Description |
| OdDAI::SetOfOdDAIObjectId | m_DocumentReferences |
| OdAnsiString | m_Purpose |
| OdAnsiString | m_IntendedUse |
| OdAnsiString | m_Scope |
| OdAnsiString | m_Revision |
| OdDAI::Select | m_DocumentOwner |
| OdDAI::SetOfSelect | m_Editors |
| OdDAIObjectId | m_CreationTime |
| OdDAIObjectId | m_LastRevisionTime |
| OdDAIObjectId | m_ElectronicFormat |
| OdDAIObjectId | m_ValidFrom |
| OdDAIObjectId | m_ValidUntil |
| OdDAI::Enum | m_Confidentiality |
| OdDAI::Enum | m_Status |
Protected Attributes inherited from OdIfc::OdIfcInstance | |
| void * | m_resPtr |
| IfcOpResult | m_resolved |
Friends | |
| class | IfcDocumentInformationRelationship |
Additional Inherited Members | |
Static Public Member Functions inherited from OdIfc::OdIfcInstance | |
| static const OdGePoint3d * | asPoint3d (const OdIfcInstance *inst) |
| static const OdGePoint2d * | asPoint2d (const OdIfcInstance *inst) |
| static const OdGeVector3d * | asVector3d (const OdIfcInstance *inst) |
| static const OdGeVector2d * | asVector2d (const OdIfcInstance *inst) |
| static const OdGeMatrix2d * | asMatrix2d (const OdIfcInstance *inst) |
| static const OdGeMatrix3d * | asMatrix3d (const OdIfcInstance *inst) |
| static OdIfcCompoundPtr | asCompound (OdSmartPtr< OdIfcInstance > inst) |
| static const OdCmEntityColor * | asRgbColor (const OdIfcInstance *inst) |
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.
Definition at line 49 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.
| OdIfc2x3::IfcDocumentInformation::IfcDocumentInformation | ( | ) |
Default constructor for the IfcDocumentInformation class.
|
overridevirtual |
Early-bound version of instances comparison.
| pOther | [in] Other application instance. |
| ordering | [out] Receives the ordering (comparison) status. |
| IfcActorSelect OdIfc2x3::IfcDocumentInformation::documentOwner | ( | ) |
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.
| OdDAI::SetOfOdDAIObjectId & OdIfc2x3::IfcDocumentInformation::documentReferences | ( | ) |
| OdDAI::SetOfSelect & OdIfc2x3::IfcDocumentInformation::editors | ( | ) |
Returns the value of Editors attribute. This attribute represents the persons and/or organizations who have created this document or contributed to it.
|
overridevirtual |
Returns an attribute value for the specified attribute name.
| attrName | [in] Name of an attribute to query. |
|
overridevirtual |
Returns an attribute value for the specified attribute definition.
| attrDef | [in] Attribute definition to query. |
Reimplemented from OdIfc::OdIfcInstance.
| IfcDocumentConfidentialityEnum OdIfc2x3::IfcDocumentInformation::getConfidentiality | ( | ) | const |
Returns the value of Confidentiality attribute. This attribute represents the level of confidentiality of the document.
| const OdDAIObjectId & OdIfc2x3::IfcDocumentInformation::getCreationTime | ( | ) | const |
Returns the value of CreationTime attribute. This attribute represents date and time stamp when the document was originally created.
| const OdAnsiString & OdIfc2x3::IfcDocumentInformation::getDescription | ( | ) | const |
Returns the value of Description attribute. This attribute represents description of document and its content.
| const OdAnsiString & OdIfc2x3::IfcDocumentInformation::getDocumentId | ( | ) | const |
Returns the value of DocumentId attribute. This attribute represents identifier that uniquely identifies a document.
| void OdIfc2x3::IfcDocumentInformation::getDocumentReferences | ( | OdDAIObjectIds & | DocumentReferences | ) | const |
Returns the value of DocumentReferences attribute. This attribute represents information on the referenced document.
Gets the value of Editors attribute. This attribute represents the persons and/or organizations who have created this document or contributed to it.
| Editors | [out] Editors to get. |
| void OdIfc2x3::IfcDocumentInformation::getEditorsWrapperArray | ( | OdArray< IfcActorSelect > & | Editors | ) | const |
Gets the value of Editors attribute. This attribute represents the persons and/or organizations who have created this document or contributed to it.
| Editors | [out] Editors to get. |
| const OdDAIObjectId & OdIfc2x3::IfcDocumentInformation::getElectronicFormat | ( | ) | const |
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.
|
overridevirtual |
Returns a type of a class instance.
| const OdAnsiString & OdIfc2x3::IfcDocumentInformation::getIntendedUse | ( | ) | const |
Returns the value of IntendedUse attribute. This attribute represents intended use for this document.
| void OdIfc2x3::IfcDocumentInformation::getInvIsPointedTo | ( | OdDAIObjectIds & | IsPointedTo | ) | const |
Returns the value of IsPointedTo attribute. This attribute represents an inverse relationship from the IfcDocumentInformationRelationship to the related documents.
| IsPointedTo | [out] Receives the value of IsPointedTo attribute. |
| void OdIfc2x3::IfcDocumentInformation::getInvIsPointer | ( | OdDAIObjectIds & | IsPointer | ) | const |
Returns the value of IsPointer attribute. This attribute represents an inverse relationship from the IfcDocumentInformationRelationship to the relating document.
| IsPointer | [out] Receives the value of IsPointer attribute. |
| const OdDAIObjectId & OdIfc2x3::IfcDocumentInformation::getLastRevisionTime | ( | ) | const |
Returns the value of LastRevisionTime attribute. This attribute represents date and time stamp when this document version was created.
| const OdAnsiString & OdIfc2x3::IfcDocumentInformation::getName | ( | ) | const |
Returns the value of Name attribute. This attribute represents file name or document name assigned by owner.
| const OdAnsiString & OdIfc2x3::IfcDocumentInformation::getPurpose | ( | ) | const |
Returns the value of Purpose attribute. This attribute represents purpose for this document.
| const OdAnsiString & OdIfc2x3::IfcDocumentInformation::getRevision | ( | ) | const |
Returns the value of Revision attribute. This attribute represents document revision designation.
| const OdAnsiString & OdIfc2x3::IfcDocumentInformation::getScope | ( | ) | const |
Returns the value of Scope attribute. This attribute represents scope for this document.
| IfcDocumentStatusEnum OdIfc2x3::IfcDocumentInformation::getStatus | ( | ) | const |
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
| const OdDAIObjectId & OdIfc2x3::IfcDocumentInformation::getValidFrom | ( | ) | const |
Returns the value of ValidFrom attribute. This attribute represents date when the document becomes valid.
| const OdDAIObjectId & OdIfc2x3::IfcDocumentInformation::getValidUntil | ( | ) | const |
Returns the value of ValidUntil attribute. This attribute represents date until which the document remains valid.
|
overridevirtual |
Reads object's data from the specified filer.
| rdFiler | [in] Pointer to a filer from which to read the data. |
|
overridevirtual |
Checks whether the specified instance is the object derived from or belongs to this class.
| entityType | [in] Entity to check. |
Reimplemented from OdIfc::OdIfcInstance.
|
overridevirtual |
Writes object's data the the specified filer.
| wrFiler | [in] Pointer to a filer to which to write the data. |
|
overridevirtual |
Sets the specified attribute with a given value.
| explicitAttrName | [in] Explicit name of the attribute to set. |
| val | [in] Value to set. |
Reimplemented from OdIfc::OdIfcInstance.
|
overridevirtual |
Sets the specified attribute with a given value.
| explicitAttrDef | [in] Explicit attribute definition to set. |
| val | [in] Value to set. |
Reimplemented from OdIfc::OdIfcInstance.
| void OdIfc2x3::IfcDocumentInformation::setConfidentiality | ( | IfcDocumentConfidentialityEnum | Confidentiality | ) |
Sets the value of Confidentiality attribute. This attribute represents the level of confidentiality of the document.
| Confidentiality | [in] Level of Confidentiality to set. |
| void OdIfc2x3::IfcDocumentInformation::setCreationTime | ( | const OdDAIObjectId & | CreationTime | ) |
Sets the value of CreationTime attribute. This attribute represents date and time stamp when the document was originally created.
| CreationTime | [in] Creation time to set. |
| void OdIfc2x3::IfcDocumentInformation::setDescription | ( | const OdAnsiString & | Description | ) |
Sets the value of Description attribute. This attribute represents description of document and its content.
| Description | [in] Description to set. |
| void OdIfc2x3::IfcDocumentInformation::setDocumentId | ( | const OdAnsiString & | DocumentId | ) |
Sets the value of DocumentId attribute. This attribute represents identifier that uniquely identifies a document.
| DocumentId | [in] Document id to set. |
| void OdIfc2x3::IfcDocumentInformation::setElectronicFormat | ( | const OdDAIObjectId & | ElectronicFormat | ) |
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.
| ElectronicFormat | [in] Electronic format to set. |
| void OdIfc2x3::IfcDocumentInformation::setIntendedUse | ( | const OdAnsiString & | IntendedUse | ) |
Sets the value of IntendedUse attribute. This attribute represents intended use for this document.
| IntendedUse | [in] Intended use to set. |
|
overridevirtual |
Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.
| void OdIfc2x3::IfcDocumentInformation::setLastRevisionTime | ( | const OdDAIObjectId & | LastRevisionTime | ) |
Sets the value of LastRevisionTime attribute. This attribute represents date and time stamp when this document version was created.
| LastRevisionTime | [in] Last revision time to set. |
| void OdIfc2x3::IfcDocumentInformation::setName | ( | const OdAnsiString & | Name | ) |
Sets the value of Name attribute. This attribute represents file name or document name assigned by owner.
| Name | [in] Name to set. |
| void OdIfc2x3::IfcDocumentInformation::setPurpose | ( | const OdAnsiString & | Purpose | ) |
Sets the value of Purpose attribute. This attribute represents purpose for this document.
| Purpose | [in] Purpose to set. |
| void OdIfc2x3::IfcDocumentInformation::setRevision | ( | const OdAnsiString & | Revision | ) |
Sets the value of Revision attribute. This attribute represents document revision designation.
| Revision | [in] Revision to set. |
| void OdIfc2x3::IfcDocumentInformation::setScope | ( | const OdAnsiString & | Scope | ) |
Sets the value of Scope attribute. This attribute represents scope for this document.
| Scope | [in] Scope to set. |
| void OdIfc2x3::IfcDocumentInformation::setStatus | ( | IfcDocumentStatusEnum | Status | ) |
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
| Status | [in] Status to set. |
| void OdIfc2x3::IfcDocumentInformation::setValidFrom | ( | const OdDAIObjectId & | ValidFrom | ) |
Sets the value of ValidFrom attribute. This attribute represents date when the document becomes valid.
| ValidFrom | [in] ValidFrom attribute to set. |
| void OdIfc2x3::IfcDocumentInformation::setValidUntil | ( | const OdDAIObjectId & | ValidUntil | ) |
Sets the value of ValidUntil attribute. This attribute represents date until which the document remains valid.
| ValidUntil | [in] ValidUntil attribute to set. |
|
overridevirtual |
Checks whether the specified attribute is set.
| explicitAttrName | [in] Explicit name of the attribute to test. |
Reimplemented from OdIfc::OdIfcInstance.
|
overridevirtual |
Checks whether the specified attribute is set.
| explicitAttrDef | [in] Attribute definition to test. |
Reimplemented from OdIfc::OdIfcInstance.
|
overridevirtual |
Returns the type of this entity.
Reimplemented from OdIfc::OdIfcInstance.
|
overridevirtual |
Resets a value for the specified attribute.
| explicitAttrName | [in] Explicit name of the attribute to reset. |
Reimplemented from OdIfc::OdIfcInstance.
|
overridevirtual |
Resets a value for the specified attribute.
| explicitAttrDef | [in] Explicit definition that represents an attribute to reset. |
Reimplemented from OdIfc::OdIfcInstance.
Definition at line 506 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.
|
protected |
Definition at line 502 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.
|
protected |
Definition at line 497 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.
|
protected |
Definition at line 487 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.
|
protected |
Definition at line 485 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.
|
protected |
Definition at line 494 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.
|
protected |
Definition at line 488 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.
|
protected |
Definition at line 495 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.
|
protected |
Definition at line 499 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.
|
protected |
Definition at line 491 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.
|
protected |
Definition at line 498 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.
|
protected |
Definition at line 486 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.
|
protected |
Definition at line 490 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.
|
protected |
Definition at line 493 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.
|
protected |
Definition at line 492 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.
|
protected |
Definition at line 503 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.
|
protected |
Definition at line 500 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.
|
protected |
Definition at line 501 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.