CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x3::IfcPreDefinedItem Class Reference

#include <IfcPreDefinedItemAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcPreDefinedItem:
OdIfc2x3::OdIfc2x3Instance OdIfc::OdIfcInstance OdIfc2x3::IfcPreDefinedColour OdIfc2x3::IfcPreDefinedCurveFont OdIfc2x3::IfcPreDefinedSymbol OdIfc2x3::IfcPreDefinedTextFont OdIfc2x3::IfcDraughtingPreDefinedColour OdIfc2x3::IfcDraughtingPreDefinedCurveFont OdIfc2x3::IfcPreDefinedDimensionSymbol OdIfc2x3::IfcPreDefinedPointMarkerSymbol OdIfc2x3::IfcPreDefinedTerminatorSymbol OdIfc2x3::IfcDraughtingPreDefinedTextFont OdIfc2x3::IfcTextStyleFontModel

Public Member Functions

const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
 IfcPreDefinedItem ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) override
 
virtual OdDAI::Entity * getInstanceType () const override
 
virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const override
 
virtual void unsetAttr (const char *explicitAttrName) override
 
virtual bool testAttr (const char *explicitAttrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const override
 
virtual OdIfc::OdIfcEntityType type () const override
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const override
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef) override
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const override
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override
 
- Public Member Functions inherited from OdIfc2x3::OdIfc2x3Instance
void setInverseCounterParts () override
 
- Public Member Functions inherited from OdIfc::OdIfcInstance
 ODRX_DECLARE_MEMBERS (OdIfcInstance)
 
 OdIfcInstance ()
 
 ~OdIfcInstance ()
 
bool isInstanceOf (OdIfcEntityType entityType) const
 
IfcOpResult resolved ()
 
void resolve (IfcOpResult resolved, void *resPtr)
 
void unresolve ()
 
virtual void setGsNode (OdGsCache *pGsNode)
 
virtual OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdAnsiString m_Name
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3dasPoint3d (const OdIfcInstance *inst)
 
static const OdGePoint2dasPoint2d (const OdIfcInstance *inst)
 
static const OdGeVector3dasVector3d (const OdIfcInstance *inst)
 
static const OdGeVector2dasVector2d (const OdIfcInstance *inst)
 
static const OdGeMatrix2dasMatrix2d (const OdIfcInstance *inst)
 
static const OdGeMatrix3dasMatrix3d (const OdIfcInstance *inst)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcInstance > inst)
 
static const OdCmEntityColorasRgbColor (const OdIfcInstance *inst)
 

Detailed Description

A predefined item is a qualified name given to a style or font which is determined within the data exchange specification by convention on using the Name attribute value (in contrary to externally defined items, which are agreed by an external source).

  • Details - The next instance diagram explains the use of IfcStyledItem and IfcPresentationLayerWithStyle to apply presentation styles. EXAMPLE: The assignment of style information by a styled item and a presentation layer with style. Since the presentation styles are different, IfcCurveStyle and IfcSurfaceStyle, both are applied to the geometric representation item.

<IMAGE ifcrepresentationitem_style-1>

The next instance diagram explains the override of IfcPresentationLayerWithStyle by IfcStyledItem to apply presentation styles. EXAMPLE: The assignment of style information by a styled item and a presentation layer with style. Since the presentation styles for curve style are provided by both, the IfcCurveStyle provided by the IfcStyledItem overrides the IfcCurveStyle provided by the IfcPresentationLayerWithStyle.

<IMAGE ifcrepresentationitem_style-2>

Remarks
The convention on using the Name value is defined at the subtypes of IfcPreDefinedItem and is part of the specification.

Definition at line 62 of file Ifc2x3/IfcPreDefinedItemAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcPreDefinedItem()

OdIfc2x3::IfcPreDefinedItem::IfcPreDefinedItem ( )

Default constructor for the IfcPreDefinedItem class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcPreDefinedItem::comparedToEarlyImpl ( const OdDAI::ApplicationInstance * pOther,
OdRx::Ordering & ordering ) const
overridevirtual

Early-bound version of instances comparison.

Parameters
pOther[in] Other application instance.
ordering[out] Receives the ordering (comparison) status.
Returns
true if comparison was performed, false if method has no implementation, so late-bound version could be applied.
Remarks
If the method returns true, the ordering parameter can receive one of the following statuses:
Value Description kLessThan -1 This object < Other Object. kEqual 0 This object = Other Object. kGreaterThan 1 This object > Other Object. kNotOrderable 2 This class is not orderable.

Reimplemented in OdIfc2x3::IfcDraughtingPreDefinedColour, OdIfc2x3::IfcDraughtingPreDefinedCurveFont, OdIfc2x3::IfcDraughtingPreDefinedTextFont, OdIfc2x3::IfcPreDefinedColour, OdIfc2x3::IfcPreDefinedCurveFont, OdIfc2x3::IfcPreDefinedDimensionSymbol, OdIfc2x3::IfcPreDefinedPointMarkerSymbol, OdIfc2x3::IfcPreDefinedSymbol, OdIfc2x3::IfcPreDefinedTerminatorSymbol, OdIfc2x3::IfcPreDefinedTextFont, and OdIfc2x3::IfcTextStyleFontModel.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcPreDefinedItem::getAttr ( const char * attrName) const
overridevirtual

Returns an attribute value for the specified attribute name.

Parameters
attrName[in] Name of an attribute to query.
Returns
OdRxValue object that represents a generic variant type value.

Reimplemented in OdIfc2x3::IfcTextStyleFontModel.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcPreDefinedItem::getAttr ( const OdIfc::OdIfcAttribute attrDef) const
overridevirtual

Returns an attribute value for the specified attribute definition.

Parameters
attrDef[in] Attribute definition to query.
Returns
OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcTextStyleFontModel.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcPreDefinedItem::getInstanceType ( ) const
overridevirtual

Returns a type of a class instance.

Returns
Pointer to the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdDAI__Entity.html>>OdDAI::Entity</exref> type that determines an entity definition within a schema.

Reimplemented in OdIfc2x3::IfcDraughtingPreDefinedColour, OdIfc2x3::IfcDraughtingPreDefinedCurveFont, OdIfc2x3::IfcDraughtingPreDefinedTextFont, OdIfc2x3::IfcPreDefinedColour, OdIfc2x3::IfcPreDefinedCurveFont, OdIfc2x3::IfcPreDefinedDimensionSymbol, OdIfc2x3::IfcPreDefinedPointMarkerSymbol, OdIfc2x3::IfcPreDefinedSymbol, OdIfc2x3::IfcPreDefinedTerminatorSymbol, OdIfc2x3::IfcPreDefinedTextFont, and OdIfc2x3::IfcTextStyleFontModel.

◆ getName()

const OdAnsiString & OdIfc2x3::IfcPreDefinedItem::getName ( ) const

Returns the value of Name attribute. This attribute is the string by which the predefined item is identified. Allowable values for the string are declared at the level of subtypes.

Returns
Returns the value of Name attribute.

◆ inFields()

virtual OdResult OdIfc2x3::IfcPreDefinedItem::inFields ( OdDAI::OdSpfFilerBase * rdFiler)
overridevirtual

Reads object's data from the specified filer.

Parameters
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.

Reimplemented in OdIfc2x3::IfcTextStyleFontModel.

◆ isKindOf()

virtual bool OdIfc2x3::IfcPreDefinedItem::isKindOf ( OdIfc::OdIfcEntityType entityType) const
overridevirtual

Checks whether the specified instance is the object derived from or belongs to this class.

Parameters
entityType[in] Entity to check.
Returns
true if the specified instance is the object derived from or belongs to this class, false otherwise.

Reimplemented from OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcDraughtingPreDefinedColour, OdIfc2x3::IfcDraughtingPreDefinedCurveFont, OdIfc2x3::IfcDraughtingPreDefinedTextFont, OdIfc2x3::IfcPreDefinedColour, OdIfc2x3::IfcPreDefinedCurveFont, OdIfc2x3::IfcPreDefinedDimensionSymbol, OdIfc2x3::IfcPreDefinedPointMarkerSymbol, OdIfc2x3::IfcPreDefinedSymbol, OdIfc2x3::IfcPreDefinedTerminatorSymbol, OdIfc2x3::IfcPreDefinedTextFont, and OdIfc2x3::IfcTextStyleFontModel.

◆ outFields()

virtual OdResult OdIfc2x3::IfcPreDefinedItem::outFields ( OdDAI::OdSpfFilerBase * wrFiler)
overridevirtual

Writes object's data the the specified filer.

Parameters
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.

Reimplemented in OdIfc2x3::IfcTextStyleFontModel.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcPreDefinedItem::putAttr ( const char * explicitAttrName,
const OdRxValue & val )
overridevirtual

Sets the specified attribute with a given value.

Parameters
explicitAttrName[in] Explicit name of the attribute to set.
val[in] Value to set.
Returns
true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcTextStyleFontModel.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcPreDefinedItem::putAttr ( const OdIfc::OdIfcAttribute explicitAttrDef,
const OdRxValue & val )
overridevirtual

Sets the specified attribute with a given value.

Parameters
explicitAttrDef[in] Explicit attribute definition to set.
val[in] Value to set.
Returns
true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcTextStyleFontModel.

◆ setName()

void OdIfc2x3::IfcPreDefinedItem::setName ( const OdAnsiString & Name)

Sets the value of Name attribute. This attribute is the string by which the predefined item is identified. Allowable values for the string are declared at the level of subtypes.

Parameters
Name[in] Name to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcPreDefinedItem::testAttr ( const char * explicitAttrName) const
overridevirtual

Checks whether the specified attribute is set.

Parameters
explicitAttrName[in] Explicit name of the attribute to test.
Returns
true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcTextStyleFontModel.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcPreDefinedItem::testAttr ( const OdIfc::OdIfcAttribute explicitAttrDef) const
overridevirtual

Checks whether the specified attribute is set.

Parameters
explicitAttrDef[in] Attribute definition to test.
Returns
true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcTextStyleFontModel.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcPreDefinedItem::type ( ) const
overridevirtual

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcPreDefinedItem::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

Parameters
explicitAttrName[in] Explicit name of the attribute to reset.

Reimplemented from OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcTextStyleFontModel.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcPreDefinedItem::unsetAttr ( const OdIfc::OdIfcAttribute explicitAttrDef)
overridevirtual

Resets a value for the specified attribute.

Parameters
explicitAttrDef[in] Explicit definition that represents an attribute to reset.

Reimplemented from OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x3::IfcTextStyleFontModel.

Member Data Documentation

◆ m_Name

OdAnsiString OdIfc2x3::IfcPreDefinedItem::m_Name
protected

Definition at line 220 of file Ifc2x3/IfcPreDefinedItemAutoImpl.h.


The documentation for this class was generated from the following file: