OdBcf::OdBcfDirection Class Reference

#include <BcfDirection.h>

Inheritance diagram for OdBcf::OdBcfDirection:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfDirection)
	OdBcfDirection ()
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< OdBcfDirection >	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 stores and operates a direction data.

Definition at line 39 of file BcfDirection.h.

Constructor & Destructor Documentation

OdBcfDirection()

OdBcf::OdBcfDirection::OdBcfDirection

(

)

Creates a new direction object with default parameters.

Remarks

The direction object's components are unset after using this constructor for instance creation.

Member Function Documentation

createObject()

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

static

Creates a new direction object.

Parameters

x	[in] A x-component of the direction object.
y	[in] A y-component of the direction object.
z	[in] A z-component of the direction object.

Returns

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

getX()

const double & OdBcf::OdBcfDirection::getX

(

)

const

Retrieves the X-axis coordinate of the direction object.

Returns

A double value that represents the X-axis coordinate.

Remarks

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

getY()

const double & OdBcf::OdBcfDirection::getY

(

)

const

Retrieves the Y-axis coordinate of the direction object.

Returns

A double value that represents the Y-axis coordinate.

Remarks

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

getZ()

const double & OdBcf::OdBcfDirection::getZ

(

)

const

Retrieves the Z-axis coordinate of the direction object.

Returns

A double value that represents the Z-axis coordinate.

Remarks

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

inFields()

virtual OdResult OdBcf::OdBcfDirection::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::OdBcfDirection::isXUnset

(

)

const

Defines whether the X-axis coordinate of the direction object is not initialized.

Returns

true if the X-axis coordinate is not initialized; otherwise, the method returns false.

isYUnset()

bool OdBcf::OdBcfDirection::isYUnset

(

)

const

Defines whether the Y-axis coordinate of the direction object is not initialized.

Returns

true if the Y-axis coordinate is not initialized; otherwise, the method returns false.

isZUnset()

bool OdBcf::OdBcfDirection::isZUnset

(

)

const

Defines whether the Z-axis coordinate of the direction object is not initialized.

Returns

true if the Z-axis coordinate is not initialized; otherwise, the method returns false.

ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfDirection::ODRX_DECLARE_MEMBERS

(

OdBcfDirection

)

outFields()

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

virtual

Checks whether the direction 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::OdBcfDirection::m_x

protected

Definition at line 128 of file BcfDirection.h.

m_y

double OdBcf::OdBcfDirection::m_y

protected

Definition at line 129 of file BcfDirection.h.

m_z

double OdBcf::OdBcfDirection::m_z

protected

Definition at line 130 of file BcfDirection.h.

---

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

• BcfDirection.h