CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x1::IfcLibraryReference Class Reference

#include <IfcLibraryReferenceAutoImpl.h>

Inheritance diagram for OdIfc4x1::IfcLibraryReference:
OdIfc4x1::IfcExternalReference OdIfc4x1::OdIfc4x1Instance OdIfc::OdIfcInstance

Public Member Functions

const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
const OdAnsiString & getLanguage () const
 
void setLanguage (const OdAnsiString &Language)
 
const OdDAIObjectId & getReferencedLibrary () const
 
void setReferencedLibrary (const OdDAIObjectId &ReferencedLibrary)
 
void getInvLibraryRefForObjects (OdDAIObjectIds &LibraryRefForObjects) const
 
 IfcLibraryReference ()
 
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 OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdAnsiString m_Description
 
IfcLanguageId m_Language
 
OdDAIObjectId m_ReferencedLibrary
 
- Protected Attributes inherited from OdIfc4x1::IfcExternalReference
OdAnsiString m_Location
 
OdAnsiString m_Identification
 
OdAnsiString m_Name
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcRelAssociatesLibrary
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3dasPoint3d (const OdIfcInstance *inst)
 
static const OdGePoint2dasPoint2d (const OdIfcInstance *inst)
 
static const OdGeVector3dasVector3d (const OdIfcInstance *inst)
 
static const OdGeVector2dasVector2d (const OdIfcInstance *inst)
 
static const OdGeMatrix2dasMatrix2d (const OdIfcInstance *inst)
 
static const OdGeMatrix3dasMatrix3d (const OdIfcInstance *inst)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcInstance > inst)
 
static const OdCmEntityColorasRgbColor (const OdIfcInstance *inst)
 

Detailed Description

An IfcLibraryReference is a reference into a library of information by Location (provided as a URI). It also provides an optional inherited Identification key to allow more specific references to library sections or tables. The inherited Name attribute provides a human interpretable identification of the library item. Also, general information on the library from which the reference is taken, is provided by the ReferencedLibrary relation which identifies the relevant occurrence of IfcLibraryInformation.

Depending on the type of technology used by the library, different IfcLibraryReference.Identification identifiers are appropriate:

Publisher Technology Identifier ASHRAE BACnet 32-bit decimal BACnetObjectIdentifier indicating type ID and instance ID (e.g.'12.15' for Digital Input #15) Brick Development Team Brick Full URI with no abbreviation (e.g. 'http://example.org/digitaltwin#AHU01', not 'digitaltwin:AHU01') IETF IPv4 32-bit decimal address for an IPv4 network (e.g.'192.168.1.1') IETF IPv6 128-bit hexadecimal address for an IPv6 network IETF MAC 48-bit hexadecimal form of MAC address ISOIEC LonTalk 48-bit hexadecimal neuron ID OPCFoundation OPC Hierarchical ItemID in alphanumeric form (i.e. 'B204.Tank2.Temperature) SmartLabs Insteon 24-bit hexadecimal instance address

\changes

IFC4 changes: Inverse attribute ReferenceIntoLibrary renamed to LibraryRefForObjects Type of the inverse attribute ReferenceIntoLibrary changed from "SET OF [0:1] IfcLibraryInformation FOR LibraryReference" to "SET OF [0:?] IfcRelAssociatesLibrary FOR RelatingLibrary"

Definition at line 65 of file Ifc4x1/IfcLibraryReferenceAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcLibraryReference()

OdIfc4x1::IfcLibraryReference::IfcLibraryReference ( )

Default constructor for the IfcLibraryReference class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x1::IfcLibraryReference::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::IfcLibraryReference::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::IfcLibraryReference::getDescription ( ) const

Returns the value of Description attribute. This attribute represents additional description provided for the library reference.

Returns
Returns the value of Description attribute.

◆ getInstanceType()

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

◆ getInvLibraryRefForObjects()

void OdIfc4x1::IfcLibraryReference::getInvLibraryRefForObjects ( OdDAIObjectIds & LibraryRefForObjects) const

Returns the value of LibraryRefForObjects attribute. This attribute represents the library reference with which objects are associated.

Parameters
LibraryRefForObjects[out] Receives the value of LibraryRefForObjects attribute.

◆ getLanguage()

const OdAnsiString & OdIfc4x1::IfcLibraryReference::getLanguage ( ) const

Returns the value of Language attribute. This attribute represents the language in which a library reference is expressed.

Returns
Returns the value of Language attribute.

◆ getReferencedLibrary()

const OdDAIObjectId & OdIfc4x1::IfcLibraryReference::getReferencedLibrary ( ) const

Returns the value of ReferencedLibrary attribute. This attribute represents the library information that is referenced.

Returns
Returns the value of ReferencedLibrary attribute.

◆ inFields()

virtual OdResult OdIfc4x1::IfcLibraryReference::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::IfcLibraryReference::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::IfcLibraryReference::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::IfcLibraryReference::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::IfcLibraryReference::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::IfcLibraryReference::setDescription ( const OdAnsiString & Description)

Sets the value of Description attribute. This attribute represents additional description provided for the library reference.

Parameters
Description[in] Description to set.

◆ setInverseCounterParts()

virtual void OdIfc4x1::IfcLibraryReference::setInverseCounterParts ( )
overridevirtual

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

◆ setLanguage()

void OdIfc4x1::IfcLibraryReference::setLanguage ( const OdAnsiString & Language)

Sets the value of Language attribute. This attribute represents the language in which a library reference is expressed.

Parameters
Language[in] Language to set.

◆ setReferencedLibrary()

void OdIfc4x1::IfcLibraryReference::setReferencedLibrary ( const OdDAIObjectId & ReferencedLibrary)

Sets the value of ReferencedLibrary attribute. This attribute represents the library information that is referenced.

Parameters
ReferencedLibrary[in] Referenced library to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x1::IfcLibraryReference::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::IfcLibraryReference::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::IfcLibraryReference::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::IfcLibraryReference::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::IfcLibraryReference::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

◆ IfcRelAssociatesLibrary

friend class IfcRelAssociatesLibrary
friend

Definition at line 251 of file Ifc4x1/IfcLibraryReferenceAutoImpl.h.

Member Data Documentation

◆ m_Description

OdAnsiString OdIfc4x1::IfcLibraryReference::m_Description
protected

Definition at line 246 of file Ifc4x1/IfcLibraryReferenceAutoImpl.h.

◆ m_Language

IfcLanguageId OdIfc4x1::IfcLibraryReference::m_Language
protected

Definition at line 247 of file Ifc4x1/IfcLibraryReferenceAutoImpl.h.

◆ m_ReferencedLibrary

OdDAIObjectId OdIfc4x1::IfcLibraryReference::m_ReferencedLibrary
protected

Definition at line 248 of file Ifc4x1/IfcLibraryReferenceAutoImpl.h.


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