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

#include <BcfTopicFolder.h>

Inheritance diagram for OdBcf::OdBcfTopicFolder:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdBcfTopicFolder)
 
virtual bool validate () const
 
 DECLARE_ACCESSORS (Markup, OdBcfMarkupPtr, m_pMarkup)
 
 DECLARE_ACCESSORS (VisualizationInfo, OdBcfVisualizationInfoArray, m_visualizationInfo)
 
- 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< OdBcfTopicFoldercreateObject (const OdBcfMarkupPtr &pMarkup, const OdBcfVisualizationInfoArray &visualizationInfo)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Protected Attributes

OdBcfMarkupPtr m_pMarkup
 
OdBcfVisualizationInfoArray m_visualizationInfo
 

Detailed Description

A class that provides functionality for working with topic folder.

Definition at line 48 of file BcfTopicFolder.h.

Member Function Documentation

◆ createObject()

static OdSmartPtr<OdBcfTopicFolder> OdBcf::OdBcfTopicFolder::createObject ( const OdBcfMarkupPtr pMarkup,
const OdBcfVisualizationInfoArray visualizationInfo 
)
static

Creates a new topic folder object.

Parameters
pMarkup[in] A pointer to markup of topic.
pVisualizationInfo[in] A pointer to visualization information of topic.
Returns
Returns a smart pointer to the created <link OdBcf::OdBcfTopicFolder, OdBcfTopicFolder> instance.

◆ DECLARE_ACCESSORS() [1/2]

OdBcf::OdBcfTopicFolder::DECLARE_ACCESSORS ( Markup  ,
OdBcfMarkupPtr  ,
m_pMarkup   
)

◆ DECLARE_ACCESSORS() [2/2]

OdBcf::OdBcfTopicFolder::DECLARE_ACCESSORS ( VisualizationInfo  ,
OdBcfVisualizationInfoArray  ,
m_visualizationInfo   
)

◆ ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfTopicFolder::ODRX_DECLARE_MEMBERS ( OdBcfTopicFolder  )

◆ validate()

virtual bool OdBcf::OdBcfTopicFolder::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.

Member Data Documentation

◆ m_pMarkup

OdBcfMarkupPtr OdBcf::OdBcfTopicFolder::m_pMarkup
protected

Definition at line 77 of file BcfTopicFolder.h.

◆ m_visualizationInfo

OdBcfVisualizationInfoArray OdBcf::OdBcfTopicFolder::m_visualizationInfo
protected

Definition at line 78 of file BcfTopicFolder.h.


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