///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance").
// All rights reserved.
//
// This software and its documentation and related materials are owned by
// the Alliance. The software may only be incorporated into application
// programs owned by members of the Alliance, subject to a signed
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable
// trade secrets of the Alliance and its suppliers. The software is also
// protected by copyright law and international treaty provisions. Application
// programs incorporating this software must include the following statement
// with their copyright notices:
//
// This application incorporates Open Design Alliance software pursuant to a license
// agreement with Open Design Alliance.
// Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance.
// All rights reserved.
//
// By use of this software, its documentation or related materials, you
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////
// This file is generated automatically.
#ifndef _IFC4X1_IFCLIBRARYINFORMATION_AUTO_IMPL_H
#define _IFC4X1_IFCLIBRARYINFORMATION_AUTO_IMPL_H
#include "IfcExternalInformationAutoImpl.h"
#include "TD_PackPush.h"
/** \details
The namespace contains schema-dependent classes, definitions and sub routines
for work with IFC4X1 express schema definitions.
*/
namespace OdIfc4x1 {
/** \details
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"
*/
class IFC4X1_EXPORT IfcLibraryInformation : public IfcExternalInformation
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc4x1::IfcLibraryInformation);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of Name attribute.
This attribute represents the name which identifies the library.
\returns
Returns the value of Name attribute.
*/
const OdAnsiString& getName() const;
/** \details
Sets the value of Name attribute.
This attribute represents the name which identifies the library.
\param Name [in] Name to set.
*/
void setName(const OdAnsiString& Name);
/** \details
Returns the value of Version attribute.
This attribute represents identifier for the library version used for reference.
\returns
Returns the value of Version attribute.
*/
const OdAnsiString& getVersion() const;
/** \details
Sets the value of Version attribute.
This attribute represents identifier for the library version used for reference.
\param Version [in] Version to set.
*/
void setVersion(const OdAnsiString& Version);
/** \details
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.
*/
IfcActorSelect publisher();
/** \details
Returns the value of VersionDate attribute.
This attribute represents date of the referenced version of the library.
\returns
Returns the value of VersionDate attribute.
*/
const OdAnsiString& getVersionDate() const;
/** \details
Sets the value of VersionDate attribute.
This attribute represents date of the referenced version of the library.
\param VersionDate [in] Version date to set.
*/
void setVersionDate(const OdAnsiString& VersionDate);
/** \details
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.
*/
const OdAnsiString& getLocation() const;
/** \details
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.
\param Location [in] Location to set.
*/
void setLocation(const OdAnsiString& Location);
/** \details
Returns the value of Description attribute.
This attribute represents additional description provided for the library revision information.
\returns
Returns the value of Description attribute.
*/
const OdAnsiString& getDescription() const;
/** \details
Sets the value of Description attribute.
This attribute represents additional description provided for the library revision information.
\param Description [in] Description to set.
*/
void setDescription(const OdAnsiString& Description);
/** \details
Returns the value of LibraryInfoForObjects attribute.
This attribute represents the library information with which objects are associated.
\param LibraryInfoForObjects [out] Receives the value of LibraryInfoForObjects attribute.
*/
void getInvLibraryInfoForObjects(OdDAIObjectIds& LibraryInfoForObjects) const;
/** \details
Returns the value of HasLibraryReferences attribute.
This attribute represents the library references to which the library information applies.
\param HasLibraryReferences [out] Receives the value of HasLibraryReferences attribute.
*/
void getInvHasLibraryReferences(OdDAIObjectIds& HasLibraryReferences) const;
public:
/** \details
Default constructor for the IfcLibraryInformation class.
*/
IfcLibraryInformation();
/** \details
Reads object's data from the specified filer.
\param 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.
*/
virtual OdResult inFields(OdDAI::OdSpfFilerBase* rdFiler) override;
/** \details
Writes object's data the the specified filer.
\param 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.
*/
virtual OdResult outFields(OdDAI::OdSpfFilerBase* wrFiler) override;
/** \details
Returns a type of a class instance.
\returns
Pointer to the OdDAI::Entity type that determines an entity definition within a schema.
*/
virtual OdDAI::Entity* getInstanceType() const override;
/** \details
Returns an attribute value for the specified attribute name.
\param attrName [in] Name of an attribute to query.
\returns
OdRxValue object that represents a generic variant type value.
*/
virtual OdRxValue getAttr(const char * attrName) const override;
/** \details
Resets a value for the specified attribute.
\param explicitAttrName [in] Explicit name of the attribute to reset.
*/
virtual void unsetAttr(const char * explicitAttrName) override;
/** \details
Checks whether the specified attribute is set.
\param explicitAttrName [in] Explicit name of the attribute to test.
\returns
true if the specified attribute is set, false otherwise.
*/
virtual bool testAttr(const char * explicitAttrName) const override;
/** \details
Sets the specified attribute with a given value.
\param explicitAttrName [in] Explicit name of the attribute to set.
\param val [in] Value to set.
\returns
true if the value is successfully set for the specified attribute, false otherwise.
*/
virtual bool putAttr(const char * explicitAttrName, const OdRxValue &val) override;
/** \details
Checks whether the specified instance is the object derived from or belongs to this class.
\param entityType [in] Entity to check.
\returns
true if the specified instance is the object derived from or belongs to this class, false otherwise.
*/
virtual bool isKindOf(OdIfc::OdIfcEntityType entityType) const override;
/** \details
Returns the type of this entity.
\returns
A value of the OdIfc::OdIfcEntityType type that represents type of this entity.
*/
virtual OdIfc::OdIfcEntityType type() const override;
/** \details
Returns an attribute value for the specified attribute definition.
\param attrDef [in] Attribute definition to query.
\returns
OdRxValue object that represents a generic variant type value.
*/
virtual OdRxValue getAttr(const OdIfc::OdIfcAttribute attrDef) const override;
/** \details
Resets a value for the specified attribute.
\param explicitAttrDef [in] Explicit definition that represents an attribute to reset.
*/
virtual void unsetAttr(const OdIfc::OdIfcAttribute explicitAttrDef) override;
/** \details
Checks whether the specified attribute is set.
\param explicitAttrDef [in] Attribute definition to test.
\returns
true if the specified attribute is set, false otherwise.
*/
virtual bool testAttr(const OdIfc::OdIfcAttribute explicitAttrDef) const override;
/** \details
Sets the specified attribute with a given value.
\param explicitAttrDef [in] Explicit attribute definition to set.
\param val [in] Value to set.
\returns
true if the value is successfully set for the specified attribute, false otherwise.
*/
virtual bool putAttr(const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override;
protected:
// Fields declaration:
OdAnsiString m_Name; // IfcLabel
OdAnsiString m_Version; // IfcLabel [optional]
OdDAI::Select m_Publisher; // IfcActorSelect [optional]
OdAnsiString m_VersionDate; // IfcDateTime [optional]
OdAnsiString m_Location; // IfcURIReference [optional]
OdAnsiString m_Description; // IfcText [optional]
// Declare friend classes for inverse attributes functionality:
friend class IfcRelAssociatesLibrary;
friend class IfcLibraryReference;
};
/** \details
A data type that represents a smart pointer to a IfcLibraryInformation object.
*/
typedef OdSmartPtr IfcLibraryInformationPtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC4X1_IFCLIBRARYINFORMATION_AUTO_IMPL_H