#include <IfcEntity.h>

Inheritance diagram for OdIfc::OdIfcEntity:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdIfcEntity)

	OdIfcEntity ()

	~OdIfcEntity ()

virtual bool	isKindOf (OdIfcEntityType entityType) const

bool	isInstanceOf (OdIfcEntityType entityType) const

virtual OdIfcEntityType	type () const

virtual OdRxValue	getAttr (const OdIfcAttribute attrDef) const

virtual bool	testAttr (const char *explicitAttrName) const

virtual bool	testAttr (const OdIfcAttribute explicitAttrDef) const

virtual void	unsetAttr (const char *explicitAttrName)

virtual void	unsetAttr (const OdIfcAttribute explicitAttrDef)

virtual bool	putAttr (const char *explicitAttrName, const OdRxValue &val)

virtual bool	putAttr (const OdIfcAttribute explicitAttrDef, const OdRxValue &val)

IfcOpResult	resolved ()

void	resolve (IfcOpResult resolved, void *resPtr)

void	unresolve ()

virtual void	setGsNode (OdGsCache *pGsNode)

virtual OdGsCache *	gsNode () const

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const

Static Public Member Functions
static const OdGePoint3d *	asPoint3d (const OdIfcEntity *pEnt)

static const OdGePoint2d *	asPoint2d (const OdIfcEntity *pEnt)

static const OdGeVector3d *	asVector3d (const OdIfcEntity *pEnt)

static const OdGeVector2d *	asVector2d (const OdIfcEntity *pEnt)

static const OdGeMatrix2d *	asMatrix2d (const OdIfcEntity *pEnt)

static const OdGeMatrix3d *	asMatrix3d (const OdIfcEntity *pEnt)

static OdIfcCompoundPtr	asCompound (OdSmartPtr< OdIfcEntity > pEnt)

static const OdCmEntityColor *	asRgbColor (const OdIfcEntity *pEnt)

Protected Attributes
void *	m_resPtr

IfcOpResult	m_resolved

Friends
class	OdIfcCompound

Detailed Description

A class that represents an entity instance of an IFC file and provides IFC-specific functionality.

Definition at line 86 of file IfcEntity.h.

Constructor & Destructor Documentation

◆ OdIfcEntity()

OdIfc::OdIfcEntity::OdIfcEntity ( )

Creates a new entity object with default parameters.

◆ ~OdIfcEntity()

OdIfc::OdIfcEntity::~OdIfcEntity ( )

Destroys the entity object.

Remarks: All attached compound objects are deleted as well.

Member Function Documentation

◆ asCompound()

static OdIfcCompoundPtr OdIfc::OdIfcEntity::asCompound ( OdSmartPtr< OdIfcEntity > pEnt )

static

Returns the result of the entity resolution represented as a compound object.

Parameters

pEnt	[in] A smart pointer to an entity to get the compound object from.

Returns: A smart pointer to a <link OdIfc::OdIfcCompound, compound> object.

Remarks: The method returns a valid smart pointer to the <link OdIfc::OdIfcCompound, compound> object if the resolution result is equal to <link OdIfc::IfcOpResult::kResCompound, kResCompound>; otherwise, the method returns a NULL pointer.

◆ asMatrix2d()

static const OdGeMatrix2d * OdIfc::OdIfcEntity::asMatrix2d ( const OdIfcEntity * pEnt )

inlinestatic

Returns the result of the entity resolution represented as a two-dimensional matrix.

Parameters

pEnt	[in] A smart pointer to an entity to be resolved.

Returns: A raw pointer to an instance of the <exref target="https://docs.opendesign.com/tkernel/OdGeMatrix2d.html">OdGeMatrix2d</exref> class.

Remarks: The method returns a valid raw pointer to the <exref target="https://docs.opendesign.com/tkernel/OdGeMatrix2d.html">OdMatrix2d</exref> object if the resolution result is equal to <link OdIfc::IfcOpResult::kResMatrix2d, kResMatrix2d>; otherwise, the method returns a NULL pointer.

Definition at line 285 of file IfcEntity.h.

◆ asMatrix3d()

static const OdGeMatrix3d * OdIfc::OdIfcEntity::asMatrix3d ( const OdIfcEntity * pEnt )

inlinestatic

Returns the result of the entity resolution represented as a three-dimensional vector.

Parameters

pEnt	[in] A smart pointer to an entity to be resolved.

Returns: A raw pointer to an instance of the <exref target="https://docs.opendesign.com/tkernel/OdGeMatrix3d.html">OdGeMatrix3d</exref> class.

Remarks: The method returns a valid raw pointer to the <exref target="https://docs.opendesign.com/tkernel/OdGeMatrix3d.html">OdMatrix3d</exref> object if the resolution result is equal to <link OdIfc::IfcOpResult::kResMatrix3d, kResMatrix3d>; otherwise, the method returns a NULL pointer.

Definition at line 300 of file IfcEntity.h.

◆ asPoint2d()

static const OdGePoint2d * OdIfc::OdIfcEntity::asPoint2d ( const OdIfcEntity * pEnt )

inlinestatic

Returns the result of the entity resolution represented as a two-dimensional point.

Parameters

pEnt	[in] A smart pointer to an entity to be resolved.

Returns: A raw pointer to an instance of the <exref target="https://docs.opendesign.com/tkernel/OdGePoint2d.html">OdGePoint2d</exref> class.

Remarks: The method returns a valid raw pointer to the <exref target="https://docs.opendesign.com/tkernel/OdGePoint2d.html">OdGePoint2d</exref> object if the resolution result is equal to <link OdIfc::IfcOpResult::kResPoint3d, kResPoint3d> or <link OdIfc::IfcOpResult::kResPoint2d, kResPoint2d>; otherwise, the method returns a NULL pointer.

Definition at line 238 of file IfcEntity.h.

◆ asPoint3d()

static const OdGePoint3d * OdIfc::OdIfcEntity::asPoint3d ( const OdIfcEntity * pEnt )

inlinestatic

Returns the result of the entity resolution represented as a three-dimensional point.

Parameters

pEnt	[in] A smart pointer to an entity to be resolved.

Returns: A raw pointer to an instance of the <exref target="https://docs.opendesign.com/tkernel/OdGePoint3d.html">OdGePoint3d</exref> class.

Remarks: The method returns a valid raw pointer to the <exref target="https://docs.opendesign.com/tkernel/OdGePoint3d.html">OdGePoint3d</exref> object if the resolution result is equal to the <link OdIfc::IfcOpResult::kResPoint3d, kResPoint3d> or the <link OdIfc::IfcOpResult::kResPoint2d, kResPoint2d>; otherwise, the method returns a NULL pointer.

Definition at line 222 of file IfcEntity.h.

◆ asRgbColor()

static const OdCmEntityColor * OdIfc::OdIfcEntity::asRgbColor ( const OdIfcEntity * pEnt )

inlinestatic

Returns the result of the entity resolution represented as an <exref target="https://docs.opendesign.com/tkernel/OdCmEntityColor.html">RGB color</exref> object.

Parameters

pEnt	[in] A smart pointer to an entity to be resolved.

Returns: A raw pointer to an <exref target="https://docs.opendesign.com/tkernel/OdCmEntityColor.html">RGB color</exref> object.

Remarks: The method returns a valid raw pointer to the <exref target="https://docs.opendesign.com/tkernel/OdCmEntityColor.html">RGB color</exref> object if the resolution result is equal to <link OdIfc::IfcOpResult::kRgbColor, kRgbColor>; otherwise, the method returns a NULL pointer.

Definition at line 325 of file IfcEntity.h.

◆ asVector2d()

static const OdGeVector2d * OdIfc::OdIfcEntity::asVector2d ( const OdIfcEntity * pEnt )

inlinestatic

Returns the result of the entity resolution represented as a two-dimensional vector.

Parameters

pEnt	[in] A smart pointer to an entity to be resolved.

Returns: A raw pointer to an instance of the <exref target="https://docs.opendesign.com/tkernel/OdGeVector2d.html">OdGeVector2d</exref> class.

Remarks: The method returns a valid raw pointer to the <exref target="https://docs.opendesign.com/tkernel/OdGeVector2d.html">OdVector2d</exref> object if the resolution result is equal to <link OdIfc::IfcOpResult::kResVector3d, kResVector3d> or <link OdIfc::IfcOpResult::kResVector2d, kResVector2d>; otherwise, the method returns a NULL pointer.

Definition at line 270 of file IfcEntity.h.

◆ asVector3d()

static const OdGeVector3d * OdIfc::OdIfcEntity::asVector3d ( const OdIfcEntity * pEnt )

inlinestatic

Returns the result of the entity resolution represented as a three-dimensional vector.

Parameters

pEnt	[in] A smart pointer to an entity to be resolved.

Returns: A raw pointer to an instance of the <exref target="https://docs.opendesign.com/tkernel/OdGeVector3d.html">OdGeVector3d</exref> class.

Remarks: The method returns a valid raw pointer to the <exref target="https://docs.opendesign.com/tkernel/OdGeVector3d.html">OdVector3d</exref> object if the resolution result is equal to <link OdIfc::IfcOpResult::kResVector3d, kResVector3d> or <link OdIfc::IfcOpResult::kResVector2d, kResVector2d>; otherwise, the method returns a NULL pointer.

Definition at line 254 of file IfcEntity.h.

◆ getAttr()

virtual OdRxValue OdIfc::OdIfcEntity::getAttr ( const OdIfcAttribute attrDef ) const

virtual

Retrieves the current value of an attribute specified by its definition.

Parameters

attrDef [in] A value of the <link OdIfc::OdIfcAttribute, OdIfcAttribute> enumeration that represents the attribute definition.

Returns: The current value of the attribute.

Remarks: The method provides late binding access to the attribute value by its name. Attributes of select and aggregate data types are also supported.

◆ gsNode()

virtual OdGsCache * OdIfc::OdIfcEntity::gsNode ( ) const

virtual

Retrieves the current Gs node object of the entity.

Returns: A raw pointer to the <exref target="https://docs.opendesign.com/tv/OdGsCache.html">OdGsCache</exref> object associated with the entity.

◆ isInstanceOf()

bool OdIfc::OdIfcEntity::isInstanceOf ( OdIfcEntityType entityType ) const

Retrieves whether the entity is an instance of a specified type.

Parameters

entityType [in] An instance of the <link OdIfc::OdIfcEntityType, OdIfcEntityType> enumeration that represents the entity type.

Returns: true if the entity is an instance of the specified type; otherwise, the method returns false.

◆ isKindOf()

virtual bool OdIfc::OdIfcEntity::isKindOf ( OdIfcEntityType entityType ) const

virtual

Retrieves whether the entity belongs to a specified entity type.

Parameters

entityType [in] An entity type.

Returns: true if the entity belongs to the specified type; otherwise, the method returns false.

◆ ODRX_DECLARE_MEMBERS()

OdIfc::OdIfcEntity::ODRX_DECLARE_MEMBERS ( OdIfcEntity )

◆ putAttr() [1/2]

virtual bool OdIfc::OdIfcEntity::putAttr	(	const char *	explicitAttrName,
		const OdRxValue &	val
	)

virtual

Sets a new value of an attribute that is specified by its name.

Parameters

explicitAttrName	[in] An ANSI string that contains the attribute name.
val	[in] A new attribute value to be set.

Returns: true if the attribute value was successfully set; otherwise, the method returns false.

◆ putAttr() [2/2]

virtual bool OdIfc::OdIfcEntity::putAttr	(	const OdIfcAttribute	explicitAttrDef,
		const OdRxValue &	val
	)

virtual

Sets a new value of a specified attribute.

Parameters

explicitAttrDef	[in] An <link OdIfc::OdIfcAttribute, OdIfcAttribute> enumeration that represents the attribute definition.
val	[in] A new attribute value to be set.

Returns: true if the attribute value was successfully set; otherwise, the method returns false.

◆ resolve()

void OdIfc::OdIfcEntity::resolve	(	IfcOpResult	resolved,
		void *	resPtr
	)

inline

Resolves the entity and returns the result of the entity composition to a calling subroutine.

Parameters

resolved	[in] A resolution operation result.
resPtr	[out] A raw pointer that references the entity composition result value.

Definition at line 199 of file IfcEntity.h.

◆ resolved()

IfcOpResult OdIfc::OdIfcEntity::resolved ( )

inline

Retrieves whether the entity is resolved into a compound object, into a Ge compound object, or is unresolved/visited.

Returns: A value of the <link OdIfc::IfcOpResult, IfcOpResult> enumeration that contains the result of the entity resolution.

Definition at line 192 of file IfcEntity.h.

◆ setGsNode()

virtual void OdIfc::OdIfcEntity::setGsNode ( OdGsCache * pGsNode )

virtual

Sets a new Gs node cache for the entity.

Parameters

pGsNode [in] A raw pointer to an <exref target="https://docs.opendesign.com/tv/OdGsCache.html">OdGsCache</exref> object.

◆ subSetAttributes()

virtual OdUInt32 OdIfc::OdIfcEntity::subSetAttributes ( OdGiDrawableTraits * traits ) const

virtual

Sets the values of the entity's sub-entity traits.

Parameters

traits [out] A raw pointer to the traits to be filled and returned to a calling subroutine.

Returns: The result of setting the values.

◆ subWorldDraw()

virtual bool OdIfc::OdIfcEntity::subWorldDraw ( OdGiWorldDraw * wd ) const

virtual

Draws a graphical entity representation that is independent of any viewport context.

Parameters

wd	[in] A raw pointer to the object that encapsulates parameters of viewport-independent vectorization.

Returns: true if the drawing was successful; otherwise, the method returns false.

◆ testAttr() [1/2]

virtual bool OdIfc::OdIfcEntity::testAttr ( const char * explicitAttrName ) const

virtual

Retrieves whether the attribute value is set or is unset.

Parameters

explicitAttrName [in] An ANSI string that contains the attribute name.

Returns: true if the attribute has a value; otherwise, the method returns false (the attribute value is not set).

◆ testAttr() [2/2]

virtual bool OdIfc::OdIfcEntity::testAttr ( const OdIfcAttribute explicitAttrDef ) const

virtual

Retrieves whether the attribute value is set or is unset.

Parameters

explicitAttrDef [in] An <link OdIfc::OdIfcAttribute, OdIfcAttribute> enumeration that represents the attribute definition.

Returns: true if the attribute has a value; otherwise, the method returns false (the attribute value is not set).

◆ type()

virtual OdIfcEntityType OdIfc::OdIfcEntity::type ( ) const

virtual

Retrieves the current type of the entity.

Returns: A value of the <link OdIfc::OdIfcEntityType, OdIfcEntityType> enumeration that represents the current entity's type.

◆ unresolve()

void OdIfc::OdIfcEntity::unresolve ( )

Unresolves the entity.

◆ unsetAttr() [1/2]

virtual void OdIfc::OdIfcEntity::unsetAttr ( const char * explicitAttrName )

virtual

Clears the attribute value.

Parameters

explicitAttrName [in] An ANSI string that contains the attribute name.

◆ unsetAttr() [2/2]

virtual void OdIfc::OdIfcEntity::unsetAttr ( const OdIfcAttribute explicitAttrDef )

virtual

Clears the attribute value.

Parameters

explicitAttrDef [in] An <link OdIfc::OdIfcAttribute, OdIfcAttribute> enumeration that represents the attribute definition.

Friends And Related Function Documentation

◆ OdIfcCompound

friend class OdIfcCompound

friend

Definition at line 370 of file IfcEntity.h.

Member Data Documentation

◆ m_resolved

IfcOpResult OdIfc::OdIfcEntity::m_resolved

protected

Definition at line 364 of file IfcEntity.h.

◆ m_resPtr

void* OdIfc::OdIfcEntity::m_resPtr

protected

Definition at line 363 of file IfcEntity.h.

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

IfcEntity.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ OdIfcEntity()

◆ ~OdIfcEntity()

Member Function Documentation

◆ asCompound()

◆ asMatrix2d()

◆ asMatrix3d()

◆ asPoint2d()

◆ asPoint3d()

◆ asRgbColor()

◆ asVector2d()

◆ asVector3d()

◆ getAttr()

◆ gsNode()

◆ isInstanceOf()

◆ isKindOf()

◆ ODRX_DECLARE_MEMBERS()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ resolve()

◆ resolved()

◆ setGsNode()

◆ subSetAttributes()

◆ subWorldDraw()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unresolve()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Friends And Related Function Documentation

◆ OdIfcCompound

Member Data Documentation

◆ m_resolved

◆ m_resPtr