OdIfc2x_final::IfcDocumentReference Class Reference

#include <IfcDocumentReferenceAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcDocumentReference:

Public Member Functions
void	getInvReferenceToDocument (OdDAIObjectIds &ReferenceToDocument) const
virtual OdResult	inFields (OdDAI::OdSpfFilerBase *rdFiler) override
virtual OdResult	outFields (OdDAI::OdSpfFilerBase *wrFiler) override
virtual OdDAI::Entity *	getInstanceType () const override
virtual void	unsetAttr (const char *explicitAttrName) override
virtual bool	testAttr (const char *explicitAttrName) const 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 OdIfc2x_final::IfcExternalReference
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 ()
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 Member Functions
virtual OdRxValue	getAttr (const char *attrName) const override
virtual bool	putAttr (const char *explicitAttrName, const OdRxValue &val) override

Friends
class	IfcDocumentInformation

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)
Protected Attributes inherited from OdIfc2x_final::IfcExternalReference
OdAnsiString	m_Location
OdAnsiString	m_ItemReference
OdAnsiString	m_Name
Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr
IfcOpResult	m_resolved

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.

Definition at line 45 of file Ifc2x_Final/IfcDocumentReferenceAutoImpl.h.

Member Function Documentation

getAttr() [1/2]

virtual OdRxValue OdIfc2x_final::IfcExternalReference::getAttr ( const char * attrName ) const

overrideprotectedvirtual

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 OdIfc2x_final::IfcExternalReference.

getAttr() [2/2]

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

getInstanceType()

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

getInvReferenceToDocument()

void OdIfc2x_final::IfcDocumentReference::getInvReferenceToDocument

(

OdDAIObjectIds &

ReferenceToDocument

)

const

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

Parameters

ReferenceToDocument

[out] Receives the value of ReferenceToDocument attribute.

inFields()

virtual OdResult OdIfc2x_final::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 OdIfc2x_final::IfcExternalReference.

isKindOf()

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

outFields()

virtual OdResult OdIfc2x_final::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 OdIfc2x_final::IfcExternalReference.

putAttr() [1/2]

virtual bool OdIfc2x_final::IfcExternalReference::putAttr ( const char * explicitAttrName, const OdRxValue & val )

overrideprotectedvirtual

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 OdIfc2x_final::IfcExternalReference.

putAttr() [2/2]

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

testAttr() [1/2]

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

testAttr() [2/2]

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

type()

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

unsetAttr() [1/2]

virtual void OdIfc2x_final::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 OdIfc2x_final::IfcExternalReference.

unsetAttr() [2/2]

virtual void OdIfc2x_final::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 OdIfc2x_final::IfcExternalReference.

Friends And Related Symbol Documentation

IfcDocumentInformation

friend class IfcDocumentInformation

friend

Definition at line 160 of file Ifc2x_Final/IfcDocumentReferenceAutoImpl.h.

---

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

• Ifc2x_Final/IfcDocumentReferenceAutoImpl.h