#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

void	setHeader (const OdBcfHeaderPtr &headerValue)

OdBcfHeaderPtr &	getHeader ()

const OdBcfHeaderPtr &	getHeader () const

bool	isHeaderUnset () const

void	setTopic (const OdBcfTopicPtr &topicValue)

OdBcfTopicPtr &	getTopic ()

const OdBcfTopicPtr &	getTopic () const

bool	isTopicUnset () const

void	setComment (const OdBcfCommentArray &commentValue)

OdBcfCommentArray &	getComment ()

const OdBcfCommentArray &	getComment () const

bool	isCommentUnset () const

void	setViewpoints (const OdBcfViewPointArray &viewpointsValue)

OdBcfViewPointArray &	getViewpoints ()

const OdBcfViewPointArray &	getViewpoints () const

bool	isViewpointsUnset () 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 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 stores and operates a markup data within the BCF format.

Definition at line 58 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 smart pointer to the topic of the markup.
pHeader	[in] A smart pointer to the header of the markup.
comment	[in] An array of smart pointers to comments assigned with the markup.
viewpoints	[in] An array of smart pointers to viewpoints assigned with the markup.

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

◆ getComment() [1/2]

OdBcfCommentArray & OdBcf::OdBcfMarkup::getComment ( )

Retrieves the comment of the markup instance.

Returns: A smart pointer to the <link OdBcf::OdBcfComment, OdBcfComment> object.

Remarks: The comment object returned by the method can be modified in the calling subroutine.

◆ getComment() [2/2]

const OdBcfCommentArray & OdBcf::OdBcfMarkup::getComment ( ) const

Retrieves the comment of the markup instance.

Returns: A smart pointer to the <link OdBcf::OdBcfComment, OdBcfComment> object.

Remarks: The comment object returned by the method can't be modified in the calling subroutine.

◆ getHeader() [1/2]

OdBcfHeaderPtr & OdBcf::OdBcfMarkup::getHeader ( )

Retrieves the header object of the markup instance.

Returns: A smart pointer to the <link OdBcf::OdBcfHeader, OdBcfHeader> object.

Remarks: The header object returned by the method can be modified in the calling subroutine.

◆ getHeader() [2/2]

const OdBcfHeaderPtr & OdBcf::OdBcfMarkup::getHeader ( ) const

Retrieves the header object of the markup instance.

Returns: A smart pointer to the <link OdBcf::OdBcfHeader, OdBcfHeader> object.

Remarks: The header object returned by the method can't be modified in the calling subroutine.

◆ getTopic() [1/2]

OdBcfTopicPtr & OdBcf::OdBcfMarkup::getTopic ( )

Retrieves the topic object of the markup instance.

Returns: A smart pointer to the <link OdBcf::OdBcfTopic, OdBcfTopic> object.

Remarks: The topic object returned by the method can be modified in the calling subroutine.

◆ getTopic() [2/2]

const OdBcfTopicPtr & OdBcf::OdBcfMarkup::getTopic ( ) const

Retrieves the topic object of the markup instance.

Returns: A smart pointer to the <link OdBcf::OdBcfTopic, OdBcfTopic> object.

Remarks: The topic object returned by the method can't be modified in the calling subroutine.

◆ getViewpoints() [1/2]

OdBcfViewPointArray & OdBcf::OdBcfMarkup::getViewpoints ( )

Retrieves the viewpoints of the markup instance.

Returns: An array of smart pointers to <link OdBcf::OdBcfViewPoint, OdBcfViewPoint> objects.

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

◆ getViewpoints() [2/2]

const OdBcfViewPointArray & OdBcf::OdBcfMarkup::getViewpoints ( ) const

Retrieves the viewpoints of the markup instance.

Returns: An array of smart pointers to <link OdBcf::OdBcfViewPoint, OdBcfViewPoint> objects.

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

◆ inFields()

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

◆ isCommentUnset()

bool OdBcf::OdBcfMarkup::isCommentUnset ( ) const

Defines whether the markup comment is not initialized.

Returns: true if the comment is not initialized; otherwise, the method returns false.

◆ isHeaderUnset()

bool OdBcf::OdBcfMarkup::isHeaderUnset ( ) const

Defines whether the markup header object is not initialized.

Returns: true if the header object is not initialized; otherwise, the method returns false.

◆ isTopicUnset()

bool OdBcf::OdBcfMarkup::isTopicUnset ( ) const

Defines whether the markup topic object is not initialized.

Returns: true if the topic object is not initialized; otherwise, the method returns false.

◆ isViewpointsUnset()

bool OdBcf::OdBcfMarkup::isViewpointsUnset ( ) const

Defines whether the array of markup viewpoints is not initialized.

Returns: true if the viewpoints array is not initialized; otherwise, the method returns false.

◆ 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 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.

◆ setComment()

void OdBcf::OdBcfMarkup::setComment ( const OdBcfCommentArray & commentValue )

Sets the markup's comment.

Parameters

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

◆ setHeader()

void OdBcf::OdBcfMarkup::setHeader ( const OdBcfHeaderPtr & headerValue )

Sets the header object for the markup instance.

Parameters

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

◆ setTopic()

void OdBcf::OdBcfMarkup::setTopic ( const OdBcfTopicPtr & topicValue )

Sets the markup's topic.

Parameters

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

◆ setViewpoints()

void OdBcf::OdBcfMarkup::setViewpoints ( const OdBcfViewPointArray & viewpointsValue )

Sets the markup's viewpoints.

Parameters

viewpointsValue [in] An array of smart pointers to <link OdBcf::OdBcfViewPoint, OdBcfViewPoint> objects to be set.

◆ validate()

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

virtual

Checks whether the markup 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_comment

OdBcfCommentArray OdBcf::OdBcfMarkup::m_comment

protected

Definition at line 217 of file BcfMarkup.h.

◆ m_pHeader

OdBcfHeaderPtr OdBcf::OdBcfMarkup::m_pHeader

protected

Definition at line 215 of file BcfMarkup.h.

◆ m_pTopic

OdBcfTopicPtr OdBcf::OdBcfMarkup::m_pTopic

protected

Definition at line 216 of file BcfMarkup.h.

◆ m_viewpoints

OdBcfViewPointArray OdBcf::OdBcfMarkup::m_viewpoints

protected

Definition at line 218 of file BcfMarkup.h.

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

BcfMarkup.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ createObject()

◆ getComment() [1/2]

◆ getComment() [2/2]

◆ getHeader() [1/2]

◆ getHeader() [2/2]

◆ getTopic() [1/2]

◆ getTopic() [2/2]

◆ getViewpoints() [1/2]

◆ getViewpoints() [2/2]

◆ inFields()

◆ isCommentUnset()

◆ isHeaderUnset()

◆ isTopicUnset()

◆ isViewpointsUnset()

◆ ODRX_DECLARE_MEMBERS()

◆ outFields()

◆ setComment()

◆ setHeader()

◆ setTopic()

◆ setViewpoints()

◆ validate()

Member Data Documentation

◆ m_comment

◆ m_pHeader

◆ m_pTopic

◆ m_viewpoints