///////////////////////////////////////////////////////////////////////////////
// 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 _IFC4X2_IFCFIXEDREFERENCESWEPTAREASOLID_AUTO_IMPL_H
#define _IFC4X2_IFCFIXEDREFERENCESWEPTAREASOLID_AUTO_IMPL_H
#include "IfcSweptAreaSolidAutoImpl.h"
#include "IfcCurveAutoImpl.h"
#include "IfcDirectionAutoImpl.h"
#include "TD_PackPush.h"
/** \details
The namespace contains schema-dependent classes, definitions and sub routines
for work with IFC4X2 express schema definitions.
*/
namespace OdIfc4x2 {
/** \details
An IfcFixedReferenceSweptAreaSolid is a type of swept area solid which is the result of sweeping an area along a Directrix.
The swept area is provided by a subtype of IfcProfileDef. The profile is placed by an implicit Cartesian transformation operator
at the start point of the sweep, where the profile normal agrees to the start tangent of the directrix at this point,
and the profile's x-axis agrees to the orthogonal projection of the FixedReference direction within the plane of start tangent and Fixed_Reference.
The orientation of the curve during the sweeping operation is controlled by the FixedReference direction.
The Directrix and the ReferenceSurface are positioned within the object coordinate system.
The start of the sweeping operation is at the StartParam, being either the parameter value based on the curve parameterization,
or by a length measured along the directrix from its beginning. If no StartParam is provided the start defaults to the begin of the Directrix.
The end of the sweeping operation is at the EndParam, being either the parameter value based on the curve parameterization,
or by a length measured along the directrix from its beginning. If no EndParam is provided the end defaults to the end of the Directrix.
*/
class IFC4X2_EXPORT IfcFixedReferenceSweptAreaSolid : public IfcSweptAreaSolid
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc4x2::IfcFixedReferenceSweptAreaSolid);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of Directrix attribute.
This attribute represents the curve that is used to define the sweeping operation.
The solid is generated by sweeping the SELF\IfcSweptAreaSolid.SweptArea along the Directrix.
\returns
Returns the value of Directrix attribute.
*/
const OdDAIObjectId& getDirectrix() const;
/** \details
Sets the value of Directrix attribute.
This attribute represents the curve that is used to define the sweeping operation.
The solid is generated by sweeping the SELF\IfcSweptAreaSolid.SweptArea along the Directrix.
\param Directrix [in] Directrix to set.
*/
void setDirectrix(const OdDAIObjectId& Directrix);
/** \details
Returns the value of StartParam attribute.
This attribute represents the parameter value on the Directrix at which the sweeping operation commences.
If no value is provided, the start of the sweeping operation is at the start of the Directrix.
\returns
Returns the value of StartParam attribute.
*/
double getStartParam() const;
/** \details
Sets the value of StartParam attribute.
This attribute represents the parameter value on the Directrix at which the sweeping operation commences.
If no value is provided, the start of the sweeping operation is at the start of the Directrix.
\param StartParam [in] Start parameter to set.
*/
void setStartParam(double StartParam);
/** \details
Returns the value of EndParam attribute.
This attribute represents the parameter value on the Directrix at which the sweeping operation ends.
If no value is provided, the end of the sweeping operation is at the end of the Directrix.
\returns
Returns the value of EndParam attribute.
*/
double getEndParam() const;
/** \details
Sets the value of EndParam attribute.
This attribute represents the parameter value on the Directrix at which the sweeping operation ends.
If no value is provided, the end of the sweeping operation is at the end of the Directrix.
\param EndParam [in] End parameter to set.
*/
void setEndParam(double EndParam);
/** \details
Returns the value of FixedReference attribute.
This attribute represents the direction providing the fixed axis1 (x-axis) direction
for orienting the swept area during the sweeping operation along the Directrix.
\returns
Returns the value of FixedReference attribute.
*/
const OdDAIObjectId& getFixedReference() const;
/** \details
Sets the value of FixedReference attribute.
This attribute represents the direction providing the fixed axis1 (x-axis) direction
for orienting the swept area during the sweeping operation along the Directrix.
\param FixedReference [in] Fixed reference to set.
*/
void setFixedReference(const OdDAIObjectId& FixedReference);
public:
/** \details
Default constructor for the IfcFixedReferenceSweptAreaSolid class.
*/
IfcFixedReferenceSweptAreaSolid();
/** \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_Directrix; // IfcCurve
double m_StartParam; // IfcParameterValue [optional]
double m_EndParam; // IfcParameterValue [optional]
OdDAIObjectId m_FixedReference; // IfcDirection
};
/** \details
A data type that represents a smart pointer to a IfcFixedReferenceSweptAreaSolid object.
*/
typedef OdSmartPtr IfcFixedReferenceSweptAreaSolidPtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC4X2_IFCFIXEDREFERENCESWEPTAREASOLID_AUTO_IMPL_H