#include <IfcDocumentInformationAutoImpl.h>

Inheritance diagram for OdIfc4x2::IfcDocumentInformation:

Public Member Functions
const OdAnsiString &	getIdentification () const

void	setIdentification (const OdAnsiString &Identification)

const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

const OdAnsiString &	getDescription () const

void	setDescription (const OdAnsiString &Description)

const OdAnsiString &	getLocation () const

void	setLocation (const OdAnsiString &Location)

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 OdAnsiString &	getCreationTime () const

void	setCreationTime (const OdAnsiString &CreationTime)

const OdAnsiString &	getLastRevisionTime () const

void	setLastRevisionTime (const OdAnsiString &LastRevisionTime)

const OdAnsiString &	getElectronicFormat () const

void	setElectronicFormat (const OdAnsiString &ElectronicFormat)

const OdAnsiString &	getValidFrom () const

void	setValidFrom (const OdAnsiString &ValidFrom)

const OdAnsiString &	getValidUntil () const

void	setValidUntil (const OdAnsiString &ValidUntil)

IfcDocumentConfidentialityEnum	getConfidentiality () const

void	setConfidentiality (IfcDocumentConfidentialityEnum Confidentiality)

IfcDocumentStatusEnum	getStatus () const

void	setStatus (IfcDocumentStatusEnum Status)

void	getInvDocumentInfoForObjects (OdDAIObjectIds &DocumentInfoForObjects) const

void	getInvHasDocumentReferences (OdDAIObjectIds &HasDocumentReferences) const

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 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 OdIfc4x2::OdIfc4x2Instance
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_Identification

OdAnsiString	m_Name

OdAnsiString	m_Description

OdAnsiString	m_Location

OdAnsiString	m_Purpose

OdAnsiString	m_IntendedUse

OdAnsiString	m_Scope

OdAnsiString	m_Revision

OdDAI::Select	m_DocumentOwner

OdDAI::SetOfSelect	m_Editors

OdAnsiString	m_CreationTime

OdAnsiString	m_LastRevisionTime

OdAnsiString	m_ElectronicFormat

OdAnsiString	m_ValidFrom

OdAnsiString	m_ValidUntil

OdDAI::Enum	m_Confidentiality

OdDAI::Enum	m_Status

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Friends
class	IfcRelAssociatesDocument

class	IfcDocumentReference

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)

Detailed Description

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.

\changes

IFC4 changes: Type of the CreationTime attribute changed from "IfcDateAndTime" to "IfcDateTime" Attribute DocumentId renamed to Identification Attribute DocumentReferences renamed changed to Location Type of the DocumentReferences attribute changed from "set[1:?] of IfcDocumentReference" to "IfcURIReference" Type of the ElectronicFormat attribute changed from "IfcDocumentElectronicFormat" to "IfcIdentifier" Type of the LastRevisionTime attribute changed from "IfcDateAndTime" to "IfcDateTime" Type of the ValidFrom attribute changed from "IfcCalendarDate" to "IfcDate" Type of the ValidUntil attribute changed from "IfcCalendarDate" to "IfcDate"

Definition at line 54 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcDocumentInformation()

OdIfc4x2::IfcDocumentInformation::IfcDocumentInformation ( )

Default constructor for the IfcDocumentInformation class.

Member Function Documentation

◆ documentOwner()

IfcActorSelect OdIfc4x2::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.

Returns: Returns the value of DocumentOwner attribute.

◆ editors()

OdDAI::SetOfSelect & OdIfc4x2::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.

Returns: Returns the value of Editors attribute.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x2::IfcDocumentInformation::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 OdIfc4x2::IfcDocumentInformation::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.

◆ getConfidentiality()

IfcDocumentConfidentialityEnum OdIfc4x2::IfcDocumentInformation::getConfidentiality ( ) const

Returns the value of Confidentiality attribute. This attribute represents the level of confidentiality of the document.

Returns: Returns the value of Confidentiality attribute.

◆ getCreationTime()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getCreationTime ( ) const

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.

◆ getDescription()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getDescription ( ) const

Returns the value of Description attribute. This attribute represents description of document and its content.

Returns: Returns the value of Description attribute.

◆ getEditors()

void OdIfc4x2::IfcDocumentInformation::getEditors ( OdArray< OdDAI::Select > & 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.

Parameters

Editors [out] Editors to get.

◆ getEditorsWrapperArray()

void OdIfc4x2::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.

Parameters

Editors [out] Editors to get.

◆ getElectronicFormat()

const OdAnsiString & OdIfc4x2::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.

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.

◆ getIdentification()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getIdentification ( ) const

Returns the value of Identification attribute. This attribute represents identifier that uniquely identifies a document.

Returns: Returns the value of Identification attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x2::IfcDocumentInformation::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.

Reimplemented from OdIfc4x2::IfcExternalInformation.

◆ getIntendedUse()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getIntendedUse ( ) const

Returns the value of IntendedUse attribute. This attribute represents intended use for this document.

Returns: Returns the value of IntendedUse attribute.

◆ getInvDocumentInfoForObjects()

void OdIfc4x2::IfcDocumentInformation::getInvDocumentInfoForObjects ( OdDAIObjectIds & DocumentInfoForObjects ) const

Returns the value of DocumentInfoForObjects attribute. This attribute represents the document information with which objects are associated.

Parameters

DocumentInfoForObjects [out] Receives the value of DocumentInfoForObjects attribute.

◆ getInvHasDocumentReferences()

void OdIfc4x2::IfcDocumentInformation::getInvHasDocumentReferences ( OdDAIObjectIds & HasDocumentReferences ) const

Returns the value of HasDocumentReferences attribute. This attribute represents the document references to which the document applies.

Parameters

HasDocumentReferences [out] Receives the value of HasDocumentReferences attribute.

◆ getInvIsPointedTo()

void OdIfc4x2::IfcDocumentInformation::getInvIsPointedTo ( OdDAIObjectIds & IsPointedTo ) const

Returns the value of IsPointedTo attribute. This attribute represents an inverse relationship from the IfcDocumentInformationRelationship to the related documents.

Parameters

IsPointedTo [out] Receives the value of IsPointedTo attribute.

◆ getInvIsPointer()

void OdIfc4x2::IfcDocumentInformation::getInvIsPointer ( OdDAIObjectIds & IsPointer ) const

Returns the value of IsPointer attribute. This attribute represents an inverse relationship from the IfcDocumentInformationRelationship to the relating document.

Parameters

IsPointer [out] Receives the value of IsPointer attribute.

◆ getLastRevisionTime()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getLastRevisionTime ( ) const

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.

◆ getLocation()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getLocation ( ) const

Returns the value of Location attribute. This attribute represents resource identifier or locator, provided as URI, URN or URL, of the document information for online references.

Returns: Returns the value of Location attribute.

◆ getName()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getName ( ) const

Returns the value of Name attribute. This attribute represents file name or document name assigned by owner.

Returns: Returns the value of Name attribute.

◆ getPurpose()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getPurpose ( ) const

Returns the value of Purpose attribute. This attribute represents purpose for this document.

Returns: Returns the value of Purpose attribute.

◆ getRevision()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getRevision ( ) const

Returns the value of Revision attribute. This attribute represents document revision designation.

Returns: Returns the value of Revision attribute.

◆ getScope()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getScope ( ) const

Returns the value of Scope attribute. This attribute represents scope for this document.

Returns: Returns the value of Scope attribute.

◆ getStatus()

IfcDocumentStatusEnum OdIfc4x2::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

Returns: Returns the value of Status attribute.

◆ getValidFrom()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getValidFrom ( ) const

Returns the value of ValidFrom attribute. This attribute represents date when the document becomes valid.

Returns: Returns the value of ValidFrom attribute.

◆ getValidUntil()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getValidUntil ( ) const

Returns the value of ValidUntil attribute. This attribute represents date until which the document remains valid.

Returns: Returns the value of ValidUntil attribute.

◆ inFields()

virtual OdResult OdIfc4x2::IfcDocumentInformation::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 OdIfc4x2::IfcDocumentInformation::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 OdIfc4x2::IfcExternalInformation.

◆ outFields()

virtual OdResult OdIfc4x2::IfcDocumentInformation::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.

◆ putAttr() [1/2]

virtual bool OdIfc4x2::IfcDocumentInformation::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 OdIfc4x2::IfcDocumentInformation::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.

◆ setConfidentiality()

void OdIfc4x2::IfcDocumentInformation::setConfidentiality ( IfcDocumentConfidentialityEnum Confidentiality )

Sets the value of Confidentiality attribute. This attribute represents the level of confidentiality of the document.

Parameters

Confidentiality [in] Level of Confidentiality to set.

◆ setCreationTime()

void OdIfc4x2::IfcDocumentInformation::setCreationTime ( const OdAnsiString & CreationTime )

Sets the value of CreationTime attribute. This attribute represents date and time stamp when the document was originally created.

Parameters

CreationTime [in] Creation time to set.

◆ setDescription()

void OdIfc4x2::IfcDocumentInformation::setDescription ( const OdAnsiString & Description )

Sets the value of Description attribute. This attribute represents description of document and its content.

Parameters

Description [in] Description to set.

◆ setElectronicFormat()

void OdIfc4x2::IfcDocumentInformation::setElectronicFormat ( const OdAnsiString & 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.

Parameters

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.

◆ setIdentification()

void OdIfc4x2::IfcDocumentInformation::setIdentification ( const OdAnsiString & Identification )

Sets the value of Identification attribute. This attribute represents identifier that uniquely identifies a document.

Parameters

Identification [in] Identification to set.

◆ setIntendedUse()

void OdIfc4x2::IfcDocumentInformation::setIntendedUse ( const OdAnsiString & IntendedUse )

Sets the value of IntendedUse attribute. This attribute represents intended use for this document.

Parameters

IntendedUse [in] Intended use to set.

◆ setLastRevisionTime()

void OdIfc4x2::IfcDocumentInformation::setLastRevisionTime ( const OdAnsiString & LastRevisionTime )

Sets the value of LastRevisionTime attribute. This attribute represents date and time stamp when this document version was created.

Parameters

LastRevisionTime [in] Last revision time to set.

◆ setLocation()

void OdIfc4x2::IfcDocumentInformation::setLocation ( const OdAnsiString & Location )

Sets the value of Location attribute. This attribute represents resource identifier or locator, provided as URI, URN or URL, of the document information for online references.

Parameters

Location [in] Location to set.

◆ setName()

void OdIfc4x2::IfcDocumentInformation::setName ( const OdAnsiString & Name )

Sets the value of Name attribute. This attribute represents file name or document name assigned by owner.

Parameters

Name	[in] Name to set.

◆ setPurpose()

void OdIfc4x2::IfcDocumentInformation::setPurpose ( const OdAnsiString & Purpose )

Sets the value of Purpose attribute. This attribute represents purpose for this document.

Parameters

Purpose [in] Purpose to set.

◆ setRevision()

void OdIfc4x2::IfcDocumentInformation::setRevision ( const OdAnsiString & Revision )

Sets the value of Revision attribute. This attribute represents document revision designation.

Parameters

Revision [in] Revision to set.

◆ setScope()

void OdIfc4x2::IfcDocumentInformation::setScope ( const OdAnsiString & Scope )

Sets the value of Scope attribute. This attribute represents scope for this document.

Parameters

Scope [in] Scope to set.

◆ setStatus()

void OdIfc4x2::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

Parameters

Status [in] Status to set.

◆ setValidFrom()

void OdIfc4x2::IfcDocumentInformation::setValidFrom ( const OdAnsiString & ValidFrom )

Sets the value of ValidFrom attribute. This attribute represents date when the document becomes valid.

Parameters

ValidFrom [in] ValidFrom attribute to set.

◆ setValidUntil()

void OdIfc4x2::IfcDocumentInformation::setValidUntil ( const OdAnsiString & ValidUntil )

Sets the value of ValidUntil attribute. This attribute represents date until which the document remains valid.

Parameters

ValidUntil [in] ValidUntil attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x2::IfcDocumentInformation::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 OdIfc4x2::IfcDocumentInformation::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 OdIfc4x2::IfcDocumentInformation::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 OdIfc4x2::IfcExternalInformation.