CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
OdBcf::OdBcfExceptions Class Reference

#include <BcfExceptions.h>

Inheritance diagram for OdBcf::OdBcfExceptions:
OdBcf::OdBcfElement OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdBcfExceptions)
 
virtual OdResult inFields (TiXmlElement *pParent) ODRX_OVERRIDE
 
virtual OdResult outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
 
virtual bool validate () const ODRX_OVERRIDE
 
const OdBcfComponentArraygetComponent () const
 
bool isComponentUnset () const
 
- Public Member Functions inherited from OdBcf::OdBcfElement
 ODRX_DECLARE_MEMBERS (OdBcfElement)
 
virtual OdResult inFields (TiXmlElement *pParent)=0
 
virtual OdResult outFields (TiXmlElement *pParent) const =0
 
virtual bool validate () const =0
 
- 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 Protected Member Functions

static OdSmartPtr< OdBcfExceptionscreateObject (const OdBcfComponentArray &component)
 

Protected Attributes

OdBcfComponentArray m_component
 
friend OdBcfSession
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

A class that stores and operates BCF exceptions data.

Definition at line 46 of file BcfExceptions.h.

Member Function Documentation

◆ createObject()

static OdSmartPtr< OdBcfExceptions > OdBcf::OdBcfExceptions::createObject ( const OdBcfComponentArray component)
staticprotected

◆ getComponent()

const OdBcfComponentArray & OdBcf::OdBcfExceptions::getComponent ( ) const

Retrieves the array of components associated with the exceptions.

Returns
An array of smart pointers to <link OdBcf::OdBcfComponent, OdBcfComponent> objects.
Remarks
The array of components returned by the method can't be modified in the calling subroutine.

◆ inFields()

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

Reads XML data into ODA data structures.

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

Implements OdBcf::OdBcfElement.

◆ isComponentUnset()

bool OdBcf::OdBcfExceptions::isComponentUnset ( ) const

Defines whether the array of components associated with the exceptions is not initialized.

Returns
true if the array of components is not initialized; otherwise, the method returns false.

◆ ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfExceptions::ODRX_DECLARE_MEMBERS ( OdBcfExceptions  )

◆ outFields()

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

Writes data into XML structures.

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

Implements OdBcf::OdBcfElement.

◆ validate()

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

Checks whether the exception instance has all required fields initialized.

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

Implements OdBcf::OdBcfElement.

Member Data Documentation

◆ m_component

OdBcfComponentArray OdBcf::OdBcfExceptions::m_component
protected

Definition at line 91 of file BcfExceptions.h.

◆ OdBcfSession

friend OdBcf::OdBcfExceptions::OdBcfSession
protected

Definition at line 95 of file BcfExceptions.h.


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