CFx SDK Documentation  2023 SP0
Public Member Functions | Protected Member Functions | Friends | List of all members
OdBcf::OdBcfComponent Class Reference

#include <BcfComponent.h>

Inheritance diagram for OdBcf::OdBcfComponent:
OdBcf::OdBcfElement OdBcf::OdBcfComponentData OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdBcfComponent)
 
 OdBcfComponent ()
 
virtual OdResult inFields (TiXmlElement *pParent) ODRX_OVERRIDE
 
virtual OdResult outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
 
virtual bool validate () const ODRX_OVERRIDE
 
 DECLARE_CONST_ACCESSORS (IfcGuid, OdString, m_ifcGuid)
 
 DECLARE_CONST_ACCESSORS (OriginatingSystem, OdString, m_originatingSystem)
 
 DECLARE_CONST_ACCESSORS (AuthoringToolId, OdString, m_authoringToolId)
 
- Public Member Functions inherited from OdBcf::OdBcfElement
 ODRX_DECLARE_MEMBERS (OdBcfElement)
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Protected Member Functions

OdBcfComponentoperator= (const OdBcfComponentData &val)
 

Friends

class OdBcfSession
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
- Protected Attributes inherited from OdBcf::OdBcfComponentData
OdString m_ifcGuid
 
OdString m_originatingSystem
 
OdString m_authoringToolId
 
friend OdBcfSession
 

Detailed Description

A class that contains Component data type.

Definition at line 54 of file BcfComponent.h.

Constructor & Destructor Documentation

◆ OdBcfComponent()

OdBcf::OdBcfComponent::OdBcfComponent ( )

Creates a new object with default parameters.

Member Function Documentation

◆ DECLARE_CONST_ACCESSORS() [1/3]

OdBcf::OdBcfComponent::DECLARE_CONST_ACCESSORS ( AuthoringToolId  ,
OdString  ,
m_authoringToolId   
)

◆ DECLARE_CONST_ACCESSORS() [2/3]

OdBcf::OdBcfComponent::DECLARE_CONST_ACCESSORS ( IfcGuid  ,
OdString  ,
m_ifcGuid   
)

◆ DECLARE_CONST_ACCESSORS() [3/3]

OdBcf::OdBcfComponent::DECLARE_CONST_ACCESSORS ( OriginatingSystem  ,
OdString  ,
m_originatingSystem   
)

◆ inFields()

virtual OdResult OdBcf::OdBcfComponent::inFields ( TiXmlElement *  pParent)
virtual

Reads XML data into ODA data structures.

Parameters
pParent[in] A pointer to parent element of the data structure.
Returns
Returns eOk if data was successfully read; otherwise, the method returns an appropriate error.

Implements OdBcf::OdBcfElement.

◆ ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfComponent::ODRX_DECLARE_MEMBERS ( OdBcfComponent  )

◆ operator=()

OdBcfComponent& OdBcf::OdBcfComponent::operator= ( const OdBcfComponentData val)
protected

◆ outFields()

virtual OdResult OdBcf::OdBcfComponent::outFields ( TiXmlElement *  pParent) const
virtual

Writes data into XML structures.

Parameters
pParent[in] A pointer to parent element of the data structure.
Returns
Returns eOk if data was successfully written; otherwise, the method returns an appropriate error.

Implements OdBcf::OdBcfElement.

◆ validate()

virtual bool OdBcf::OdBcfComponent::validate ( ) const
virtual

Checks if instance has all required fields initialized.

Returns
Returns true if all required fields are initialized; otherwise the method returns false.

Implements OdBcf::OdBcfElement.

Friends And Related Function Documentation

◆ OdBcfSession

friend class OdBcfSession
friend

Definition at line 95 of file BcfComponent.h.


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