CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Friends | List of all members
OdIfc2x3::IfcDocumentInformation Class Reference

#include <IfcDocumentInformationAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcDocumentInformation:
OdIfc::OdIfcEntity

Public Member Functions

const OdAnsiString & getDocumentId () const
 
void setDocumentId (const OdAnsiString &DocumentId)
 
const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
void getDocumentReferences (OdDAIObjectIds &DocumentReferences) const
 
OdDAI::OdDAIObjectIdSet & documentReferences ()
 
const OdAnsiString & getPurpose () const
 
void setPurpose (const OdAnsiString &Purpose)
 
const OdAnsiString & getIntendedUse () const
 
void setIntendedUse (const OdAnsiString &IntendedUse)
 
const OdAnsiString & getScope () const
 
void setScope (const OdAnsiString &Scope)
 
const OdAnsiString & getRevision () const
 
void setRevision (const OdAnsiString &Revision)
 
IfcActorSelect documentOwner ()
 
void getEditors (OdArray< OdDAI::Select > &Editors) const
 
void getEditorsWrapperArray (OdArray< IfcActorSelect > &Editors) const
 
OdDAI::Set< OdDAI::Select > & editors ()
 
const OdDAIObjectId & getCreationTime () const
 
void setCreationTime (const OdDAIObjectId &CreationTime)
 
const OdDAIObjectId & getLastRevisionTime () const
 
void setLastRevisionTime (const OdDAIObjectId &LastRevisionTime)
 
const OdDAIObjectId & getElectronicFormat () const
 
void setElectronicFormat (const OdDAIObjectId &ElectronicFormat)
 
const OdDAIObjectId & getValidFrom () const
 
void setValidFrom (const OdDAIObjectId &ValidFrom)
 
const OdDAIObjectId & getValidUntil () const
 
void setValidUntil (const OdDAIObjectId &ValidUntil)
 
IfcDocumentConfidentialityEnum getConfidentiality () const
 
void setConfidentiality (IfcDocumentConfidentialityEnum Confidentiality)
 
IfcDocumentStatusEnum getStatus () const
 
void setStatus (IfcDocumentStatusEnum Status)
 
void getInvIsPointedTo (OdDAIObjectIds &IsPointedTo) const
 
void getInvIsPointer (OdDAIObjectIds &IsPointer) const
 
 IfcDocumentInformation ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual void setInverseCounterParts ()
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual OdRxValue getAttr (const char *attrName) const
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
- Public Member Functions inherited from OdIfc::OdIfcEntity
 ODRX_DECLARE_MEMBERS (OdIfcEntity)
 
 OdIfcEntity ()
 
 ~OdIfcEntity ()
 
virtual bool isKindOf (OdIfcEntityType entityType) const
 
bool isInstanceOf (OdIfcEntityType entityType) const
 
virtual OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfcAttribute attrDef) const
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool testAttr (const OdIfcAttribute explicitAttrDef) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual void unsetAttr (const OdIfcAttribute explicitAttrDef)
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool putAttr (const OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
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
 

Protected Attributes

OdAnsiString m_DocumentId
 
OdAnsiString m_Name
 
OdAnsiString m_Description
 
OdDAI::OdDAIObjectIdSet m_DocumentReferences
 
OdAnsiString m_Purpose
 
OdAnsiString m_IntendedUse
 
OdAnsiString m_Scope
 
OdAnsiString m_Revision
 
OdDAI::Select m_DocumentOwner
 
OdDAI::Set< OdDAI::Select > m_Editors
 
OdDAIObjectId m_CreationTime
 
OdDAIObjectId m_LastRevisionTime
 
OdDAIObjectId m_ElectronicFormat
 
OdDAIObjectId m_ValidFrom
 
OdDAIObjectId m_ValidUntil
 
OdDAI::Enum m_Confidentiality
 
OdDAI::Enum m_Status
 
- Protected Attributes inherited from OdIfc::OdIfcEntity
void * m_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcDocumentInformationRelationship
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcEntity
static const OdGePoint3d * asPoint3d (const OdIfcEntity *pEnt)
 
static const OdGePoint2d * asPoint2d (const OdIfcEntity *pEnt)
 
static const OdGeVector3d * asVector3d (const OdIfcEntity *pEnt)
 
static const OdGeVector2d * asVector2d (const OdIfcEntity *pEnt)
 
static const OdGeMatrix2d * asMatrix2d (const OdIfcEntity *pEnt)
 
static const OdGeMatrix3d * asMatrix3d (const OdIfcEntity *pEnt)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcEntity > pEnt)
 
static const OdCmEntityColor * asRgbColor (const OdIfcEntity *pEnt)
 

Detailed Description

Definition at line 45 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcDocumentInformation()

OdIfc2x3::IfcDocumentInformation::IfcDocumentInformation ( )

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcDocumentInformation::comparedToEarlyImpl ( const OdDAI::ApplicationInstance *  pOther,
OdRx::Ordering &  ordering 
) const
virtual

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.

◆ documentOwner()

IfcActorSelect OdIfc2x3::IfcDocumentInformation::documentOwner ( )

◆ documentReferences()

OdDAI::OdDAIObjectIdSet & OdIfc2x3::IfcDocumentInformation::documentReferences ( )

◆ editors()

OdDAI::Set< OdDAI::Select > & OdIfc2x3::IfcDocumentInformation::editors ( )

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcDocumentInformation::getAttr ( const char *  attrName) const
virtual

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::IfcDocumentInformation::getAttr ( const OdIfc::OdIfcAttribute  attrDef) const
virtual

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::OdIfcEntity.

◆ getConfidentiality()

IfcDocumentConfidentialityEnum OdIfc2x3::IfcDocumentInformation::getConfidentiality ( ) const

◆ getCreationTime()

const OdDAIObjectId & OdIfc2x3::IfcDocumentInformation::getCreationTime ( ) const

◆ getDescription()

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

◆ getDocumentId()

const OdAnsiString & OdIfc2x3::IfcDocumentInformation::getDocumentId ( ) const

◆ getDocumentReferences()

void OdIfc2x3::IfcDocumentInformation::getDocumentReferences ( OdDAIObjectIds &  DocumentReferences) const

◆ getEditors()

void OdIfc2x3::IfcDocumentInformation::getEditors ( OdArray< OdDAI::Select > &  Editors) const

◆ getEditorsWrapperArray()

void OdIfc2x3::IfcDocumentInformation::getEditorsWrapperArray ( OdArray< IfcActorSelect > &  Editors) const

◆ getElectronicFormat()

const OdDAIObjectId & OdIfc2x3::IfcDocumentInformation::getElectronicFormat ( ) const

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcDocumentInformation::getInstanceType ( ) const
virtual

Returns a type of a class instance.

Returns
Pointer to the <link OdDAI__Entity, OdDAI::Entity> type that determines an entity definition within a schema.

◆ getIntendedUse()

const OdAnsiString & OdIfc2x3::IfcDocumentInformation::getIntendedUse ( ) const

◆ getInvIsPointedTo()

void OdIfc2x3::IfcDocumentInformation::getInvIsPointedTo ( OdDAIObjectIds &  IsPointedTo) const

◆ getInvIsPointer()

void OdIfc2x3::IfcDocumentInformation::getInvIsPointer ( OdDAIObjectIds &  IsPointer) const

◆ getLastRevisionTime()

const OdDAIObjectId & OdIfc2x3::IfcDocumentInformation::getLastRevisionTime ( ) const

◆ getName()

const OdAnsiString & OdIfc2x3::IfcDocumentInformation::getName ( ) const

◆ getPurpose()

const OdAnsiString & OdIfc2x3::IfcDocumentInformation::getPurpose ( ) const

◆ getRevision()

const OdAnsiString & OdIfc2x3::IfcDocumentInformation::getRevision ( ) const

◆ getScope()

const OdAnsiString & OdIfc2x3::IfcDocumentInformation::getScope ( ) const

◆ getStatus()

IfcDocumentStatusEnum OdIfc2x3::IfcDocumentInformation::getStatus ( ) const

◆ getValidFrom()

const OdDAIObjectId & OdIfc2x3::IfcDocumentInformation::getValidFrom ( ) const

◆ getValidUntil()

const OdDAIObjectId & OdIfc2x3::IfcDocumentInformation::getValidUntil ( ) const

◆ inFields()

virtual OdResult OdIfc2x3::IfcDocumentInformation::inFields ( OdDAI::OdSpfFilerBase *  rdFiler)
virtual

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::IfcDocumentInformation::isKindOf ( OdIfc::OdIfcEntityType  entityType) const
virtual

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::OdIfcEntity.

◆ outFields()

virtual OdResult OdIfc2x3::IfcDocumentInformation::outFields ( OdDAI::OdSpfFilerBase *  wrFiler)
virtual

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::IfcDocumentInformation::putAttr ( const char *  explicitAttrName,
const OdRxValue &  val 
)
virtual

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::OdIfcEntity.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcDocumentInformation::putAttr ( const OdIfc::OdIfcAttribute  explicitAttrDef,
const OdRxValue &  val 
)
virtual

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::OdIfcEntity.

◆ setConfidentiality()

void OdIfc2x3::IfcDocumentInformation::setConfidentiality ( IfcDocumentConfidentialityEnum  Confidentiality)

◆ setCreationTime()

void OdIfc2x3::IfcDocumentInformation::setCreationTime ( const OdDAIObjectId &  CreationTime)

◆ setDescription()

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

◆ setDocumentId()

void OdIfc2x3::IfcDocumentInformation::setDocumentId ( const OdAnsiString &  DocumentId)

◆ setElectronicFormat()

void OdIfc2x3::IfcDocumentInformation::setElectronicFormat ( const OdDAIObjectId &  ElectronicFormat)

◆ setIntendedUse()

void OdIfc2x3::IfcDocumentInformation::setIntendedUse ( const OdAnsiString &  IntendedUse)

◆ setInverseCounterParts()

virtual void OdIfc2x3::IfcDocumentInformation::setInverseCounterParts ( )
virtual

Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.

◆ setLastRevisionTime()

void OdIfc2x3::IfcDocumentInformation::setLastRevisionTime ( const OdDAIObjectId &  LastRevisionTime)

◆ setName()

void OdIfc2x3::IfcDocumentInformation::setName ( const OdAnsiString &  Name)

◆ setPurpose()

void OdIfc2x3::IfcDocumentInformation::setPurpose ( const OdAnsiString &  Purpose)

◆ setRevision()

void OdIfc2x3::IfcDocumentInformation::setRevision ( const OdAnsiString &  Revision)

◆ setScope()

void OdIfc2x3::IfcDocumentInformation::setScope ( const OdAnsiString &  Scope)

◆ setStatus()

void OdIfc2x3::IfcDocumentInformation::setStatus ( IfcDocumentStatusEnum  Status)

◆ setValidFrom()

void OdIfc2x3::IfcDocumentInformation::setValidFrom ( const OdDAIObjectId &  ValidFrom)

◆ setValidUntil()

void OdIfc2x3::IfcDocumentInformation::setValidUntil ( const OdDAIObjectId &  ValidUntil)

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcDocumentInformation::testAttr ( const char *  explicitAttrName) const
virtual

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::OdIfcEntity.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcDocumentInformation::testAttr ( const OdIfc::OdIfcAttribute  explicitAttrDef) const
virtual

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::OdIfcEntity.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcDocumentInformation::type ( ) const
virtual

Returns the type of this entity.

Returns
A value of the <link OdIfc__OdIfcEntityType, OdIfc::OdIfcEntityType> type that represents type of this entity.

Reimplemented from OdIfc::OdIfcEntity.

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcDocumentInformation::unsetAttr ( const char *  explicitAttrName)
virtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc::OdIfcEntity.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcDocumentInformation::unsetAttr ( const OdIfc::OdIfcAttribute  explicitAttrDef)
virtual

Resets a value for the specified attribute.

Parameters
explicitAttrDef[in] Explicit definition that represents an attribute to reset.

Reimplemented from OdIfc::OdIfcEntity.

Friends And Related Function Documentation

◆ IfcDocumentInformationRelationship

IfcDocumentInformationRelationship
friend

Definition at line 246 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.

Member Data Documentation

◆ m_Confidentiality

OdDAI::Enum OdIfc2x3::IfcDocumentInformation::m_Confidentiality
protected

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

◆ m_CreationTime

OdDAIObjectId OdIfc2x3::IfcDocumentInformation::m_CreationTime
protected

Definition at line 237 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.

◆ m_Description

OdAnsiString OdIfc2x3::IfcDocumentInformation::m_Description
protected

Definition at line 227 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.

◆ m_DocumentId

OdAnsiString OdIfc2x3::IfcDocumentInformation::m_DocumentId
protected

Definition at line 225 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.

◆ m_DocumentOwner

OdDAI::Select OdIfc2x3::IfcDocumentInformation::m_DocumentOwner
protected

Definition at line 234 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.

◆ m_DocumentReferences

OdDAI::OdDAIObjectIdSet OdIfc2x3::IfcDocumentInformation::m_DocumentReferences
protected

Definition at line 228 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.

◆ m_Editors

OdDAI::Set<OdDAI::Select> OdIfc2x3::IfcDocumentInformation::m_Editors
protected

Definition at line 235 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.

◆ m_ElectronicFormat

OdDAIObjectId OdIfc2x3::IfcDocumentInformation::m_ElectronicFormat
protected

Definition at line 239 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.

◆ m_IntendedUse

OdAnsiString OdIfc2x3::IfcDocumentInformation::m_IntendedUse
protected

Definition at line 231 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.

◆ m_LastRevisionTime

OdDAIObjectId OdIfc2x3::IfcDocumentInformation::m_LastRevisionTime
protected

Definition at line 238 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc2x3::IfcDocumentInformation::m_Name
protected

Definition at line 226 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.

◆ m_Purpose

OdAnsiString OdIfc2x3::IfcDocumentInformation::m_Purpose
protected

Definition at line 230 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.

◆ m_Revision

OdAnsiString OdIfc2x3::IfcDocumentInformation::m_Revision
protected

Definition at line 233 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.

◆ m_Scope

OdAnsiString OdIfc2x3::IfcDocumentInformation::m_Scope
protected

Definition at line 232 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.

◆ m_Status

OdDAI::Enum OdIfc2x3::IfcDocumentInformation::m_Status
protected

Definition at line 243 of file Ifc2x3/IfcDocumentInformationAutoImpl.h.

◆ m_ValidFrom

OdDAIObjectId OdIfc2x3::IfcDocumentInformation::m_ValidFrom
protected

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

◆ m_ValidUntil

OdDAIObjectId OdIfc2x3::IfcDocumentInformation::m_ValidUntil
protected

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

The documentation for this class was generated from the following file:
Generated on Wed Apr 5 2023 17:36:07