#include <IfcOccupantAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcOccupant:

Public Member Functions
const OdDAIObjectId &	getLeeseOrRentalDate () const

void	setLeeseOrRentalDate (const OdDAIObjectId &LeeseOrRentalDate)

double	getLeeseOrRentalPeriod () const

void	setLeeseOrRentalPeriod (double LeeseOrRentalPeriod)

IfcOccupantTypeEnum	getOccupationType () const

void	setOccupationType (IfcOccupantTypeEnum OccupationType)

OdDAI::Logical	getUnlimitedPeriod () const

void	setUnlimitedPeriod (OdDAI::Logical UnlimitedPeriod)

	IfcOccupant ()

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 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 OdIfc2x_final::IfcActor
IfcActorSelect	theActor ()

void	getInvIsActingUpon (OdDAIObjectIds &IsActingUpon) const

	IfcActor ()

Public Member Functions inherited from OdIfc2x_final::IfcObject
const OdAnsiString &	getObjectType () const

void	setObjectType (const OdAnsiString &ObjectType)

void	getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const

void	getInvHasAssociations (OdDAIObjectIds &HasAssociations) const

void	getInvHasAssignments (OdDAIObjectIds &HasAssignments) const

void	getInvDecomposes (OdDAIObjectIds &Decomposes) const

void	getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const

	IfcObject ()

Public Member Functions inherited from OdIfc2x_final::IfcRoot
OdDAI::CompressedGUID	getGlobalId () const

void	setGlobalId (OdDAI::CompressedGUID GlobalId)

const OdDAIObjectId &	getOwnerHistory () const

void	setOwnerHistory (const OdDAIObjectId &OwnerHistory)

const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

const OdAnsiString &	getDescription () const

void	setDescription (const OdAnsiString &Description)

	IfcRoot ()

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
OdDAIObjectId	m_LeeseOrRentalDate

double	m_LeeseOrRentalPeriod

OdDAI::Enum	m_OccupationType

OdDAI::Logical	m_UnlimitedPeriod

Protected Attributes inherited from OdIfc2x_final::IfcActor
OdDAI::Select	m_TheActor

Protected Attributes inherited from OdIfc2x_final::IfcObject
OdAnsiString	m_ObjectType

Protected Attributes inherited from OdIfc2x_final::IfcRoot
OdDAI::CompressedGUID	m_GlobalId

OdDAIObjectId	m_OwnerHistory

OdAnsiString	m_Name

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

An occupant is a type of actor that defines the form of occupancy of a property. The principal purpose of IfcOccupant is to determine the nature of occupancy of a property for a particular actor. All characteristics relating to the actor (name and organization details) are inherited from the IfcActor entity.

Definition at line 43 of file Ifc2x_Final/IfcOccupantAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcOccupant()

OdIfc2x_final::IfcOccupant::IfcOccupant ( )

Default constructor for the IfcOccupant class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x_final::IfcOccupant::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 from OdIfc2x_final::IfcActor.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x_final::IfcOccupant::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 OdIfc2x_final::IfcActor.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x_final::IfcOccupant::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 OdIfc2x_final::IfcActor.

◆ getLeeseOrRentalDate()

const OdDAIObjectId & OdIfc2x_final::IfcOccupant::getLeeseOrRentalDate ( ) const

Returns the value of LeeseOrRentalDate attribute. This attribute represents the date when of the leasing or rental contract starts.

Returns: Returns the value of LeeseOrRentalDate attribute.

◆ getLeeseOrRentalPeriod()

double OdIfc2x_final::IfcOccupant::getLeeseOrRentalPeriod ( ) const

Returns the value of LeeseOrRentalPeriod attribute. This attribute represents the period given in the lease or rental agreement for leasing or renting the property.

Returns: Returns the value of LeeseOrRentalPeriod attribute.

◆ getOccupationType()

IfcOccupantTypeEnum OdIfc2x_final::IfcOccupant::getOccupationType ( ) const

Returns the value of OccupationType attribute. This attribute represents the principal occupation types specified in an enumeration.

Returns: Returns the value of OccupationType attribute.

◆ getUnlimitedPeriod()

OdDAI::Logical OdIfc2x_final::IfcOccupant::getUnlimitedPeriod ( ) const

Returns the value of UnlimitedPeriod attribute. This attribute indicates whether the lease or rental contract is unlimited (TRUE) or time limited (FALSE). In the case of FALSE, the LeaseOrRentalPeriod attribute specifies the duration of the contract.

Returns: Returns the value of UnlimitedPeriod attribute.

◆ inFields()

virtual OdResult OdIfc2x_final::IfcOccupant::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 OdIfc2x_final::IfcActor.

◆ isKindOf()

virtual bool OdIfc2x_final::IfcOccupant::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 OdIfc2x_final::IfcActor.

◆ outFields()

virtual OdResult OdIfc2x_final::IfcOccupant::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 OdIfc2x_final::IfcActor.

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::IfcOccupant::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 OdIfc2x_final::IfcActor.

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcOccupant::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 OdIfc2x_final::IfcActor.

◆ setLeeseOrRentalDate()

void OdIfc2x_final::IfcOccupant::setLeeseOrRentalDate ( const OdDAIObjectId & LeeseOrRentalDate )

Sets the value of LeeseOrRentalDate attribute. This attribute represents the date when of the leasing or rental contract starts.

Parameters

LeeseOrRentalDate [in] LeeseOrRentalDate attribute to set.

◆ setLeeseOrRentalPeriod()

void OdIfc2x_final::IfcOccupant::setLeeseOrRentalPeriod ( double LeeseOrRentalPeriod )

Sets the value of LeeseOrRentalPeriod attribute. This attribute represents the period given in the lease or rental agreement for leasing or renting the property.

Parameters

LeeseOrRentalPeriod [in] LeeseOrRentalPeriod attribute to set.

◆ setOccupationType()

void OdIfc2x_final::IfcOccupant::setOccupationType ( IfcOccupantTypeEnum OccupationType )

Sets the value of OccupationType attribute. This attribute represents the principal occupation types specified in an enumeration.

Parameters

OccupationType [in] Occupation type to set.

◆ setUnlimitedPeriod()

void OdIfc2x_final::IfcOccupant::setUnlimitedPeriod ( OdDAI::Logical UnlimitedPeriod )

Sets the value of UnlimitedPeriod attribute. This attribute indicates whether the lease or rental contract is unlimited (TRUE) or time limited (FALSE). In the case of FALSE, the LeaseOrRentalPeriod attribute specifies the duration of the contract.

Parameters

UnlimitedPeriod [in] Occupation type to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcOccupant::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 OdIfc2x_final::IfcActor.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcOccupant::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 OdIfc2x_final::IfcActor.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcOccupant::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 OdIfc2x_final::IfcActor.

◆ unsetAttr() [1/2]

virtual void OdIfc2x_final::IfcOccupant::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc2x_final::IfcActor.

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcOccupant::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 OdIfc2x_final::IfcActor.

Member Data Documentation

◆ m_LeeseOrRentalDate

OdDAIObjectId OdIfc2x_final::IfcOccupant::m_LeeseOrRentalDate

protected

Definition at line 229 of file Ifc2x_Final/IfcOccupantAutoImpl.h.

◆ m_LeeseOrRentalPeriod

double OdIfc2x_final::IfcOccupant::m_LeeseOrRentalPeriod

protected

Definition at line 230 of file Ifc2x_Final/IfcOccupantAutoImpl.h.

◆ m_OccupationType

OdDAI::Enum OdIfc2x_final::IfcOccupant::m_OccupationType

protected

Definition at line 231 of file Ifc2x_Final/IfcOccupantAutoImpl.h.

◆ m_UnlimitedPeriod

OdDAI::Logical OdIfc2x_final::IfcOccupant::m_UnlimitedPeriod

protected

Definition at line 232 of file Ifc2x_Final/IfcOccupantAutoImpl.h.

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

Ifc2x_Final/IfcOccupantAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcOccupant()

Member Function Documentation

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getLeeseOrRentalDate()

◆ getLeeseOrRentalPeriod()

◆ getOccupationType()

◆ getUnlimitedPeriod()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setLeeseOrRentalDate()

◆ setLeeseOrRentalPeriod()

◆ setOccupationType()

◆ setUnlimitedPeriod()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_LeeseOrRentalDate

◆ m_LeeseOrRentalPeriod

◆ m_OccupationType

◆ m_UnlimitedPeriod