///////////////////////////////////////////////////////////////////////////////
// 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_IFCSUBCONTRACTRESOURCE_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCSUBCONTRACTRESOURCE_AUTO_IMPL_H
#include "IfcResourceAutoImpl.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
IfcSubContractResource is a construction resource needed in a construction process that represents a sub-contractor.
An IfcSubContractResource can be used in cost estimating and work planning with or without specifying the subcontractor and contract agreement.
The purpose of an IfcSubContractResource is to indicate work of a particular type that is that is to be engaged through the use of a sub-contract.
Its aim is to identify the description of the sub-contract work required.
It can be used to identify the generic type of sub-contract resource that is required for
a purpose without having to be specific about the actor (person or organization) providing the resource occurrence.
It can be particularly useful when creating an overall plan for a process or processes.
For instance, within maintenance or work planning there can be a known task
that needs to be done which is planned to require an 'insulation specialist'.
A subcontract resource can be described at various stages and levels of detail through its assignments:
* Subcontract resource designated for particular tasks
* Actors identified to request bids
* Cost schedules (bids) received from actors
* Project order (work order, change order, etc.) executed
- Object Typing -
This concept can be applied to the following resources:
* IfcSubContractResourceType
- Resource Assignment -
This concept can be applied to the following resources:
* IfcActor - Indicates a specific organization to be considered to fulfill the resource or invited to bid on the resource.
*/
class IFC2X_FINAL_EXPORT IfcSubContractResource : public IfcResource
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcSubContractResource);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of SubContractResourceID attribute.
This attribute represents an identifier to identify sub-contract.
\returns
Returns the value of SubContractResourceID attribute.
*/
const OdAnsiString& getSubContractResourceID() const;
/** \details
Sets the value of SubContractResourceID attribute.
This attribute represents an identifier to identify sub-contract.
\param SubContractResourceID [in] Sub-contract resource ID to set.
*/
void setSubContractResourceID(const OdAnsiString& SubContractResourceID);
/** \details
Returns the value of SubContractor attribute.
This attribute represents the actor performing the role of the subcontracted resource.
\returns
Returns the value of SubContractor attribute.
*/
IfcActorSelect subContractor();
/** \details
Returns the value of JobDescription attribute.
This attribute represents the description of the jobs that this subcontract should complete.
\returns
Returns the value of JobDescription attribute.
*/
const OdAnsiString& getJobDescription() const;
/** \details
Sets the value of JobDescription attribute.
This attribute represents the description of the jobs that this subcontract should complete.
\param JobDescription [in] Job description to set.
*/
void setJobDescription(const OdAnsiString& JobDescription);
public:
/** \details
Default constructor for the IfcSubContractResource class.
*/
IfcSubContractResource();
/** \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_SubContractResourceID; // IfcIdentifier
OdDAI::Select m_SubContractor; // IfcActorSelect [optional]
OdAnsiString m_JobDescription; // IfcText [optional]
};
/** \details
A data type that represents a smart pointer to a IfcSubContractResource object.
*/
typedef OdSmartPtr IfcSubContractResourcePtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC2X_FINAL_IFCSUBCONTRACTRESOURCE_AUTO_IMPL_H