OdBcf::OdBcfTopicFolder Class Reference

#include <BcfTopicFolder.h>

Inheritance diagram for OdBcf::OdBcfTopicFolder:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfTopicFolder)
virtual bool	validate () const
void	setMarkup (const OdBcfMarkupPtr &markupValue)
OdBcfMarkupPtr &	getMarkup ()
const OdBcfMarkupPtr &	getMarkup () const
bool	isMarkupUnset () const
void	setVisualizationInfo (const OdBcfVisualizationInfoArray &visualizationInfoValue)
OdBcfVisualizationInfoArray &	getVisualizationInfo ()
const OdBcfVisualizationInfoArray &	getVisualizationInfo () const
bool	isVisualizationInfoUnset () const
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () 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< OdBcfTopicFolder >	createObject (const OdBcfMarkupPtr &pMarkup, const OdBcfVisualizationInfoArray &visualizationInfo)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Protected Attributes
OdBcfMarkupPtr	m_pMarkup
OdBcfVisualizationInfoArray	m_visualizationInfo

Detailed Description

A class that provides functionality for working with a BCF topic folder.

Definition at line 52 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 smart pointer to the markup of the topic folder.
visualizationInfo	[in] An array of smart pointers to visualization information about topics.

Returns

A smart pointer to the created <link OdBcf::OdBcfTopicFolder, OdBcfTopicFolder> instance.

getMarkup() [1/2]

OdBcfMarkupPtr & OdBcf::OdBcfTopicFolder::getMarkup

(

)

Retrieves the topic folder's markup.

Returns

A smart pointer to the <link OdBcf::OdBcfMarkup, OdBcfMarkup> object that represents the markup.

Remarks

The markup object returned by the method can be modified in the calling subroutine.

getMarkup() [2/2]

const OdBcfMarkupPtr & OdBcf::OdBcfTopicFolder::getMarkup

(

)

const

Retrieves the topic folder's markup.

Returns

A smart pointer to the <link OdBcf::OdBcfMarkup, OdBcfMarkup> object that represents the markup.

Remarks

The markup object returned by the method can't be modified in the calling subroutine.

getVisualizationInfo() [1/2]

OdBcfVisualizationInfoArray & OdBcf::OdBcfTopicFolder::getVisualizationInfo

(

)

Retrieves the topic folder's visualization information.

Returns

An array of smart pointers to <link OdBcf::OdBcfVisualizationInfo, OdBcfVisualizationInfo> objects that represents the visualization information.

Remarks

The array returned by the method can be modified in the calling subroutine.

getVisualizationInfo() [2/2]

const OdBcfVisualizationInfoArray & OdBcf::OdBcfTopicFolder::getVisualizationInfo

(

)

const

Retrieves the topic folder's visualization information.

Returns

An array of smart pointers to <link OdBcf::OdBcfVisualizationInfo, OdBcfVisualizationInfo> objects that represents the visualization information.

Remarks

The array returned by the method can't be modified in the calling subroutine.

isMarkupUnset()

bool OdBcf::OdBcfTopicFolder::isMarkupUnset

(

)

const

Defines whether the topic folder's markup is not initialized.

Returns

true if the markup object is not initialized; otherwise, the method returns false.

isVisualizationInfoUnset()

bool OdBcf::OdBcfTopicFolder::isVisualizationInfoUnset

(

)

const

Defines whether the topic folder's visualization information is not initialized.

Returns

true if the visualization information is not initialized; otherwise, the method returns false.

ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfTopicFolder::ODRX_DECLARE_MEMBERS

(

OdBcfTopicFolder

)

setMarkup()

void OdBcf::OdBcfTopicFolder::setMarkup

(

const OdBcfMarkupPtr &

markupValue

)

Sets the markup for the topic folder object.

Parameters

markupValue

[in] A smart pointer to the <link OdBcf::OdBcfMarkup, OdBcfMarkup> object to be set.

setVisualizationInfo()

void OdBcf::OdBcfTopicFolder::setVisualizationInfo

(

const OdBcfVisualizationInfoArray &

visualizationInfoValue

)

Sets the visualization information for the topic folder object.

Parameters

visualizationInfoValue

[in] An array of smart pointers to <link OdBcf::OdBcfVisualizationInfo, OdBcfVisualizationInfo> objects that represents the visualizaion information to be set.

validate()

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

virtual

Checks whether the topic folder instance has all required fields initialized.

Returns

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

Member Data Documentation

m_pMarkup

OdBcfMarkupPtr OdBcf::OdBcfTopicFolder::m_pMarkup

protected

A smart pointer to the topic folder's <link OdBcf::OdBcfMarkup, markup> object.

Definition at line 136 of file BcfTopicFolder.h.

m_visualizationInfo

OdBcfVisualizationInfoArray OdBcf::OdBcfTopicFolder::m_visualizationInfo

protected

An array of smart pointers to <link OdBcf::OdBcfVisualizationInfo, OdBcfVisualizationInfo> objects that represents the topic folder's visualization information.

Definition at line 138 of file BcfTopicFolder.h.

---

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

• BcfTopicFolder.h