OdBcf::OdBcfLines Class Reference

#include <BcfLines.h>

Inheritance diagram for OdBcf::OdBcfLines:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfLines)
virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE
virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
virtual bool	validate () const ODRX_OVERRIDE
const OdBcfLineArray &	getLine () const
bool	isLineUnset () 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< OdBcfLines >	createObject (const OdBcfLineArray &line)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Protected Attributes
OdBcfLineArray	m_line

Detailed Description

A class that stores and operates data about markup lines within the BCF format.

Definition at line 48 of file BcfLines.h.

Member Function Documentation

createObject()

static OdSmartPtr< OdBcfLines > OdBcf::OdBcfLines::createObject ( const OdBcfLineArray &  line )

static

Creates a new markup lines object.

Parameters

line	[in] An array of smart pointers to line objects.

Returns

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

getLine()

const OdBcfLineArray & OdBcf::OdBcfLines::getLine

(

)

const

Retrieves the array of lines, which are included in the markup lines object.

Returns

An array of smart pointers to <link OdBcf::OdBcfLine, OdBcfLine> objects included in the markup lines object.

Remarks

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

inFields()

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

isLineUnset()

bool OdBcf::OdBcfLines::isLineUnset

(

)

const

Defines whether the array of lines, which are included in the markup lines object is not initialized.

Returns

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

ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfLines::ODRX_DECLARE_MEMBERS

(

OdBcfLines

)

outFields()

virtual OdResult OdBcf::OdBcfLines::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::OdBcfLines::validate ( ) const

virtual

Checks whether the lines 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_line

OdBcfLineArray OdBcf::OdBcfLines::m_line

protected

Definition at line 100 of file BcfLines.h.

---

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

• BcfLines.h