CFx SDK Documentation  2022 SP0
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
OdBcf::OdBcfHeader Class Reference

#include <BcfHeader.h>

Inheritance diagram for OdBcf::OdBcfHeader:
OdBcf::OdBcfElement OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdBcfHeader)
 
virtual OdResult inFields (TiXmlElement *pParent) ODRX_OVERRIDE
 
virtual OdResult outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
 
virtual bool validate () const ODRX_OVERRIDE
 
 DECLARE_ACCESSORS (File, OdBcfFileArray, m_file)
 
- 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
 

Static Public Member Functions

static OdSmartPtr< OdBcfHeadercreateObject (const OdBcfFileArray &file)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Protected Attributes

OdBcfFileArray m_file
 

Detailed Description

A class that contains Header data type.

Definition at line 44 of file BcfHeader.h.

Member Function Documentation

◆ createObject()

static OdSmartPtr<OdBcfHeader> OdBcf::OdBcfHeader::createObject ( const OdBcfFileArray file)
static

Creates a new header object.

Parameters
comment[in] An array of files of markup.
Returns
Returns a smart pointer to the created <link OdBcf::OdBcfHeader, OdBcfHeader> instance.

◆ DECLARE_ACCESSORS()

OdBcf::OdBcfHeader::DECLARE_ACCESSORS ( File  ,
OdBcfFileArray  ,
m_file   
)

◆ inFields()

virtual OdResult OdBcf::OdBcfHeader::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::OdBcfHeader::ODRX_DECLARE_MEMBERS ( OdBcfHeader  )

◆ outFields()

virtual OdResult OdBcf::OdBcfHeader::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::OdBcfHeader::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.

Member Data Documentation

◆ m_file

OdBcfFileArray OdBcf::OdBcfHeader::m_file
protected

Definition at line 83 of file BcfHeader.h.


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