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

#include <IfcDocumentInformationAutoImpl.h>

Inheritance diagram for OdIfc4x2::IfcDocumentInformation:
OdIfc4x2::IfcExternalInformation OdIfc::OdIfcEntity

Public Member Functions

const OdAnsiString & getIdentification () const
 
void setIdentification (const OdAnsiString &Identification)
 
const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
const OdAnsiString & getLocation () const
 
void setLocation (const OdAnsiString &Location)
 
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 OdAnsiString & getCreationTime () const
 
void setCreationTime (const OdAnsiString &CreationTime)
 
const OdAnsiString & getLastRevisionTime () const
 
void setLastRevisionTime (const OdAnsiString &LastRevisionTime)
 
const OdAnsiString & getElectronicFormat () const
 
void setElectronicFormat (const OdAnsiString &ElectronicFormat)
 
const OdAnsiString & getValidFrom () const
 
void setValidFrom (const OdAnsiString &ValidFrom)
 
const OdAnsiString & getValidUntil () const
 
void setValidUntil (const OdAnsiString &ValidUntil)
 
IfcDocumentConfidentialityEnum getConfidentiality () const
 
void setConfidentiality (IfcDocumentConfidentialityEnum Confidentiality)
 
IfcDocumentStatusEnum getStatus () const
 
void setStatus (IfcDocumentStatusEnum Status)
 
void getInvDocumentInfoForObjects (OdDAIObjectIds &DocumentInfoForObjects) const
 
void getInvHasDocumentReferences (OdDAIObjectIds &HasDocumentReferences) const
 
void getInvIsPointedTo (OdDAIObjectIds &IsPointedTo) const
 
void getInvIsPointer (OdDAIObjectIds &IsPointer) const
 
 IfcDocumentInformation ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual OdRxValue getAttr (const char *attrName) 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)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
- 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_Identification
 
OdAnsiString m_Name
 
OdAnsiString m_Description
 
OdAnsiString m_Location
 
OdAnsiString m_Purpose
 
OdAnsiString m_IntendedUse
 
OdAnsiString m_Scope
 
OdAnsiString m_Revision
 
OdDAI::Select m_DocumentOwner
 
OdDAI::Set< OdDAI::Select > m_Editors
 
OdAnsiString m_CreationTime
 
OdAnsiString m_LastRevisionTime
 
OdAnsiString m_ElectronicFormat
 
OdAnsiString m_ValidFrom
 
OdAnsiString m_ValidUntil
 
OdDAI::Enum m_Confidentiality
 
OdDAI::Enum m_Status
 
- Protected Attributes inherited from OdIfc::OdIfcEntity
void * m_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcRelAssociatesDocument
 
class IfcDocumentReference
 
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 37 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcDocumentInformation()

OdIfc4x2::IfcDocumentInformation::IfcDocumentInformation ( )

Member Function Documentation

◆ documentOwner()

IfcActorSelect OdIfc4x2::IfcDocumentInformation::documentOwner ( )

◆ editors()

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

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x2::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 OdIfc4x2::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 OdIfc4x2::IfcDocumentInformation::getConfidentiality ( ) const

◆ getCreationTime()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getCreationTime ( ) const

◆ getDescription()

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

◆ getEditors()

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

◆ getEditorsWrapperArray()

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

◆ getElectronicFormat()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getElectronicFormat ( ) const

◆ getIdentification()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getIdentification ( ) const

◆ getInstanceType()

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

Reimplemented from OdIfc4x2::IfcExternalInformation.

◆ getIntendedUse()

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

◆ getInvDocumentInfoForObjects()

void OdIfc4x2::IfcDocumentInformation::getInvDocumentInfoForObjects ( OdDAIObjectIds &  DocumentInfoForObjects) const

◆ getInvHasDocumentReferences()

void OdIfc4x2::IfcDocumentInformation::getInvHasDocumentReferences ( OdDAIObjectIds &  HasDocumentReferences) const

◆ getInvIsPointedTo()

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

◆ getInvIsPointer()

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

◆ getLastRevisionTime()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getLastRevisionTime ( ) const

◆ getLocation()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getLocation ( ) const

◆ getName()

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

◆ getPurpose()

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

◆ getRevision()

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

◆ getScope()

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

◆ getStatus()

IfcDocumentStatusEnum OdIfc4x2::IfcDocumentInformation::getStatus ( ) const

◆ getValidFrom()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getValidFrom ( ) const

◆ getValidUntil()

const OdAnsiString & OdIfc4x2::IfcDocumentInformation::getValidUntil ( ) const

◆ inFields()

virtual OdResult OdIfc4x2::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 OdIfc4x2::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 OdIfc4x2::IfcExternalInformation.

◆ outFields()

virtual OdResult OdIfc4x2::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 OdIfc4x2::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 OdIfc4x2::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 OdIfc4x2::IfcDocumentInformation::setConfidentiality ( IfcDocumentConfidentialityEnum  Confidentiality)

◆ setCreationTime()

void OdIfc4x2::IfcDocumentInformation::setCreationTime ( const OdAnsiString &  CreationTime)

◆ setDescription()

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

◆ setElectronicFormat()

void OdIfc4x2::IfcDocumentInformation::setElectronicFormat ( const OdAnsiString &  ElectronicFormat)

◆ setIdentification()

void OdIfc4x2::IfcDocumentInformation::setIdentification ( const OdAnsiString &  Identification)

◆ setIntendedUse()

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

◆ setLastRevisionTime()

void OdIfc4x2::IfcDocumentInformation::setLastRevisionTime ( const OdAnsiString &  LastRevisionTime)

◆ setLocation()

void OdIfc4x2::IfcDocumentInformation::setLocation ( const OdAnsiString &  Location)

◆ setName()

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

◆ setPurpose()

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

◆ setRevision()

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

◆ setScope()

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

◆ setStatus()

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

◆ setValidFrom()

void OdIfc4x2::IfcDocumentInformation::setValidFrom ( const OdAnsiString &  ValidFrom)

◆ setValidUntil()

void OdIfc4x2::IfcDocumentInformation::setValidUntil ( const OdAnsiString &  ValidUntil)

◆ testAttr() [1/2]

virtual bool OdIfc4x2::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 OdIfc4x2::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 OdIfc4x2::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 OdIfc4x2::IfcExternalInformation.

◆ unsetAttr() [1/2]

virtual void OdIfc4x2::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 OdIfc4x2::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 217 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

◆ IfcDocumentReference

friend class IfcDocumentReference
friend

Definition at line 216 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

◆ IfcRelAssociatesDocument

friend class IfcRelAssociatesDocument
friend

Definition at line 215 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

Member Data Documentation

◆ m_Confidentiality

OdDAI::Enum OdIfc4x2::IfcDocumentInformation::m_Confidentiality
protected

Definition at line 211 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

◆ m_CreationTime

OdAnsiString OdIfc4x2::IfcDocumentInformation::m_CreationTime
protected

Definition at line 206 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

◆ m_Description

OdAnsiString OdIfc4x2::IfcDocumentInformation::m_Description
protected

Definition at line 197 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

◆ m_DocumentOwner

OdDAI::Select OdIfc4x2::IfcDocumentInformation::m_DocumentOwner
protected

Definition at line 203 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

◆ m_Editors

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

Definition at line 204 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

◆ m_ElectronicFormat

OdAnsiString OdIfc4x2::IfcDocumentInformation::m_ElectronicFormat
protected

Definition at line 208 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

◆ m_Identification

OdAnsiString OdIfc4x2::IfcDocumentInformation::m_Identification
protected

Definition at line 195 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

◆ m_IntendedUse

OdAnsiString OdIfc4x2::IfcDocumentInformation::m_IntendedUse
protected

Definition at line 200 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

◆ m_LastRevisionTime

OdAnsiString OdIfc4x2::IfcDocumentInformation::m_LastRevisionTime
protected

Definition at line 207 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

◆ m_Location

OdAnsiString OdIfc4x2::IfcDocumentInformation::m_Location
protected

Definition at line 198 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc4x2::IfcDocumentInformation::m_Name
protected

Definition at line 196 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

◆ m_Purpose

OdAnsiString OdIfc4x2::IfcDocumentInformation::m_Purpose
protected

Definition at line 199 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

◆ m_Revision

OdAnsiString OdIfc4x2::IfcDocumentInformation::m_Revision
protected

Definition at line 202 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

◆ m_Scope

OdAnsiString OdIfc4x2::IfcDocumentInformation::m_Scope
protected

Definition at line 201 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

◆ m_Status

OdDAI::Enum OdIfc4x2::IfcDocumentInformation::m_Status
protected

Definition at line 212 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

◆ m_ValidFrom

OdAnsiString OdIfc4x2::IfcDocumentInformation::m_ValidFrom
protected

Definition at line 209 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

◆ m_ValidUntil

OdAnsiString OdIfc4x2::IfcDocumentInformation::m_ValidUntil
protected

Definition at line 210 of file Ifc4x2/IfcDocumentInformationAutoImpl.h.

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