OdBcf::OdBcfMarkup Class Reference

#include <BcfMarkup.h>

Inheritance diagram for OdBcf::OdBcfMarkup:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfMarkup)
virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE
virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
virtual bool	validate () const ODRX_OVERRIDE
	DECLARE_ACCESSORS (Header, OdBcfHeaderPtr, m_pHeader)
	DECLARE_ACCESSORS (Topic, OdBcfTopicPtr, m_pTopic)
	DECLARE_ACCESSORS (Comment, OdBcfCommentArray, m_comment)
	DECLARE_ACCESSORS (Viewpoints, OdBcfViewPointArray, m_viewpoints)
Public Member Functions inherited from OdBcf::OdBcfElement
	ODRX_DECLARE_MEMBERS (OdBcfElement)
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< OdBcfMarkup >	createObject (const OdBcfTopicPtr &pTopic, const OdBcfHeaderPtr &pHeader=OdBcfHeaderPtr(), const OdBcfCommentArray &comment=OdBcfCommentArray(), const OdBcfViewPointArray &viewpoints=OdBcfViewPointArray())
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Protected Attributes
OdBcfHeaderPtr	m_pHeader
OdBcfTopicPtr	m_pTopic
OdBcfCommentArray	m_comment
OdBcfViewPointArray	m_viewpoints

Detailed Description

A class that contains Markup data type.

Definition at line 54 of file BcfMarkup.h.

Member Function Documentation

createObject()

static OdSmartPtr<OdBcfMarkup> OdBcf::OdBcfMarkup::createObject ( const OdBcfTopicPtr &  pTopic, const OdBcfHeaderPtr &  pHeader = OdBcfHeaderPtr(), const OdBcfCommentArray &  comment = OdBcfCommentArray(), const OdBcfViewPointArray &  viewpoints = OdBcfViewPointArray()  )

static

Creates a new markup object.

Parameters

pTopic	[in] A pointer to topic of markup.
pHeader	[in] A pointer to header of markup.
comment	[in] An array of comments of markup.
viewpoints	[in] An array of viewpoints of markup.

Returns

Returns a smart pointer to the created <link OdBcf::OdBcfMarkup, OdBcfMarkup> instance.

DECLARE_ACCESSORS() [1/4]

OdBcf::OdBcfMarkup::DECLARE_ACCESSORS	(	Comment	,
		OdBcfCommentArray	,
		m_comment
	)

DECLARE_ACCESSORS() [2/4]

OdBcf::OdBcfMarkup::DECLARE_ACCESSORS	(	Header	,
		OdBcfHeaderPtr	,
		m_pHeader
	)

DECLARE_ACCESSORS() [3/4]

OdBcf::OdBcfMarkup::DECLARE_ACCESSORS	(	Topic	,
		OdBcfTopicPtr	,
		m_pTopic
	)

DECLARE_ACCESSORS() [4/4]

OdBcf::OdBcfMarkup::DECLARE_ACCESSORS	(	Viewpoints	,
		OdBcfViewPointArray	,
		m_viewpoints
	)

inFields()

virtual OdResult OdBcf::OdBcfMarkup::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::OdBcfMarkup::ODRX_DECLARE_MEMBERS

(

OdBcfMarkup

)

outFields()

virtual OdResult OdBcf::OdBcfMarkup::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::OdBcfMarkup::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_comment

OdBcfCommentArray OdBcf::OdBcfMarkup::m_comment

protected

Definition at line 105 of file BcfMarkup.h.

m_pHeader

OdBcfHeaderPtr OdBcf::OdBcfMarkup::m_pHeader

protected

Definition at line 103 of file BcfMarkup.h.

m_pTopic

OdBcfTopicPtr OdBcf::OdBcfMarkup::m_pTopic

protected

Definition at line 104 of file BcfMarkup.h.

m_viewpoints

OdBcfViewPointArray OdBcf::OdBcfMarkup::m_viewpoints

protected

Definition at line 106 of file BcfMarkup.h.

---

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

• BcfMarkup.h