///////////////////////////////////////////////////////////////////////////////
// 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_IFCELECTRICDISTRIBUTIONPOINT_AUTO_IMPL_H
#define _IFC2X2_FINAL_IFCELECTRICDISTRIBUTIONPOINT_AUTO_IMPL_H
#include "IfcFlowControllerAutoImpl.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
An IfcElectricDistributionPoint is a flow controller in which instances of electrical devices are brought together at a single place for a particular purpose.
- Property Set Use Definition -
The property sets relating to the IfcElectricDistributionPoint are defined
by the IfcPropertySet and attached by the IfcRelDefinesByProperties relationship.
It is accessible by the inverse IsDefinedBy relationship.
- Use Definitions -
An IfcElectricDistributionPoint provides a housing for an aggregation of different types of
instances of electrical distribution elements so that they can be viewed, operated or acted upon from a single place.
Each item in the aggregation can have its own geometric representation and location by being a subtype of IfcProduct.
IfcElectricDistributionPoint acts as the relating object in an IfcRelAggregates relationship.
- Local Placement -
The local placement is defined in the IfcProduct supertype. It is defined by a subtype of IfcObjectPlacement
that can define an absolute placement, relative placement, or grid reference,
with each defining the local coordinate system referenced by all geometric representations.
If specified, the PlacementRelTo relationship of IfcLocalPlacement points to the same IfcSpatialStructureElement
that is used in the ContainedInStructure inverse attribute, or to a referenced spatial structure element at a higher level.
If the relative placement is not used, the absolute placement is defined within the world coordinate system.
- B-Rep Representation -
The faceted B-Rep capabilities (with or without voids) are supported for B-Rep representation.
*/
class IFC2X2_FINAL_EXPORT IfcElectricDistributionPoint : public IfcFlowController
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc2x2_final::IfcElectricDistributionPoint);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of DistributionPointFunction attribute.
This attribute represents the functions or purposes that a distribution point can fulfill.
\returns
Returns the value of DistributionPointFunction attribute.
*/
IfcElectricDistributionPointFunctionEnum getDistributionPointFunction() const;
/** \details
Sets the value of DistributionPointFunction attribute.
This attribute represents the functions or purposes that a distribution point can fulfill.
\param DistributionPointFunction [in] DistributionPointFunction attribute to set.
*/
void setDistributionPointFunction(IfcElectricDistributionPointFunctionEnum DistributionPointFunction);
/** \details
Returns the value of UserDefinedFunction attribute.
This attribute represents the user-defined function that is used
when DistributionPointFunction attribute is set to USERDEFINED.
\returns
Returns the value of UserDefinedFunction attribute.
*/
const OdAnsiString& getUserDefinedFunction() const;
/** \details
Sets the value of UserDefinedFunction attribute.
This attribute represents the user-defined function that is used
when DistributionPointFunction attribute is set to USERDEFINED.
\param UserDefinedFunction [in] UserDefinedFunction attribute to set.
*/
void setUserDefinedFunction(const OdAnsiString& UserDefinedFunction);
public:
/** \details
Default constructor for the IfcElectricDistributionPoint class.
*/
IfcElectricDistributionPoint();
/** \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::Enum m_DistributionPointFunction; // IfcElectricDistributionPointFunctionEnum
OdAnsiString m_UserDefinedFunction; // IfcLabel [optional]
};
/** \details
A data type that represents a smart pointer to a IfcElectricDistributionPoint object.
*/
typedef OdSmartPtr IfcElectricDistributionPointPtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC2X2_FINAL_IFCELECTRICDISTRIBUTIONPOINT_AUTO_IMPL_H