///////////////////////////////////////////////////////////////////////////////
// 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 _IFC2X2_FINAL_IFCPROPERTY_AUTO_IMPL_H
#define _IFC2X2_FINAL_IFCPROPERTY_AUTO_IMPL_H
#include "Ifc2x2_FinalBaseClass.h"
#include "Ifc2x2_FinalEnum.h"
#include "Ifc2x2_FinalSelectTypes.h"
#include "Ifc2x2_FinalCollectionTypes.h"
#include "TD_PackPush.h"
/** \details
The namespace contains schema-dependent classes, definitions and sub routines
for work with IFC2X2_FINAL express schema definitions.
*/
namespace OdIfc2x2_final {
/** \details
IfcProperty is an abstract generalization for all types of properties that can be associated with IFC objects through the property set mechanism.
*/
class IFC2X2_FINAL_EXPORT IfcProperty : public OdIfc2x2_FinalInstance
{
//DOM-IGNORE-BEGIN
OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc2x2_final::IfcProperty);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of Name attribute that represents name for this property.
This label is the significant name string that defines the semantic meaning for the property.
\returns
Returns a string value representing the Name attribute.
*/
const OdAnsiString& getName() const;
/** \details
Sets the value of Name attribute that represents name for this property.
This label is the significant name string that defines the semantic meaning for the property.
\param Name [in] Name to set.
*/
void setName(const OdAnsiString& Name);
/** \details
Returns the value of Description attribute. Description is informative text to explain the property.
\returns
Returns a string value representing the Description attribute.
*/
const OdAnsiString& getDescription() const;
/** \details
Sets the value of Description attribute. Description is informative text to explain the property.
\param Description [in] Description to set.
*/
void setDescription(const OdAnsiString& Description);
/** \details
Returns the value of PropertyForDependance attribute. PropertyForDependance is the property on the value of which value of another property depends.
\param PropertyForDependance [out] Receives object identifiers representing the PropertyForDependance attribute.
*/
void getInvPropertyForDependance(OdDAIObjectIds& PropertyForDependance) const;
/** \details
Returns the value of PropertyDependsOn attribute. PropertyDependsOn is the relating property on which the value of the property depends.
\param PropertyDependsOn [out] Receives object identifiers representing the PropertyDependsOn attribute.
*/
void getInvPropertyDependsOn(OdDAIObjectIds& PropertyDependsOn) const;
/** \details
Returns the value of PartOfComplex attribute. PartOfComplex is reference to the IfcComplexProperty in which the IfcProperty is contained.
\param PartOfComplex [out] Receives object identifiers representing the PartOfComplex attribute.
*/
void getInvPartOfComplex(OdDAIObjectIds& PartOfComplex) const;
public:
/** \details
Default constructor for the IfcProperty class.
*/
IfcProperty();
/** \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; // IfcIdentifier
OdAnsiString m_Description; // IfcText [optional]
// Declare friend classes for inverse attributes functionality:
friend class IfcPropertyDependencyRelationship;
friend class IfcPropertyDependencyRelationship;
friend class IfcComplexProperty;
};
/** \details
A data type that represents a smart pointer to a IfcProperty object.
*/
typedef OdSmartPtr IfcPropertyPtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC2X2_FINAL_IFCPROPERTY_AUTO_IMPL_H