CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x3_rc1::IfcInventory Class Reference

#include <IfcInventoryAutoImpl.h>

Inheritance diagram for OdIfc4x3_rc1::IfcInventory:
OdIfc4x3_rc1::IfcGroup OdIfc4x3_rc1::IfcObject OdIfc4x3_rc1::IfcObjectDefinition OdIfc4x3_rc1::IfcRoot OdIfc4x3_rc1::OdIfc4x3_RC1Instance OdIfc::OdIfcInstance

Public Member Functions

IfcInventoryTypeEnum getPredefinedType () const
 
void setPredefinedType (IfcInventoryTypeEnum PredefinedType)
 
IfcActorSelect jurisdiction ()
 
void getResponsiblePersons (OdDAIObjectIds &ResponsiblePersons) const
 
OdDAI::SetOfOdDAIObjectId & responsiblePersons ()
 
const OdAnsiString & getLastUpdateDate () const
 
void setLastUpdateDate (const OdAnsiString &LastUpdateDate)
 
const OdDAIObjectId & getCurrentValue () const
 
void setCurrentValue (const OdDAIObjectId &CurrentValue)
 
const OdDAIObjectId & getOriginalValue () const
 
void setOriginalValue (const OdDAIObjectId &OriginalValue)
 
 IfcInventory ()
 
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::IfcGroup
void getInvIsGroupedBy (OdDAIObjectIds &IsGroupedBy) const
 
- Public Member Functions inherited from OdIfc4x3_rc1::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDeclaredBy (OdDAIObjectIds &IsDeclaredBy) const
 
void getInvDeclares (OdDAIObjectIds &Declares) const
 
void getInvIsTypedBy (OdDAIObjectIds &IsTypedBy) const
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
 IfcObject ()
 
- Public Member Functions inherited from OdIfc4x3_rc1::IfcObjectDefinition
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvNests (OdDAIObjectIds &Nests) const
 
void getInvIsNestedBy (OdDAIObjectIds &IsNestedBy) const
 
void getInvHasContext (OdDAIObjectIds &HasContext) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
- Public Member Functions inherited from OdIfc4x3_rc1::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 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 OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdDAI::Enum m_PredefinedType
 
OdDAI::Select m_Jurisdiction
 
OdDAI::SetOfOdDAIObjectId m_ResponsiblePersons
 
OdAnsiString m_LastUpdateDate
 
OdDAIObjectId m_CurrentValue
 
OdDAIObjectId m_OriginalValue
 
- Protected Attributes inherited from OdIfc4x3_rc1::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc4x3_rc1::IfcRoot
OdDAI::CompressedGUID m_GlobalId
 
OdDAIObjectId m_OwnerHistory
 
OdAnsiString m_Name
 
OdAnsiString m_Description
 
- 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)
 
- Protected Member Functions inherited from OdIfc4x3_rc1::IfcObjectDefinition
virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 

Detailed Description

An inventory is a list of items within an enterprise. Various types of inventory can be included. These are identified by the range of values within the inventory type enumeration which includes space, asset, and furniture. User defined inventories can also be defined for lists of particular types of element such as can be required in operating and maintenance instructions. Such inventories should be constrained to contain a list of elements of a restricted type.

There are a number of actors that can be associated with an inventory, each actor having a role. Actors within the scope of the project are indicated using the IfcRelAssignsToActor relationship in which case roles should be defined through the IfcActorRole class; otherwise principal actors are identified as attributes of the class. In the existence of both, direct attributes take precedence.

Definition at line 50 of file Ifc4x3_RC1/IfcInventoryAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcInventory()

OdIfc4x3_rc1::IfcInventory::IfcInventory ( )

Default constructor for the IfcInventory class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

◆ getCurrentValue()

const OdDAIObjectId & OdIfc4x3_rc1::IfcInventory::getCurrentValue ( ) const

Returns the value of CurrentValue attribute. This attribute represents an estimate of the current cost value of the inventory.

Returns
Returns the value of CurrentValue attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x3_rc1::IfcInventory::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::IfcGroup.

◆ getLastUpdateDate()

const OdAnsiString & OdIfc4x3_rc1::IfcInventory::getLastUpdateDate ( ) const

Returns the value of LastUpdateDate attribute. This attribute represents the date on which the last update of the inventory was carried out.

Returns
Returns the value of LastUpdateDate attribute.
Remarks
IFC4 CHANGE: Type changed from IfcDateTimeSelect.

◆ getOriginalValue()

const OdDAIObjectId & OdIfc4x3_rc1::IfcInventory::getOriginalValue ( ) const

Returns the value of OriginalValue attribute. This attribute represents an estimate of the original cost value of the inventory.

Returns
Returns the value of OriginalValue attribute.

◆ getPredefinedType()

IfcInventoryTypeEnum OdIfc4x3_rc1::IfcInventory::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents a list of the types of inventories from which that required type can be selected.

Returns
Returns the value of PredefinedType attribute.
Remarks
IFC4 CHANGE: Attribute made optional.

◆ getResponsiblePersons()

void OdIfc4x3_rc1::IfcInventory::getResponsiblePersons ( OdDAIObjectIds & ResponsiblePersons) const

Gets the value of ResponsiblePersons attribute. This attribute represents persons who are responsible for the inventory.

Parameters
ResponsiblePersons[out] Receives the ResponsiblePersons attribute.

◆ inFields()

virtual OdResult OdIfc4x3_rc1::IfcInventory::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::IfcGroup.

◆ isKindOf()

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

◆ jurisdiction()

IfcActorSelect OdIfc4x3_rc1::IfcInventory::jurisdiction ( )

Returns the value of Jurisdiction attribute. This attribute represents the organizational unit to which the inventory is applicable.

Returns
Returns the value of Jurisdiction attribute.

◆ outFields()

virtual OdResult OdIfc4x3_rc1::IfcInventory::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::IfcGroup.

◆ putAttr() [1/2]

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

◆ putAttr() [2/2]

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

◆ responsiblePersons()

OdDAI::SetOfOdDAIObjectId & OdIfc4x3_rc1::IfcInventory::responsiblePersons ( )

Returns the value of ResponsiblePersons attribute. This attribute represents persons who are responsible for the inventory.

Returns
Returns the value of ResponsiblePersons attribute.

◆ setCurrentValue()

void OdIfc4x3_rc1::IfcInventory::setCurrentValue ( const OdDAIObjectId & CurrentValue)

Sets the value of CurrentValue attribute. This attribute represents an estimate of the current cost value of the inventory.

Parameters
CurrentValue[in] Current value to set.

◆ setLastUpdateDate()

void OdIfc4x3_rc1::IfcInventory::setLastUpdateDate ( const OdAnsiString & LastUpdateDate)

Sets the value of LastUpdateDate attribute. This attribute represents the date on which the last update of the inventory was carried out.

Parameters
LastUpdateDate[in] Last update date to set.
Remarks
IFC4 CHANGE: Type changed from IfcDateTimeSelect.

◆ setOriginalValue()

void OdIfc4x3_rc1::IfcInventory::setOriginalValue ( const OdDAIObjectId & OriginalValue)

Sets the value of OriginalValue attribute. This attribute represents an estimate of the original cost value of the inventory.

Parameters
OriginalValue[in] Original value to set.

◆ setPredefinedType()

void OdIfc4x3_rc1::IfcInventory::setPredefinedType ( IfcInventoryTypeEnum PredefinedType)

Sets the value of PredefinedType attribute. This attribute represents a list of the types of inventories from which that required type can be selected.

Parameters
PredefinedType[in] Predefined type to set.
Remarks
IFC4 CHANGE: Attribute made optional.

◆ testAttr() [1/2]

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

◆ testAttr() [2/2]

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

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x3_rc1::IfcInventory::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::IfcGroup.

◆ unsetAttr() [1/2]

virtual void OdIfc4x3_rc1::IfcInventory::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::IfcGroup.

◆ unsetAttr() [2/2]

virtual void OdIfc4x3_rc1::IfcInventory::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::IfcGroup.

Member Data Documentation

◆ m_CurrentValue

OdDAIObjectId OdIfc4x3_rc1::IfcInventory::m_CurrentValue
protected

Definition at line 289 of file Ifc4x3_RC1/IfcInventoryAutoImpl.h.

◆ m_Jurisdiction

OdDAI::Select OdIfc4x3_rc1::IfcInventory::m_Jurisdiction
protected

Definition at line 285 of file Ifc4x3_RC1/IfcInventoryAutoImpl.h.

◆ m_LastUpdateDate

OdAnsiString OdIfc4x3_rc1::IfcInventory::m_LastUpdateDate
protected

Definition at line 288 of file Ifc4x3_RC1/IfcInventoryAutoImpl.h.

◆ m_OriginalValue

OdDAIObjectId OdIfc4x3_rc1::IfcInventory::m_OriginalValue
protected

Definition at line 290 of file Ifc4x3_RC1/IfcInventoryAutoImpl.h.

◆ m_PredefinedType

OdDAI::Enum OdIfc4x3_rc1::IfcInventory::m_PredefinedType
protected

Definition at line 284 of file Ifc4x3_RC1/IfcInventoryAutoImpl.h.

◆ m_ResponsiblePersons

OdDAI::SetOfOdDAIObjectId OdIfc4x3_rc1::IfcInventory::m_ResponsiblePersons
protected

Definition at line 286 of file Ifc4x3_RC1/IfcInventoryAutoImpl.h.


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