#include <IfcDocumentReferenceAutoImpl.h>

Inheritance diagram for OdIfc4x1::IfcDocumentReference:

Public Member Functions
const OdAnsiString &	getDescription () const

void	setDescription (const OdAnsiString &Description)

const OdDAIObjectId &	getReferencedDocument () const

void	setReferencedDocument (const OdDAIObjectId &ReferencedDocument)

void	getInvDocumentRefForObjects (OdDAIObjectIds &DocumentRefForObjects) const

	IfcDocumentReference ()

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 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 OdIfc4x1::IfcExternalReference
const OdAnsiString &	getLocation () const

void	setLocation (const OdAnsiString &Location)

const OdAnsiString &	getIdentification () const

void	setIdentification (const OdAnsiString &Identification)

const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

void	getInvExternalReferenceForResources (OdDAIObjectIds &ExternalReferenceForResources) const

	IfcExternalReference ()

Public Member Functions inherited from OdIfc4x1::OdIfc4x1Instance
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_Description

OdDAIObjectId	m_ReferencedDocument

Protected Attributes inherited from OdIfc4x1::IfcExternalReference
OdAnsiString	m_Location

OdAnsiString	m_Identification

OdAnsiString	m_Name

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Friends
class	IfcRelAssociatesDocument

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

An IfcDocumentReference is a reference to the location of a document. The reference is provided by a system interpretable Location attribute (a URL string) where the document can be found, and an optional inherited internal reference Identification, which refers to a system interpretable position within the document. The optional inherited Name attribute provides meaning for human readers. Optional document metadata can also be captured through reference to IfcDocumentInformation.

\changes

IFC4 changes: Inverse attribute ReferenceToDocument renamed to DocumentRefForObjects Type of the inverse attribute ReferenceToDocument changed from "SET OF [0:1] IfcDocumentInformation FOR DocumentReferences" to "SET OF [0:?] IfcRelAssociatesDocument FOR RelatingDocument"

Definition at line 52 of file Ifc4x1/IfcDocumentReferenceAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcDocumentReference()

OdIfc4x1::IfcDocumentReference::IfcDocumentReference ( )

Default constructor for the IfcDocumentReference class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x1::IfcDocumentReference::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.

Reimplemented from OdIfc4x1::IfcExternalReference.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x1::IfcDocumentReference::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 OdIfc4x1::IfcExternalReference.

◆ getDescription()

const OdAnsiString & OdIfc4x1::IfcDocumentReference::getDescription ( ) const

Returns the value of Description attribute. This attribute represents description of the document reference for informational purposes.

Returns: Returns the value of Description attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x1::IfcDocumentReference::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 OdIfc4x1::IfcExternalReference.

◆ getInvDocumentRefForObjects()

void OdIfc4x1::IfcDocumentReference::getInvDocumentRefForObjects ( OdDAIObjectIds & DocumentRefForObjects ) const

Returns the value of DocumentRefForObjects attribute. This attribute represents the document reference with which objects are associated.

Parameters

DocumentRefForObjects [out] Receives the value of DocumentRefForObjects attribute.

◆ getReferencedDocument()

const OdDAIObjectId & OdIfc4x1::IfcDocumentReference::getReferencedDocument ( ) const

Returns the value of ReferencedDocument attribute. This attribute represents the document that is referenced.

Returns: Returns the value of ReferencedDocument attribute.

◆ inFields()

virtual OdResult OdIfc4x1::IfcDocumentReference::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.

Reimplemented from OdIfc4x1::IfcExternalReference.

◆ isKindOf()

virtual bool OdIfc4x1::IfcDocumentReference::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 OdIfc4x1::IfcExternalReference.

◆ outFields()

virtual OdResult OdIfc4x1::IfcDocumentReference::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.

Reimplemented from OdIfc4x1::IfcExternalReference.

◆ putAttr() [1/2]

virtual bool OdIfc4x1::IfcDocumentReference::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 OdIfc4x1::IfcExternalReference.

◆ putAttr() [2/2]

virtual bool OdIfc4x1::IfcDocumentReference::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 OdIfc4x1::IfcExternalReference.

◆ setDescription()

void OdIfc4x1::IfcDocumentReference::setDescription ( const OdAnsiString & Description )

Sets the value of Description attribute. This attribute represents description of the document reference for informational purposes.

Parameters

Description [in] Description to set.

◆ setInverseCounterParts()

virtual void OdIfc4x1::IfcDocumentReference::setInverseCounterParts ( )

overridevirtual

Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.

◆ setReferencedDocument()

void OdIfc4x1::IfcDocumentReference::setReferencedDocument ( const OdDAIObjectId & ReferencedDocument )

Sets the value of ReferencedDocument attribute. This attribute represents the document that is referenced.

Parameters

ReferencedDocument [in] Referenced document to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x1::IfcDocumentReference::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 OdIfc4x1::IfcExternalReference.

◆ testAttr() [2/2]

virtual bool OdIfc4x1::IfcDocumentReference::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 OdIfc4x1::IfcExternalReference.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x1::IfcDocumentReference::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 OdIfc4x1::IfcExternalReference.

◆ unsetAttr() [1/2]

virtual void OdIfc4x1::IfcDocumentReference::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

explicitAttrName [in] Explicit name of the attribute to reset.

Reimplemented from OdIfc4x1::IfcExternalReference.

◆ unsetAttr() [2/2]

virtual void OdIfc4x1::IfcDocumentReference::unsetAttr ( const OdIfc::OdIfcAttribute explicitAttrDef )

overridevirtual

Resets a value for the specified attribute.

Parameters

explicitAttrDef [in] Explicit definition that represents an attribute to reset.

Reimplemented from OdIfc4x1::IfcExternalReference.

Friends And Related Symbol Documentation

◆ IfcRelAssociatesDocument

friend class IfcRelAssociatesDocument

friend

Definition at line 222 of file Ifc4x1/IfcDocumentReferenceAutoImpl.h.

Member Data Documentation

◆ m_Description

OdAnsiString OdIfc4x1::IfcDocumentReference::m_Description

protected

Definition at line 218 of file Ifc4x1/IfcDocumentReferenceAutoImpl.h.

◆ m_ReferencedDocument

OdDAIObjectId OdIfc4x1::IfcDocumentReference::m_ReferencedDocument

protected

Definition at line 219 of file Ifc4x1/IfcDocumentReferenceAutoImpl.h.

The documentation for this class was generated from the following file:

Ifc4x1/IfcDocumentReferenceAutoImpl.h

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcDocumentReference()

Member Function Documentation

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getDescription()

◆ getInstanceType()

◆ getInvDocumentRefForObjects()

◆ getReferencedDocument()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setDescription()

◆ setInverseCounterParts()

◆ setReferencedDocument()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Friends And Related Symbol Documentation

◆ IfcRelAssociatesDocument

Member Data Documentation

◆ m_Description

◆ m_ReferencedDocument