///////////////////////////////////////////////////////////////////////////////
// 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_IFCPRESENTATIONLAYERASSIGNMENTWITHSTYLE_AUTO_IMPL_H
#define _IFC2X2_FINAL_IFCPRESENTATIONLAYERASSIGNMENTWITHSTYLE_AUTO_IMPL_H
#include "IfcPresentationLayerAssignmentAutoImpl.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 IfcPresentationLayerAssignmentWithStyle extends the presentation layer assignment
with capabilities to define visibility control, access control and common style information.
The visibility control allows to define a layer to be either 'on' or 'off', and/or 'frozen' or not 'frozen'.
The access control allows to block graphical entities from manipulations by setting a layer to be either 'blocked' or 'not blocked'.
Common style information can be given for 'layer colour', 'curve font', and/or 'curve width'.
*/
class IFC2X2_FINAL_EXPORT IfcPresentationLayerAssignmentWithStyle : public IfcPresentationLayerAssignment
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc2x2_final::IfcPresentationLayerAssignmentWithStyle);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of LayerNumber attribute.
This attribute represents the number assigned to the layer.
\returns
Returns the value of LayerNumber attribute.
*/
int getLayerNumber() const;
/** \details
Sets the value of LayerNumber attribute.
This attribute represents the number assigned to the layer.
\param LayerNumber [in] LayerNumber attribute to set.
*/
void setLayerNumber(int LayerNumber);
/** \details
Returns the value of LayerOn attribute.
This attribute represents the logical setting, where TRUE indicates that the layer is set to 'On',
FALSE that the layer is set to 'Off', UNKNOWN that such information is not available.
\returns
Returns the value of LayerOn attribute.
*/
OdDAI::Logical getLayerOn() const;
/** \details
Sets the value of LayerOn attribute.
This attribute represents the logical setting, where TRUE indicates that the layer is set to 'On',
FALSE that the layer is set to 'Off', UNKNOWN that such information is not available.
\param LayerOn [in] LayerOn attribute to set.
*/
void setLayerOn(OdDAI::Logical LayerOn);
/** \details
Returns the value of LayerOnInAllViews attribute.
This attribute represents the logical setting, where TRUE indicates that the layer is set to 'On' in all views,
FALSE that the layer is set to 'Off' in all views, UNKNOWN that such information is not available.
\returns
Returns the value of LayerOnInAllViews attribute.
*/
OdDAI::Logical getLayerOnInAllViews() const;
/** \details
Sets the value of LayerOnInAllViews attribute.
This attribute represents the logical setting, where TRUE indicates that the layer is set to 'On' in all views,
FALSE that the layer is set to 'Off' in all views, UNKNOWN that such information is not available.
\param LayerOnInAllViews [in] LayerOnInAllViews attribute to set.
*/
void setLayerOnInAllViews(OdDAI::Logical LayerOnInAllViews);
/** \details
Returns the value of LayerFrozen attribute.
This attribute represents the logical setting, where TRUE indicates that the layer is set to 'Frozen',
FALSE that the layer is set to 'Not frozen', UNKNOWN that such information is not available.
\returns
Returns the value of LayerFrozen attribute.
*/
OdDAI::Logical getLayerFrozen() const;
/** \details
Sets the value of LayerFrozen attribute.
This attribute represents the logical setting, where TRUE indicates that the layer is set to 'Frozen',
FALSE that the layer is set to 'Not frozen', UNKNOWN that such information is not available.
\param LayerFrozen [in] LayerFrozen attribute to set.
*/
void setLayerFrozen(OdDAI::Logical LayerFrozen);
/** \details
Returns the value of LayerFrozenInAllViews attribute.
This attribute represents the logical setting, where TRUE indicates that the layer is set to 'Frozen' in all views,
FALSE that the layer is set to 'Not frozen' in all views, UNKNOWN that such information is not available.
\returns
Returns the value of LayerFrozenInAllViews attribute.
*/
OdDAI::Logical getLayerFrozenInAllViews() const;
/** \details
Sets the value of LayerFrozenInAllViews attribute.
This attribute represents the logical setting, where TRUE indicates that the layer is set to 'Frozen' in all views,
FALSE that the layer is set to 'Not frozen' in all views, UNKNOWN that such information is not available.
\param LayerFrozenInAllViews [in] LayerFrozenInAllViews attribute to set.
*/
void setLayerFrozenInAllViews(OdDAI::Logical LayerFrozenInAllViews);
/** \details
Returns the value of LayerBlocked attribute.
This attribute represents the logical setting, where TRUE indicates that the layer is set to 'Blocked',
FALSE that the layer is set to 'Not blocked', UNKNOWN that such information is not available.
\returns
Returns the value of LayerBlocked attribute.
*/
OdDAI::Logical getLayerBlocked() const;
/** \details
Sets the value of LayerBlocked attribute.
This attribute represents the logical setting, where TRUE indicates that the layer is set to 'Blocked',
FALSE that the layer is set to 'Not blocked', UNKNOWN that such information is not available.
\param LayerBlocked [in] LayerBlocked attribute to set.
*/
void setLayerBlocked(OdDAI::Logical LayerBlocked);
/** \details
Returns the value of LayerColour attribute.
This attribute represents the layer color that is applied to all representation items assigned to the layer.
Local settings at the representation item can override the layer color.
\returns
Returns the value of LayerColour attribute.
*/
IfcColour layerColour();
/** \details
Returns the value of LayerCurveWidth attribute.
This attribute represents the layer curve width that is applied to all representation items assigned to the layer.
Local settings at the representation item can override the layer curve width.
\returns
Returns the value of LayerCurveWidth attribute.
*/
IfcSizeSelect layerCurveWidth();
/** \details
Returns the value of LayerCurveFont attribute.
This attribute represents the layer curve font that is applied to all representation items assigned to the layer.
Local settings at the representation item can override the layer curve font.
\returns
Returns the value of LayerCurveFont attribute.
*/
IfcCurveFontOrScaledCurveFontSelect layerCurveFont();
public:
/** \details
Default constructor for the IfcPresentationLayerAssignmentWithStyle class.
*/
IfcPresentationLayerAssignmentWithStyle();
/** \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:
int m_LayerNumber; // INTEGER [optional]
OdDAI::Logical m_LayerOn; // LOGICAL
OdDAI::Logical m_LayerOnInAllViews; // LOGICAL
OdDAI::Logical m_LayerFrozen; // LOGICAL
OdDAI::Logical m_LayerFrozenInAllViews; // LOGICAL
OdDAI::Logical m_LayerBlocked; // LOGICAL
OdDAI::Select m_LayerColour; // IfcColour [optional]
OdDAI::Select m_LayerCurveWidth; // IfcSizeSelect [optional]
OdDAI::Select m_LayerCurveFont; // IfcCurveFontOrScaledCurveFontSelect [optional]
};
/** \details
A data type that represents a smart pointer to a IfcPresentationLayerAssignmentWithStyle object.
*/
typedef OdSmartPtr IfcPresentationLayerAssignmentWithStylePtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC2X2_FINAL_IFCPRESENTATIONLAYERASSIGNMENTWITHSTYLE_AUTO_IMPL_H