#include <BcfPoint.h>

Inheritance diagram for OdBcf::OdBcfPoint:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfPoint)

	OdBcfPoint ()

virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE

virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE

virtual bool	validate () const ODRX_OVERRIDE

const double &	getX () const

bool	isXUnset () const

const double &	getY () const

bool	isYUnset () const

const double &	getZ () const

bool	isZUnset () 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< OdBcfPoint >	createObject (double x, double y, double z)

Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Protected Attributes
double	m_x

double	m_y

double	m_z

Detailed Description

A class that represents a point object within the BCF format.

Definition at line 39 of file BcfPoint.h.

Constructor & Destructor Documentation

◆ OdBcfPoint()

OdBcf::OdBcfPoint::OdBcfPoint ( )

Creates a new point object with default parameters.

Member Function Documentation

◆ createObject()

static OdSmartPtr< OdBcfPoint > OdBcf::OdBcfPoint::createObject	(	double	x,
		double	y,
		double	z
	)

static

Creates a new point object.

Parameters

x	[in] A point coordinate along the X-axis.
y	[in] A point coordinate along the Y-axis.
z	[in] A point coordinate along the Z-axis.

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

◆ getX()

const double & OdBcf::OdBcfPoint::getX ( ) const

Retrieves the X-axis coordinate of the point.

Returns: A double value that contains the X-axis coordinate of the point.

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

◆ getY()

const double & OdBcf::OdBcfPoint::getY ( ) const

Retrieves the Y-axis coordinate of the point.

Returns: A double value that contains the Y-axis coordinate of the point.

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

◆ getZ()

const double & OdBcf::OdBcfPoint::getZ ( ) const

Retrieves the Z-axis coordinate of the point.

Returns: A double value that contains the Z-axis coordinate of the point.

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

◆ inFields()

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

◆ isXUnset()

bool OdBcf::OdBcfPoint::isXUnset ( ) const

Defines whether the X-axis coordinate value is not initialized.

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

◆ isYUnset()

bool OdBcf::OdBcfPoint::isYUnset ( ) const

Defines whether the Y-axis coordinate value is not initialized.

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

◆ isZUnset()

bool OdBcf::OdBcfPoint::isZUnset ( ) const

Defines whether the Z-axis coordinate value is not initialized.

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

◆ ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfPoint::ODRX_DECLARE_MEMBERS ( OdBcfPoint )

◆ outFields()

virtual OdResult OdBcf::OdBcfPoint::outFields ( TiXmlElement * pParent ) const

virtual

Writes data into XML structures.

Parameters

pParent [in] A pointer to the parent element of the data structure.

Returns: Returns eOk if data was successfully written; otherwise, the method returns an appropriate error code.

Implements OdBcf::OdBcfElement.

◆ validate()

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

virtual

Checks whether 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_x

double OdBcf::OdBcfPoint::m_x

protected

The X-axis coordinate of the point.

Definition at line 127 of file BcfPoint.h.

◆ m_y

double OdBcf::OdBcfPoint::m_y

protected

The Y-axis coordinate of the point.

Definition at line 129 of file BcfPoint.h.

◆ m_z

double OdBcf::OdBcfPoint::m_z

protected

The Z-axis coordinate of the point.

Definition at line 131 of file BcfPoint.h.

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

BcfPoint.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OdBcfPoint()

Member Function Documentation

◆ createObject()

◆ getX()

◆ getY()

◆ getZ()

◆ inFields()

◆ isXUnset()

◆ isYUnset()

◆ isZUnset()

◆ ODRX_DECLARE_MEMBERS()

◆ outFields()

◆ validate()

Member Data Documentation

◆ m_x

◆ m_y

◆ m_z