OdBcf::OdBcfLine Class Reference

#include <BcfLine.h>

Inheritance diagram for OdBcf::OdBcfLine:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfLine)
virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE
virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
virtual bool	validate () const ODRX_OVERRIDE
const OdBcfPointPtr &	getStartPoint () const
bool	isStartPointUnset () const
const OdBcfPointPtr &	getEndPoint () const
bool	isEndPointUnset () 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< OdBcfLine >	createObject (const OdBcfPointPtr &pStartPoint, const OdBcfPointPtr &pEndPoint)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Protected Attributes
OdBcfPointPtr	m_pStartPoint
OdBcfPointPtr	m_pEndPoint

Detailed Description

A class that stores and operates a markup line data within the BCF format.

Definition at line 42 of file BcfLine.h.

Member Function Documentation

createObject()

static OdSmartPtr< OdBcfLine > OdBcf::OdBcfLine::createObject ( const OdBcfPointPtr &  pStartPoint, const OdBcfPointPtr &  pEndPoint  )

static

Creates a new markup line object.

Parameters

pStartPoint	[in] A pointer to start point of the markup line.
pEndPoint	[in] A pointer to end point of the markup line.

Returns

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

getEndPoint()

const OdBcfPointPtr & OdBcf::OdBcfLine::getEndPoint

(

)

const

Retrieves the endpoint of the line.

Returns

A smart pointer to the <link OdBcf::OdBcfPoint, OdBcfPoint> object that represents the end point.

Remarks

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

getStartPoint()

const OdBcfPointPtr & OdBcf::OdBcfLine::getStartPoint

(

)

const

Retrieves the start point of the line.

Returns

A smart pointer to the <link OdBcf::OdBcfPoint, OdBcfPoint> object that represents the start point.

Remarks

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

inFields()

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

isEndPointUnset()

bool OdBcf::OdBcfLine::isEndPointUnset

(

)

const

Defines whether the object that represents the line end point is not initialized.

Returns

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

isStartPointUnset()

bool OdBcf::OdBcfLine::isStartPointUnset

(

)

const

Defines whether the object that represents the line start point is not initialized.

Returns

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

ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfLine::ODRX_DECLARE_MEMBERS

(

OdBcfLine

)

outFields()

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

virtual

Checks whether the line 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_pEndPoint

OdBcfPointPtr OdBcf::OdBcfLine::m_pEndPoint

protected

Definition at line 112 of file BcfLine.h.

m_pStartPoint

OdBcfPointPtr OdBcf::OdBcfLine::m_pStartPoint

protected

Definition at line 111 of file BcfLine.h.

---

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

• BcfLine.h