#include <IfcActorRoleAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcActorRole:

Public Member Functions
IfcRoleEnum	getRole () const

void	setRole (IfcRoleEnum Role)

const OdAnsiString &	getUserDefinedRole () const

void	setUserDefinedRole (const OdAnsiString &UserDefinedRole)

const OdAnsiString &	getDescription () const

void	setDescription (const OdAnsiString &Description)

	IfcActorRole ()

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 OdGsCache *	gsNode () const

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const

virtual OdDbStub *	ownerId () const

Protected Attributes
OdDAI::Enum	m_Role

OdAnsiString	m_UserDefinedRole

OdAnsiString	m_Description

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

This entity indicates a role which is performed by an actor, either a person, an organization or a person related to an organization.

Remarks: The list of roles of the enumeration values of the Role attribute can never be complete. Therefore using enumeration value USERDEFINED, the user can provide any role as a value of the attribute UserDefinedRole.

Definition at line 48 of file Ifc2x3/IfcActorRoleAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcActorRole()

OdIfc2x3::IfcActorRole::IfcActorRole ( )

Default constructor for the IfcActorRole class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcActorRole::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.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcActorRole::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 OdIfc2x3::IfcActorRole::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.

◆ getDescription()

const OdAnsiString & OdIfc2x3::IfcActorRole::getDescription ( ) const

Returns the value of Description attribute. This attribute represents a textual description relating the nature of the role played by an actor.

Returns: Returns the value of Description attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcActorRole::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.

◆ getRole()

IfcRoleEnum OdIfc2x3::IfcActorRole::getRole ( ) const

Returns the value of Role attribute. This attribute represents the name of the role played by an actor. If the Role has value USERDEFINED, then the user defined role is provided as a value of the attribute UserDefinedRole.

Returns: Returns the value of Role attribute.

◆ getUserDefinedRole()

const OdAnsiString & OdIfc2x3::IfcActorRole::getUserDefinedRole ( ) const

Returns the value of UserDefinedRole attribute. This attribute allows specification of user-defined roles beyond the enumeration values provided by Role attribute of type IfcRoleEnum. When a value is provided for this attribute, in parallel the attribute Role will have enumeration value USERDEFINED.

Returns: Returns the value of UserDefinedRole attribute.

◆ inFields()

virtual OdResult OdIfc2x3::IfcActorRole::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.

◆ isKindOf()

virtual bool OdIfc2x3::IfcActorRole::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.

◆ outFields()

virtual OdResult OdIfc2x3::IfcActorRole::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.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcActorRole::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 OdIfc2x3::IfcActorRole::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.

◆ setDescription()

void OdIfc2x3::IfcActorRole::setDescription ( const OdAnsiString & Description )

Sets the value of Description attribute. This attribute represents a textual description relating the nature of the role played by an actor.

Parameters

Description [in] Description to set.

◆ setRole()

void OdIfc2x3::IfcActorRole::setRole ( IfcRoleEnum Role )

Sets the value of Role attribute. This attribute represents the name of the role played by an actor. If the Role has value USERDEFINED, then the user defined role is provided as a value of the attribute UserDefinedRole.

Parameters

Role	[in] Role to set.

◆ setUserDefinedRole()

void OdIfc2x3::IfcActorRole::setUserDefinedRole ( const OdAnsiString & UserDefinedRole )

Sets the value of UserDefinedRole attribute. This attribute allows specification of user-defined roles beyond the enumeration values provided by Role attribute of type IfcRoleEnum. When a value is provided for this attribute, in parallel the attribute Role will have enumeration value USERDEFINED.

Parameters

UserDefinedRole [in] User-defined role to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcActorRole::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.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcActorRole::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.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcActorRole::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 OdIfc::OdIfcInstance.

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcActorRole::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.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcActorRole::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.

Member Data Documentation

◆ m_Description

OdAnsiString OdIfc2x3::IfcActorRole::m_Description

protected

Definition at line 242 of file Ifc2x3/IfcActorRoleAutoImpl.h.

◆ m_Role

OdDAI::Enum OdIfc2x3::IfcActorRole::m_Role

protected

Definition at line 240 of file Ifc2x3/IfcActorRoleAutoImpl.h.

◆ m_UserDefinedRole

OdAnsiString OdIfc2x3::IfcActorRole::m_UserDefinedRole

protected

Definition at line 241 of file Ifc2x3/IfcActorRoleAutoImpl.h.

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

Ifc2x3/IfcActorRoleAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcActorRole()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getDescription()

◆ getInstanceType()

◆ getRole()

◆ getUserDefinedRole()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setDescription()

◆ setRole()

◆ setUserDefinedRole()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_Description

◆ m_Role

◆ m_UserDefinedRole