///////////////////////////////////////////////////////////////////////////////
// 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 _IFC2X_FINAL_IFCCONSTRUCTIONMATERIALRESOURCE_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCCONSTRUCTIONMATERIALRESOURCE_AUTO_IMPL_H
#include "IfcResourceAutoImpl.h"
#include "IfcMeasureWithUnitAutoImpl.h"
#include "TD_PackPush.h"
/** \details
The namespace contains schema-dependent classes, definitions and sub routines
for work with IFC2X_FINAL express schema definitions.
*/
namespace OdIfc2x_final {
/** \details
IfcConstructionMaterialResource identifies a material resource type in a construction project.
Occurrences of IfcConstructionMaterialResource are consumed (wholly or partially), or occupied during a construction work task (IfcTask).
- Object Typing -
This concept can be applied to the following resources:
* IfcConstructionMaterialResourceType
- Quantity Sets -
This concept can be applied to the following resources:
* Qto_ConstructionMaterialResourceBaseQuantities
- Resource Cost -
This concept can be applied with the following combinations:
CostType CostName ValueType
IfcCostValue Material IfcMonetaryMeasure
- Resource Quantity -
This concept can be applied with the following combinations:
QuantityType QuantityName
IfcQuantityTime Labor
- Resource Type Assignment -
This concept can be applied to the following resources:
* IfcGeographicElement - Indicates a physical element manifesting the resource such as a pile of sand.
\remarks
This entity is not the same as IfcMaterial. IfcConstructionMaterialResource represents usage of bulk materials such as sand, gravels, nails, etc.
while IfcMaterial is about physical materials that a physical building element consists of, possibly with detailed material layering information.
*/
class IFC2X_FINAL_EXPORT IfcConstructionMaterialResource : public IfcResource
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcConstructionMaterialResource);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of Suppliers attribute.
This attribute represents possible suppliers of the type of materials.
\param Suppliers [out] Receives the Suppliers attribute.
*/
void getSuppliers(OdArray& Suppliers) const;
/** \details
Returns the value of Suppliers attribute.
This attribute represents possible suppliers of the type of materials.
\param Suppliers [out] Receives the Suppliers attribute.
*/
void getSuppliersWrapperArray(OdArray& Suppliers) const;
/** \details
Gets the value of Suppliers attribute.
This attribute represents possible suppliers of the type of materials.
\returns
Returns the value of Suppliers attribute.
*/
OdDAI::SetOfSelect& suppliers();
/** \details
Returns the value of OrderQuantity attribute.
This attribute represents the basic quantity for ordering.
\returns
Returns the value of OrderQuantity attribute.
*/
const OdDAIObjectId& getOrderQuantity() const;
/** \details
Sets the value of OrderQuantity attribute.
This attribute represents the basic quantity for ordering.
\param OrderQuantity [in] Order quantity to set.
*/
void setOrderQuantity(const OdDAIObjectId& OrderQuantity);
/** \details
Gets the value of DesignMaterial attribute.
This attribute represents the materials specified by the design process that needs to be procured in the construction processes as the resource.
\param DesignMaterial [out] Receives the design material.
*/
void getDesignMaterial(OdDAIObjectIds& DesignMaterial) const;
/** \details
Returns the value of DesignMaterial attribute.
This attribute represents the materials specified by the design process that needs to be procured in the construction processes as the resource.
\returns
Returns the value of DesignMaterial attribute.
*/
OdDAI::SetOfOdDAIObjectId& designMaterial();
public:
/** \details
Default constructor for the IfcConstructionMaterialResource class.
*/
IfcConstructionMaterialResource();
/** \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:
OdDAI::SetOfSelect m_Suppliers; // SET [1:?] of IfcActorSelect [optional]
OdDAIObjectId m_OrderQuantity; // IfcMeasureWithUnit [optional]
OdDAI::SetOfOdDAIObjectId m_DesignMaterial; // SET [1:?] of IfcMaterial [optional]
};
/** \details
A data type that represents a smart pointer to a IfcConstructionMaterialResource object.
*/
typedef OdSmartPtr IfcConstructionMaterialResourcePtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC2X_FINAL_IFCCONSTRUCTIONMATERIALRESOURCE_AUTO_IMPL_H