#include <IfcExternalReferenceAutoImpl.h>

Inheritance diagram for OdIfc4::IfcExternalReference:

Public Member Functions
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 ()

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 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 OdIfc4::OdIfc4Instance
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_Location

OdAnsiString	m_Identification

OdAnsiString	m_Name

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Friends
class	IfcExternalReferenceRelationship

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 IfcExternalReference is the identification of information that is not explicitly represented in the current model or in the project database (as an implementation of the current model). Such information can be contained in classifications, documents or libraries. The IfcExternalReference identifies a particular item, such as a dictionary entry, a classification notation, or a document reference within the external source.

Only the Location (as a URL) is provided to describe the place where the information can be found. Also an optional Identification as a key to allow more specific references (as to sections or tables) is provided. The Identification defines a system interpretable method to identify the relevant part of information at the source. In addition a human interpretable Name can be assigned to identify the information subject, such as a classification code.

Remarks: This definition may not be instantiated.

\changes

IFC4 changes: Attribute ItemReference renamed to Identification Type of the Location attribute changed from "IfcLabel" to "IfcURIReference"

Definition at line 62 of file Ifc4/IfcExternalReferenceAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcExternalReference()

OdIfc4::IfcExternalReference::IfcExternalReference ( )

Default constructor for the IfcExternalReference class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcExternalReference::comparedToEarlyImpl	(	const OdDAI::ApplicationInstance *	pOther,
		OdRx::Ordering &	ordering ) const

overridevirtual

Early-bound version of instances comparison.

Parameters

pOther	[in] Other application instance.
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:

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.

Reimplemented in OdIfc4::IfcClassificationReference, OdIfc4::IfcDocumentReference, OdIfc4::IfcExternallyDefinedHatchStyle, OdIfc4::IfcExternallyDefinedSurfaceStyle, OdIfc4::IfcExternallyDefinedTextFont, and OdIfc4::IfcLibraryReference.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcExternalReference::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 in OdIfc4::IfcClassificationReference, OdIfc4::IfcDocumentReference, and OdIfc4::IfcLibraryReference.

◆ getAttr() [2/2]

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

Reimplemented in OdIfc4::IfcClassificationReference, OdIfc4::IfcDocumentReference, and OdIfc4::IfcLibraryReference.

◆ getIdentification()

const OdAnsiString & OdIfc4::IfcExternalReference::getIdentification ( ) const

Returns the value of Identification attribute. This attribute represents a unique identifier of the referenced item within the external source (classification, document or library).

Returns: Returns the value of Identification attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcExternalReference::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 in OdIfc4::IfcClassificationReference, OdIfc4::IfcDocumentReference, OdIfc4::IfcExternallyDefinedHatchStyle, OdIfc4::IfcExternallyDefinedSurfaceStyle, OdIfc4::IfcExternallyDefinedTextFont, and OdIfc4::IfcLibraryReference.

◆ getInvExternalReferenceForResources()

void OdIfc4::IfcExternalReference::getInvExternalReferenceForResources ( OdDAIObjectIds & ExternalReferenceForResources ) const

Returns the value of ExternalReferenceForResources attribute. This attribute represents reference to all associations between this external reference and objects within the IfcResourceObjectSelect that are tagged by the external reference.

Parameters

ExternalReferenceForResources [out] Receives the value of ExternalReferenceForResources attribute.

◆ getLocation()

const OdAnsiString & OdIfc4::IfcExternalReference::getLocation ( ) const

Returns the value of Location attribute. This attribute represents location, where the external source (classification, document or library) can be accessed by electronic means. The electronic location is provided as an URI, and would normally be provided as an URL location string.

Returns: Returns the value of Location attribute.

◆ getName()

const OdAnsiString & OdIfc4::IfcExternalReference::getName ( ) const

Returns the value of Name attribute. This attribute represents optional name to further specify the reference. It can provide a human-readable identifier (which does not necessarily need to have a counterpart in the internal structure of the document).

Returns: Returns the value of Name attribute.

◆ inFields()

virtual OdResult OdIfc4::IfcExternalReference::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 in OdIfc4::IfcClassificationReference, OdIfc4::IfcDocumentReference, and OdIfc4::IfcLibraryReference.

◆ isKindOf()

virtual bool OdIfc4::IfcExternalReference::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc4::IfcClassificationReference, OdIfc4::IfcDocumentReference, OdIfc4::IfcExternallyDefinedHatchStyle, OdIfc4::IfcExternallyDefinedSurfaceStyle, OdIfc4::IfcExternallyDefinedTextFont, and OdIfc4::IfcLibraryReference.

◆ outFields()

virtual OdResult OdIfc4::IfcExternalReference::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 in OdIfc4::IfcClassificationReference, OdIfc4::IfcDocumentReference, and OdIfc4::IfcLibraryReference.

◆ putAttr() [1/2]

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

Reimplemented in OdIfc4::IfcClassificationReference, OdIfc4::IfcDocumentReference, and OdIfc4::IfcLibraryReference.

◆ putAttr() [2/2]

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

Reimplemented in OdIfc4::IfcClassificationReference, OdIfc4::IfcDocumentReference, and OdIfc4::IfcLibraryReference.

◆ setIdentification()

void OdIfc4::IfcExternalReference::setIdentification ( const OdAnsiString & Identification )

Sets the value of Identification attribute. This attribute represents a unique identifier of the referenced item within the external source (classification, document or library).

Parameters

Identification [in] Identification to set.

◆ setLocation()

void OdIfc4::IfcExternalReference::setLocation ( const OdAnsiString & Location )

Sets the value of Location attribute. This attribute represents location, where the external source (classification, document or library) can be accessed by electronic means. The electronic location is provided as an URI, and would normally be provided as an URL location string.

Parameters

Location [in] Location to set.

◆ setName()

void OdIfc4::IfcExternalReference::setName ( const OdAnsiString & Name )

Sets the value of Name attribute. This attribute represents optional name to further specify the reference. It can provide a human-readable identifier (which does not necessarily need to have a counterpart in the internal structure of the document).

Parameters

Name	[in] Name to set.

◆ testAttr() [1/2]

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

Reimplemented in OdIfc4::IfcClassificationReference, OdIfc4::IfcDocumentReference, and OdIfc4::IfcLibraryReference.

◆ testAttr() [2/2]

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

Reimplemented in OdIfc4::IfcClassificationReference, OdIfc4::IfcDocumentReference, and OdIfc4::IfcLibraryReference.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcExternalReference::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc4::IfcClassificationReference, OdIfc4::IfcDocumentReference, OdIfc4::IfcExternallyDefinedHatchStyle, OdIfc4::IfcExternallyDefinedSurfaceStyle, OdIfc4::IfcExternallyDefinedTextFont, and OdIfc4::IfcLibraryReference.