ATE::IArrayLine Class Reference

Provides access to an ordered collection of line objects where each entry is the start and end point of a 2D line. More...

#include <IText.h>

List of all members.

Public Member Functions
	IArrayLine ()
	Constructor.
	IArrayLine (const IArrayLine &src)
	Copy constructor.
IArrayLine &	operator= (const IArrayLine &rhs)
	Assignment operator.
bool	operator== (const IArrayLine &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IArrayLine &rhs) const
	Comparison operator tests for inequality.
	IArrayLine (ArrayLineRef ArrayLineRef)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IArrayLine ()
	Destructor.
ArrayLineRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
ATETextDOM::Int32	GetSize () const
	Retrieves the number of members of this set.
void	Item (ATETextDOM::Int32 index, ATETextDOM::FloatPoint *lineStart, ATETextDOM::FloatPoint *lineEnd) const
	Retrieves the line start and end points of a 2Dline in this set by position index.

---

Detailed Description

Provides access to an ordered collection of line objects where each entry is the start and end point of a 2D line.

---

Constructor & Destructor Documentation

ATE::IArrayLine::IArrayLine

(

)

Constructor.

Returns:

The new object.

ATE::IArrayLine::IArrayLine

(

const IArrayLine &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sArrayLine.

ATE::IArrayLine::IArrayLine

(

ArrayLineRef

ArrayLineRef

)

[explicit]

Constructs this C++ object from the corresponding C object returned by an ATE suite function.

The C++ object manages reference counting.

Parameters:

ArrayLineRef

The C object.

Returns:

The new C++ object.

ATE::IArrayLine::~IArrayLine

(

)

[virtual]

Destructor.

References ATE::sArrayLine.

---

Member Function Documentation

ArrayLineRef ATE::IArrayLine::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

ATETextDOM::Int32 ATE::IArrayLine::GetSize

(

)

const

Retrieves the number of members of this set.

Returns:

The number of members.

References ATE::sArrayLine, and ATE::Throw_ATE_Exception().

bool ATE::IArrayLine::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sArrayLine.

void ATE::IArrayLine::Item	(	ATETextDOM::Int32	index,
		ATETextDOM::FloatPoint *	lineStart,
		ATETextDOM::FloatPoint *	lineEnd
	)			const

Retrieves the line start and end points of a 2Dline in this set by position index.

Use with GetSize() to iterate through members.

Parameters:

	index	The 0-based position index.
	lineStart	[out] the ATETextDOM::RealPoint object defining the start of the line.
	lineEnd	[out] the ATETextDOM::RealPoint object defining the end of the line.

Returns:

Nothing.

References ATE::sArrayLine, ATE::SloFloatPointToAIFloatPoint(), and ATE::Throw_ATE_Exception().

bool ATE::IArrayLine::operator!=

(

const IArrayLine &

rhs

)

const

Comparison operator tests for inequality.

Parameters:

rhs

The object to compare to this one.

Returns:

True if the two objects are not the same.

IArrayLine & ATE::IArrayLine::operator=

(

const IArrayLine &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sArrayLine.

bool ATE::IArrayLine::operator==

(

const IArrayLine &

rhs

)

const

Comparison operator tests for equality.

Parameters:

rhs

The object to compare to this one.

Returns:

True if the two objects are the same.

---

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

• IText.h
• IText.cpp