#include <IfcPropertyEnumerationAutoImpl.h>

Inheritance diagram for OdIfc4x3_rc1::IfcPropertyEnumeration:

Public Member Functions
const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

void	getEnumerationValues (OdArray< OdDAI::Select > &EnumerationValues) const

void	getEnumerationValuesWrapperArray (OdArray< IfcValue > &EnumerationValues) const

OdDAI::ListOfSelect &	enumerationValues ()

IfcUnit	unit ()

	IfcPropertyEnumeration ()

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 OdIfc4x3_rc1::IfcPropertyAbstraction
void	getInvHasExternalReferences (OdDAIObjectIds &HasExternalReferences) const

Public Member Functions inherited from OdIfc4x3_rc1::OdIfc4x3_RC1Instance
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 OdGsCache *	gsNode () const

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const

virtual OdDbStub *	ownerId () const

Protected Attributes
OdAnsiString	m_Name

OdDAI::ListOfSelect	m_EnumerationValues

OdDAI::Select	m_Unit

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Additional Inherited Members
Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3d *	asPoint3d (const OdIfcInstance *inst)

static const OdGePoint2d *	asPoint2d (const OdIfcInstance *inst)

static const OdGeVector3d *	asVector3d (const OdIfcInstance *inst)

static const OdGeVector2d *	asVector2d (const OdIfcInstance *inst)

static const OdGeMatrix2d *	asMatrix2d (const OdIfcInstance *inst)

static const OdGeMatrix3d *	asMatrix3d (const OdIfcInstance *inst)

static OdIfcCompoundPtr	asCompound (OdSmartPtr< OdIfcInstance > inst)

static const OdCmEntityColor *	asRgbColor (const OdIfcInstance *inst)

Detailed Description

IfcPropertyEnumeration is a collection of simple or measure values that define a prescribed set of alternatives from which 'enumeration values' are selected. This enables inclusion of enumeration values in property sets. IfcPropertyEnumeration provides a name for the enumeration as well as a list of unique (numeric or descriptive) values (that can have a measure type assigned). The entity defines the list of potential enumerators to be exchanged together (or separately) with properties of type IfcPropertyEnumeratedValue that selects their actual property values from this enumeration.

If the Unit attribute is not specified, than the unit is already implied by the type of IfcMeasureValue or IfcDerivedMeasureValue. The associated unit can be found at the IfcUnitAssignment globally defined at the project level (IfcProject.UnitsInContext). If the Unit attribute is specified, the unit assigned by the Unit attribute overrides the globally assigned unit.

\changes

IFC2X_FINAL changes: Entity has been renamed from IfcEnumeration.

Definition at line 53 of file Ifc4x3_RC1/IfcPropertyEnumerationAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcPropertyEnumeration()

OdIfc4x3_rc1::IfcPropertyEnumeration::IfcPropertyEnumeration ( )

Default constructor for the IfcPropertyEnumeration class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x3_rc1::IfcPropertyEnumeration::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 from OdIfc4x3_rc1::IfcPropertyAbstraction.

◆ enumerationValues()

OdDAI::ListOfSelect & OdIfc4x3_rc1::IfcPropertyEnumeration::enumerationValues ( )

Returns the value of EnumerationValues attribute. EnumerationValues is list of values that form the enumeration.

Parameters

EnumerationValues [out] Receives a list of OdDAI::Select values representing the EnumerationValues attribute.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x3_rc1::IfcPropertyEnumeration::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.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x3_rc1::IfcPropertyEnumeration::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 OdIfc4x3_rc1::IfcPropertyAbstraction.

◆ getEnumerationValues()

void OdIfc4x3_rc1::IfcPropertyEnumeration::getEnumerationValues ( OdArray< OdDAI::Select > & EnumerationValues ) const

Returns the value of EnumerationValues attribute. EnumerationValues is list of values that form the enumeration.

Returns: Returns a list of OdDAI::Select values representing the EnumerationValues attribute.

◆ getEnumerationValuesWrapperArray()

void OdIfc4x3_rc1::IfcPropertyEnumeration::getEnumerationValuesWrapperArray ( OdArray< IfcValue > & EnumerationValues ) const

Returns the value of EnumerationValues attribute. EnumerationValues is list of values that form the enumeration.

Returns: Returns a list of OdDAI::Select values representing the EnumerationValues attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x3_rc1::IfcPropertyEnumeration::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 from OdIfc4x3_rc1::IfcPropertyAbstraction.

◆ getName()

const OdAnsiString & OdIfc4x3_rc1::IfcPropertyEnumeration::getName ( ) const

Returns the value of Name attribute that represents the name of this enumeration.

Returns: Returns the value of Name attribute.

◆ inFields()

virtual OdResult OdIfc4x3_rc1::IfcPropertyEnumeration::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 from OdIfc4x3_rc1::IfcPropertyAbstraction.

◆ isKindOf()

virtual bool OdIfc4x3_rc1::IfcPropertyEnumeration::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 OdIfc4x3_rc1::IfcPropertyAbstraction.

◆ outFields()

virtual OdResult OdIfc4x3_rc1::IfcPropertyEnumeration::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 from OdIfc4x3_rc1::IfcPropertyAbstraction.

◆ putAttr() [1/2]

virtual bool OdIfc4x3_rc1::IfcPropertyEnumeration::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.

◆ putAttr() [2/2]

virtual bool OdIfc4x3_rc1::IfcPropertyEnumeration::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 OdIfc4x3_rc1::IfcPropertyAbstraction.

◆ setName()

void OdIfc4x3_rc1::IfcPropertyEnumeration::setName ( const OdAnsiString & Name )

Sets the value of Name attribute that represents the name of this enumeration.

Parameters

Name	[in] Name to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x3_rc1::IfcPropertyEnumeration::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 OdIfc4x3_rc1::IfcPropertyAbstraction.

◆ testAttr() [2/2]

virtual bool OdIfc4x3_rc1::IfcPropertyEnumeration::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 OdIfc4x3_rc1::IfcPropertyAbstraction.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x3_rc1::IfcPropertyEnumeration::type ( ) const

overridevirtual

Returns the type of this entity.

Returns: A value of the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdIfc__OdIfcEntityType.html>>OdIfc::OdIfcEntityType</exref> type that represents type of this entity.

Reimplemented from OdIfc4x3_rc1::IfcPropertyAbstraction.

◆ unit()

IfcUnit OdIfc4x3_rc1::IfcPropertyEnumeration::unit ( )

Returns the value of Unit attribute that represents unit for the enumerator values. If not specified, the default value for the measure type is used as defined by the global unit assignment at IfcProject.

Returns: Returns the value of Unit attribute.

◆ unsetAttr() [1/2]

virtual void OdIfc4x3_rc1::IfcPropertyEnumeration::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc4x3_rc1::IfcPropertyAbstraction.

◆ unsetAttr() [2/2]

virtual void OdIfc4x3_rc1::IfcPropertyEnumeration::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 OdIfc4x3_rc1::IfcPropertyAbstraction.

Member Data Documentation

◆ m_EnumerationValues

OdDAI::ListOfSelect OdIfc4x3_rc1::IfcPropertyEnumeration::m_EnumerationValues

protected

Definition at line 238 of file Ifc4x3_RC1/IfcPropertyEnumerationAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc4x3_rc1::IfcPropertyEnumeration::m_Name

protected

Definition at line 237 of file Ifc4x3_RC1/IfcPropertyEnumerationAutoImpl.h.

◆ m_Unit

OdDAI::Select OdIfc4x3_rc1::IfcPropertyEnumeration::m_Unit

protected

Definition at line 239 of file Ifc4x3_RC1/IfcPropertyEnumerationAutoImpl.h.

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

Ifc4x3_RC1/IfcPropertyEnumerationAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcPropertyEnumeration()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ enumerationValues()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getEnumerationValues()

◆ getEnumerationValuesWrapperArray()

◆ getInstanceType()

◆ getName()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setName()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unit()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_EnumerationValues

◆ m_Name

◆ m_Unit