#include <IfcOwnerHistoryAutoImpl.h>
IfcOwnerHistory defines all history and identification related information. To provide fast access it is directly attached to all independent objects, relationships and properties. IfcOwnerHistory identifies the creating and owning application and user for the associated object, and captures the last modifying application and user.
Definition at line 48 of file Ifc2x3/IfcOwnerHistoryAutoImpl.h.
◆ IfcOwnerHistory()
| OdIfc2x3::IfcOwnerHistory::IfcOwnerHistory |
( |
| ) |
|
◆ comparedToEarlyImpl()
| virtual bool OdIfc2x3::IfcOwnerHistory::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.
◆ getAttr() [1/2]
| virtual OdRxValue OdIfc2x3::IfcOwnerHistory::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]
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.
◆ getChangeAction()
Returns the value of ChangeAction attribute. This attribute represents enumeration that defines the actions associated with changes made to the object.
- Returns
- Returns the value of ChangeAction attribute.
◆ getCreationDate()
| int OdIfc2x3::IfcOwnerHistory::getCreationDate |
( |
| ) |
const |
Returns the value of CreationDate attribute. This attribute represents the date and time expressed in UTC (Universal Time Coordinated, formerly Greenwich Mean Time or GMT) when first created by the original OwningApplication. Once defined this value remains unchanged through the lifetime of the entity.
- Returns
- Returns the value of CreationDate attribute.
◆ getInstanceType()
| virtual OdDAI::Entity * OdIfc2x3::IfcOwnerHistory::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.
◆ getLastModifiedDate()
| int OdIfc2x3::IfcOwnerHistory::getLastModifiedDate |
( |
| ) |
const |
Returns the value of LastModifiedDate attribute. This attribute represents date and time expressed in UTC (Universal Time Coordinated, formerly Greenwich Mean Time or GMT) at which the last modification was made by last modifying user (LastModifyingUser attribute) and last modifying application (LastModifyingApplication attribute).
- Returns
- Returns the value of LastModifiedDate attribute.
◆ getLastModifyingApplication()
| const OdDAIObjectId & OdIfc2x3::IfcOwnerHistory::getLastModifyingApplication |
( |
| ) |
const |
Returns the value of LastModifyingApplication attribute. This attribute represents application used to make the last modification.
- Returns
- Returns the value of LastModifyingApplication attribute.
◆ getLastModifyingUser()
| const OdDAIObjectId & OdIfc2x3::IfcOwnerHistory::getLastModifyingUser |
( |
| ) |
const |
Returns the value of LastModifyingUser attribute. This attribute represents user who made the last modification using last modifying application (LastModifyingApplication attribute).
- Returns
- Returns the value of LastModifyingUser attribute.
◆ getOwningApplication()
| const OdDAIObjectId & OdIfc2x3::IfcOwnerHistory::getOwningApplication |
( |
| ) |
const |
Returns the value of OwningApplication attribute. This attribute represents reference to the application which currently "owns" this object on behalf of the owning user of the application. IFC includes the concept of ownership transfer from one application to another and therefore distinguishes between the Owning Application and Creating Application.
- Returns
- Returns the value of OwningApplication attribute.
◆ getOwningUser()
| const OdDAIObjectId & OdIfc2x3::IfcOwnerHistory::getOwningUser |
( |
| ) |
const |
Returns the value of OwningUser attribute. This attribute represents reference to the end user who currently "owns" this object. IFC includes the concept of ownership transfer from one user to another and therefore distinguishes between the Owning User and Creating User.
- Returns
- Returns the value of OwningUser attribute.
◆ getState()
Returns the value of State attribute. This attribute represents enumeration that defines the current access state of the object.
- Returns
- Returns the value of State attribute.
◆ inFields()
| virtual OdResult OdIfc2x3::IfcOwnerHistory::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()
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::IfcOwnerHistory::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::IfcOwnerHistory::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]
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.
◆ setChangeAction()
Sets the value of ChangeAction attribute. This attribute represents enumeration that defines the actions associated with changes made to the object.
- Parameters
-
| ChangeAction | [in] ChangeAction attribute to set. |
◆ setCreationDate()
| void OdIfc2x3::IfcOwnerHistory::setCreationDate |
( |
int | CreationDate | ) |
|
Sets the value of CreationDate attribute. This attribute represents the date and time expressed in UTC (Universal Time Coordinated, formerly Greenwich Mean Time or GMT) when first created by the original OwningApplication. Once defined this value remains unchanged through the lifetime of the entity.
- Parameters
-
| CreationDate | [in] Creation date to set. |
◆ setLastModifiedDate()
| void OdIfc2x3::IfcOwnerHistory::setLastModifiedDate |
( |
int | LastModifiedDate | ) |
|
Sets the value of LastModifiedDate attribute. This attribute represents date and time expressed in UTC (Universal Time Coordinated, formerly Greenwich Mean Time or GMT) at which the last modification was made by last modifying user (LastModifyingUser attribute) and last modifying application (LastModifyingApplication attribute).
- Parameters
-
| LastModifiedDate | [in] Last modified date to set. |
◆ setLastModifyingApplication()
| void OdIfc2x3::IfcOwnerHistory::setLastModifyingApplication |
( |
const OdDAIObjectId & | LastModifyingApplication | ) |
|
Sets the value of LastModifyingApplication attribute. This attribute represents application used to make the last modification.
- Parameters
-
| LastModifyingApplication | [in] Last modifying application to set. |
◆ setLastModifyingUser()
| void OdIfc2x3::IfcOwnerHistory::setLastModifyingUser |
( |
const OdDAIObjectId & | LastModifyingUser | ) |
|
Sets the value of LastModifyingUser attribute. This attribute represents user who made the last modification using last modifying application (LastModifyingApplication attribute).
- Parameters
-
| LastModifyingUser | [in] Last modifying user to set. |
◆ setOwningApplication()
| void OdIfc2x3::IfcOwnerHistory::setOwningApplication |
( |
const OdDAIObjectId & | OwningApplication | ) |
|
Sets the value of OwningApplication attribute. This attribute represents reference to the application which currently "owns" this object on behalf of the owning user of the application. IFC includes the concept of ownership transfer from one application to another and therefore distinguishes between the Owning Application and Creating Application.
- Parameters
-
| OwningApplication | [in] Owning application to set. |
◆ setOwningUser()
| void OdIfc2x3::IfcOwnerHistory::setOwningUser |
( |
const OdDAIObjectId & | OwningUser | ) |
|
Sets the value of OwningUser attribute. This attribute represents reference to the end user who currently "owns" this object. IFC includes the concept of ownership transfer from one user to another and therefore distinguishes between the Owning User and Creating User.
- Parameters
-
| OwningUser | [in] Owning user to set. |
◆ setState()
Sets the value of State attribute. This attribute represents enumeration that defines the current access state of the object.
- Parameters
-
| State | [in] Access state to set. |
◆ testAttr() [1/2]
| virtual bool OdIfc2x3::IfcOwnerHistory::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]
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()
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::IfcOwnerHistory::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]
Resets a value for the specified attribute.
- Parameters
-
| explicitAttrDef | [in] Explicit definition that represents an attribute to reset. |
Reimplemented from OdIfc::OdIfcInstance.
◆ m_ChangeAction
| OdDAI::Enum OdIfc2x3::IfcOwnerHistory::m_ChangeAction |
|
protected |
◆ m_CreationDate
| int OdIfc2x3::IfcOwnerHistory::m_CreationDate |
|
protected |
◆ m_LastModifiedDate
| int OdIfc2x3::IfcOwnerHistory::m_LastModifiedDate |
|
protected |
◆ m_LastModifyingApplication
| OdDAIObjectId OdIfc2x3::IfcOwnerHistory::m_LastModifyingApplication |
|
protected |
◆ m_LastModifyingUser
| OdDAIObjectId OdIfc2x3::IfcOwnerHistory::m_LastModifyingUser |
|
protected |
◆ m_OwningApplication
| OdDAIObjectId OdIfc2x3::IfcOwnerHistory::m_OwningApplication |
|
protected |
◆ m_OwningUser
| OdDAIObjectId OdIfc2x3::IfcOwnerHistory::m_OwningUser |
|
protected |
◆ m_State
| OdDAI::Enum OdIfc2x3::IfcOwnerHistory::m_State |
|
protected |
The documentation for this class was generated from the following file: