CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x4::IfcLibraryInformation Class Reference

#include <IfcLibraryInformationAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcLibraryInformation:
OdIfc4x4::IfcExternalInformation OdIfc4x4::OdIFC4X4Instance OdIfc::OdIfcInstance

Public Member Functions

const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getVersion () const
 
void setVersion (const OdAnsiString &Version)
 
IfcActorSelect publisher ()
 
const OdAnsiString & getVersionDate () const
 
void setVersionDate (const OdAnsiString &VersionDate)
 
const OdAnsiString & getLocation () const
 
void setLocation (const OdAnsiString &Location)
 
const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
void getInvLibraryInfoForObjects (OdDAIObjectIds &LibraryInfoForObjects) const
 
void getInvHasLibraryReferences (OdDAIObjectIds &HasLibraryReferences) const
 
 IfcLibraryInformation ()
 
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 OdIfc4x4::OdIFC4X4Instance
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_Name
 
OdAnsiString m_Version
 
OdDAI::Select m_Publisher
 
OdAnsiString m_VersionDate
 
OdAnsiString m_Location
 
OdAnsiString m_Description
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcRelAssociatesLibrary
 
class IfcLibraryReference
 

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 IfcLibraryInformation describes a library where a library is a structured store of information, normally organized in a manner which allows information lookup through an index or reference value. IfcLibraryInformation provides the library Name and optional Description, Version, VersionDate and Publisher attributes. A Location can be added for electronic access to the library.

\changes

IFC4 changes: Attribute LibraryReference renamed to Location Type of the LibraryReference attribute changed from "set[1:?] of IfcLibraryReference" to "IfcURIReference" Type of the Publisher attribute changed from "IfcOrganization" to "IfcActorSelect" Type of the VersionDate attribute changed from "IfcCalendarDate" to "IfcDateTime"

Definition at line 51 of file IFC4X4/IfcLibraryInformationAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcLibraryInformation()

OdIfc4x4::IfcLibraryInformation::IfcLibraryInformation ( )

Default constructor for the IfcLibraryInformation class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcLibraryInformation::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 from OdIfc4x4::IfcExternalInformation.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcLibraryInformation::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.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcLibraryInformation::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.

◆ getDescription()

const OdAnsiString & OdIfc4x4::IfcLibraryInformation::getDescription ( ) const

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

Returns
Returns the value of Description attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcLibraryInformation::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 OdIfc4x4::IfcExternalInformation.

◆ getInvHasLibraryReferences()

void OdIfc4x4::IfcLibraryInformation::getInvHasLibraryReferences ( OdDAIObjectIds & HasLibraryReferences) const

Returns the value of HasLibraryReferences attribute. This attribute represents the library references to which the library information applies.

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

◆ getInvLibraryInfoForObjects()

void OdIfc4x4::IfcLibraryInformation::getInvLibraryInfoForObjects ( OdDAIObjectIds & LibraryInfoForObjects) const

Returns the value of LibraryInfoForObjects attribute. This attribute represents the library information with which objects are associated.

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

◆ getLocation()

const OdAnsiString & OdIfc4x4::IfcLibraryInformation::getLocation ( ) const

Returns the value of Location attribute. This attribute represents resource identifier or locator, provided as URI, URN or URL of the library information for online references.

Returns
Returns the value of Location attribute.

◆ getName()

const OdAnsiString & OdIfc4x4::IfcLibraryInformation::getName ( ) const

Returns the value of Name attribute. This attribute represents the name which identifies the library.

Returns
Returns the value of Name attribute.

◆ getVersion()

const OdAnsiString & OdIfc4x4::IfcLibraryInformation::getVersion ( ) const

Returns the value of Version attribute. This attribute represents identifier for the library version used for reference.

Returns
Returns the value of Version attribute.

◆ getVersionDate()

const OdAnsiString & OdIfc4x4::IfcLibraryInformation::getVersionDate ( ) const

Returns the value of VersionDate attribute. This attribute represents date of the referenced version of the library.

Returns
Returns the value of VersionDate attribute.

◆ inFields()

virtual OdResult OdIfc4x4::IfcLibraryInformation::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.

◆ isKindOf()

virtual bool OdIfc4x4::IfcLibraryInformation::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 OdIfc4x4::IfcExternalInformation.

◆ outFields()

virtual OdResult OdIfc4x4::IfcLibraryInformation::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.

◆ publisher()

IfcActorSelect OdIfc4x4::IfcLibraryInformation::publisher ( )

Returns the value of Publisher attribute. This attribute represents information of the organization that acts as the library publisher.

Returns
Returns the value of Publisher attribute.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcLibraryInformation::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.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcLibraryInformation::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.

◆ setDescription()

void OdIfc4x4::IfcLibraryInformation::setDescription ( const OdAnsiString & Description)

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

Parameters
Description[in] Description to set.

◆ setLocation()

void OdIfc4x4::IfcLibraryInformation::setLocation ( const OdAnsiString & Location)

Sets the value of Location attribute. This attribute represents resource identifier or locator, provided as URI, URN or URL of the library information for online references.

Parameters
Location[in] Location to set.

◆ setName()

void OdIfc4x4::IfcLibraryInformation::setName ( const OdAnsiString & Name)

Sets the value of Name attribute. This attribute represents the name which identifies the library.

Parameters
Name[in] Name to set.

◆ setVersion()

void OdIfc4x4::IfcLibraryInformation::setVersion ( const OdAnsiString & Version)

Sets the value of Version attribute. This attribute represents identifier for the library version used for reference.

Parameters
Version[in] Version to set.

◆ setVersionDate()

void OdIfc4x4::IfcLibraryInformation::setVersionDate ( const OdAnsiString & VersionDate)

Sets the value of VersionDate attribute. This attribute represents date of the referenced version of the library.

Parameters
VersionDate[in] Version date to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcLibraryInformation::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.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcLibraryInformation::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.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcLibraryInformation::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 OdIfc4x4::IfcExternalInformation.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcLibraryInformation::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc::OdIfcInstance.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcLibraryInformation::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 OdIfc::OdIfcInstance.

Friends And Related Symbol Documentation

◆ IfcLibraryReference

friend class IfcLibraryReference
friend

Definition at line 302 of file IFC4X4/IfcLibraryInformationAutoImpl.h.

◆ IfcRelAssociatesLibrary

friend class IfcRelAssociatesLibrary
friend

Definition at line 301 of file IFC4X4/IfcLibraryInformationAutoImpl.h.

Member Data Documentation

◆ m_Description

OdAnsiString OdIfc4x4::IfcLibraryInformation::m_Description
protected

Definition at line 298 of file IFC4X4/IfcLibraryInformationAutoImpl.h.

◆ m_Location

OdAnsiString OdIfc4x4::IfcLibraryInformation::m_Location
protected

Definition at line 297 of file IFC4X4/IfcLibraryInformationAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc4x4::IfcLibraryInformation::m_Name
protected

Definition at line 293 of file IFC4X4/IfcLibraryInformationAutoImpl.h.

◆ m_Publisher

OdDAI::Select OdIfc4x4::IfcLibraryInformation::m_Publisher
protected

Definition at line 295 of file IFC4X4/IfcLibraryInformationAutoImpl.h.

◆ m_Version

OdAnsiString OdIfc4x4::IfcLibraryInformation::m_Version
protected

Definition at line 294 of file IFC4X4/IfcLibraryInformationAutoImpl.h.

◆ m_VersionDate

OdAnsiString OdIfc4x4::IfcLibraryInformation::m_VersionDate
protected

Definition at line 296 of file IFC4X4/IfcLibraryInformationAutoImpl.h.


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