#include <IfcExternalReferenceAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcExternalReference:

Public Member Functions
const OdAnsiString &	getLocation () const

void	setLocation (const OdAnsiString &Location)

const OdAnsiString &	getItemReference () const

void	setItemReference (const OdAnsiString &ItemReference)

const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

	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 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 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_ItemReference

OdAnsiString	m_Name

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

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.

Definition at line 56 of file Ifc2x_Final/IfcExternalReferenceAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcExternalReference()

OdIfc2x_final::IfcExternalReference::IfcExternalReference ( )

Default constructor for the IfcExternalReference class.

Member Function Documentation

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x_final::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 OdIfc2x_final::IfcClassificationReference, OdIfc2x_final::IfcDocumentReference, and OdIfc2x_final::IfcLibraryReference.

◆ getItemReference()

const OdAnsiString & OdIfc2x_final::IfcExternalReference::getItemReference ( ) const

Returns the value of ItemReference attribute. This attribute represents identifier for the referenced item in the external source (classification, document or library). The internal reference can provide a computer interpretable pointer into electronic source.

Returns: Returns the value of ItemReference attribute.

◆ getLocation()

const OdAnsiString & OdIfc2x_final::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 & OdIfc2x_final::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 OdIfc2x_final::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 OdIfc2x_final::IfcClassificationReference, OdIfc2x_final::IfcDocumentReference, and OdIfc2x_final::IfcLibraryReference.

◆ isKindOf()

virtual bool OdIfc2x_final::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 OdIfc2x_final::IfcClassificationReference, OdIfc2x_final::IfcDocumentReference, and OdIfc2x_final::IfcLibraryReference.

◆ outFields()

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

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::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 OdIfc2x_final::IfcClassificationReference, OdIfc2x_final::IfcDocumentReference, and OdIfc2x_final::IfcLibraryReference.

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::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 OdIfc2x_final::IfcClassificationReference, OdIfc2x_final::IfcDocumentReference, and OdIfc2x_final::IfcLibraryReference.

◆ setItemReference()

void OdIfc2x_final::IfcExternalReference::setItemReference ( const OdAnsiString & ItemReference )

Sets the value of ItemReference attribute. This attribute represents identifier for the referenced item in the external source (classification, document or library). The internal reference can provide a computer interpretable pointer into electronic source.

Parameters

ItemReference [in] Item reference to set.

◆ setLocation()

void OdIfc2x_final::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 OdIfc2x_final::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 OdIfc2x_final::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 OdIfc2x_final::IfcClassificationReference, OdIfc2x_final::IfcDocumentReference, and OdIfc2x_final::IfcLibraryReference.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::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 OdIfc2x_final::IfcClassificationReference, OdIfc2x_final::IfcDocumentReference, and OdIfc2x_final::IfcLibraryReference.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::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 OdIfc2x_final::IfcClassificationReference, OdIfc2x_final::IfcDocumentReference, and OdIfc2x_final::IfcLibraryReference.