///////////////////////////////////////////////////////////////////////////////
// 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_IFCSURFACECURVE_AUTO_IMPL_H
#define _IFC4X1_IFCSURFACECURVE_AUTO_IMPL_H
#include "IfcCurveAutoImpl.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 IfcSurfaceCurve is a 3-dimensional curve that has additional representations provided by one or two pcurves.
*/
class IFC4X1_EXPORT IfcSurfaceCurve : public IfcCurve
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc4x1::IfcSurfaceCurve);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of Curve3D attribute.
This attribute represents the curve which is the three-dimensional representation of the surface curve.
\returns
Returns the value of Curve3D attribute.
*/
const OdDAIObjectId& getCurve3D() const;
/** \details
Sets the value of Curve3D attribute.
This attribute represents the curve which is the three-dimensional representation of the surface curve.
\param Curve3D [in] Curve3D to set.
*/
void setCurve3D(const OdDAIObjectId& Curve3D);
/** \details
Gets the value of AssociatedGeometry attribute.
This attribute represents a list of one or two pcurves which define the surface or surfaces associated with the surface curve.
Two elements in this list indicate that the curve has two surface associations which need not be two distinct surfaces.
As a pcurve, it also associates a basis curve in the parameter space of this surface as an alternative representation of the surface curve.
\param AssociatedGeometry [out] Receives the associated geometry.
*/
void getAssociatedGeometry(OdDAIObjectIds& AssociatedGeometry) const;
/** \details
Returns the value of AssociatedGeometry attribute.
This attribute represents a list of one or two pcurves which define the surface or surfaces associated with the surface curve.
Two elements in this list indicate that the curve has two surface associations which need not be two distinct surfaces.
As a pcurve, it also associates a basis curve in the parameter space of this surface as an alternative representation of the surface curve.
\returns
Returns the value of AssociatedGeometry attribute.
*/
OdDAI::ListOfOdDAIObjectId& associatedGeometry();
/** \details
Returns the value of MasterRepresentation attribute.
This attribute represents the MasterRepresentation defines the curve used to determine the unique parametrization of the IfcSurfaceCurve.
The MasterRepresentation attribute takes one of the values Curve3D, PCurve_S1 or PCurve_S2 to indicate a preference for the 3D curve,
or the first or second pcurve, in the associated geometry list, respectively.
Multiple representations provide the ability to communicate data in more than one form, even though the data is expected to be geometrically identical.
\returns
Returns the value of MasterRepresentation attribute.
*/
IfcPreferredSurfaceCurveRepresentation getMasterRepresentation() const;
/** \details
Sets the value of MasterRepresentation attribute.
This attribute represents the MasterRepresentation defines the curve used to determine the unique parametrization of the IfcSurfaceCurve.
The MasterRepresentation attribute takes one of the values Curve3D, PCurve_S1 or PCurve_S2 to indicate a preference for the 3D curve,
or the first or second pcurve, in the associated geometry list, respectively.
Multiple representations provide the ability to communicate data in more than one form, even though the data is expected to be geometrically identical.
\param MasterRepresentation [in] MasterRepresentation attribute to set.
*/
void setMasterRepresentation(IfcPreferredSurfaceCurveRepresentation MasterRepresentation);
public:
/** \details
Default constructor for the IfcSurfaceCurve class.
*/
IfcSurfaceCurve();
/** \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:
OdDAIObjectId m_Curve3D; // IfcCurve
OdDAI::ListOfOdDAIObjectId m_AssociatedGeometry; // LIST [1:2] of IfcPcurve
OdDAI::Enum m_MasterRepresentation; // IfcPreferredSurfaceCurveRepresentation
};
/** \details
A data type that represents a smart pointer to a IfcSurfaceCurve object.
*/
typedef OdSmartPtr IfcSurfaceCurvePtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC4X1_IFCSURFACECURVE_AUTO_IMPL_H