ATE::IArrayInteger Class Reference

Provides access to an ordered collection of integer values. More...

#include <IText.h>

List of all members.

Public Member Functions
	IArrayInteger ()
	Constructor.
	IArrayInteger (const IArrayInteger &src)
	Copy constructor.
IArrayInteger &	operator= (const IArrayInteger &rhs)
	Assignment operator.
bool	operator== (const IArrayInteger &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IArrayInteger &rhs) const
	Comparison operator tests for inequality.
	IArrayInteger (ArrayIntegerRef arrayinteger)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IArrayInteger ()
	Destructor.
ArrayIntegerRef	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.
ATETextDOM::Int32	GetFirst () const
	Retrieves the first member of this set.
ATETextDOM::Int32	GetLast () const
	Retrieves the last member of this set.
ATETextDOM::Int32	Item (ATETextDOM::Int32 index) const
	Retrieves a member of this set by position index.

---

Detailed Description

Provides access to an ordered collection of integer values.

---

Constructor & Destructor Documentation

ATE::IArrayInteger::IArrayInteger

(

)

Constructor.

Returns:

The new object.

ATE::IArrayInteger::IArrayInteger

(

const IArrayInteger &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sArrayInteger.

ATE::IArrayInteger::IArrayInteger

(

ArrayIntegerRef

arrayinteger

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

arrayinteger

The C object.

Returns:

The new C++ object.

ATE::IArrayInteger::~IArrayInteger

(

)

[virtual]

Destructor.

References ATE::sArrayInteger.

---

Member Function Documentation

ATETextDOM::Int32 ATE::IArrayInteger::GetFirst

(

)

const

Retrieves the first member of this set.

Returns:

The member value.

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

ATETextDOM::Int32 ATE::IArrayInteger::GetLast

(

)

const

Retrieves the last member of this set.

Returns:

The member value.

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

ArrayIntegerRef ATE::IArrayInteger::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

ATETextDOM::Int32 ATE::IArrayInteger::GetSize

(

)

const

Retrieves the number of members of this set.

Returns:

The number of members.

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

bool ATE::IArrayInteger::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sArrayInteger.

ATETextDOM::Int32 ATE::IArrayInteger::Item

(

ATETextDOM::Int32

index

)

const

Retrieves a member of this set by position index.

Use with GetSize() to iterate through members.

Parameters:

index

The 0-based position index.

Returns:

The member value.

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

bool ATE::IArrayInteger::operator!=

(

const IArrayInteger &

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.

IArrayInteger & ATE::IArrayInteger::operator=

(

const IArrayInteger &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sArrayInteger.

bool ATE::IArrayInteger::operator==

(

const IArrayInteger &

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