Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Search  

ValueRuns Class Reference

The ValueRuns class associates integer values with runs of text. More...

#include <RunArrays.h>

Inheritance diagram for ValueRuns::

RunArray UObject UMemory List of all members.

Public Methods

 ValueRuns (const le_int32 *values, const le_int32 *limits, le_int32 count)
 Construct a ValueRuns object from pre-existing arrays of values and limit indices. More...

 ValueRuns (le_int32 initialCapacity)
 Construct an empty ValueRuns object. More...

virtual ~ValueRuns ()
 The destructor; virtual so that subclass destructors are invoked as well. More...

le_int32 getValue (le_int32 run) const
 Get the integer value assoicated with the given run of text. More...

le_int32 add (le_int32 value, le_int32 limit)
 Add an integer value and limit index pair to the data arrays and return the run index where the data was stored. More...

virtual UClassID getDynamicClassID () const
 ICU "poor man's RTTI", returns a UClassID for the actual class. More...


Static Public Methods

UClassID getStaticClassID ()
 ICU "poor man's RTTI", returns a UClassID for this class. More...


Protected Methods

virtual void init (le_int32 capacity)
 Create a data array with the given initial size. More...

virtual void grow (le_int32 capacity)
 Grow a data array to the given initial size. More...


Private Methods

 ValueRuns ()
 ValueRuns (const ValueRuns &other)
ValueRuns & operator= (const ValueRuns &)

Private Attributes

const le_int32fValues

Static Private Attributes

const char fgClassID
 The address of this static class variable serves as this class's ID for ICU "poor man's RTTI". More...


Detailed Description

The ValueRuns class associates integer values with runs of text.

Draft:
This API has been introduced in ICU 2.6. It is still in draft state and may be modified in a future release.

Definition at line 514 of file RunArrays.h.


Constructor & Destructor Documentation

ValueRuns::ValueRuns const le_int32   values,
const le_int32   limits,
le_int32    count
[inline]
 

Construct a ValueRuns object from pre-existing arrays of values and limit indices.

Parameters:
values  is the address of an array of integer.
limits  is the address of an array of limit indices.
count  is the number of entries in the two arrays.
Draft:
This API has been introduced in ICU 2.6. It is still in draft state and may be modified in a future release.

Definition at line 635 of file RunArrays.h.

ValueRuns::ValueRuns le_int32    initialCapacity
 

Construct an empty ValueRuns object.

Clients can add value and limit indices arrays using the add method.

Parameters:
initialCapacity  is the initial size of the value and limit indices arrays. If this value is zero, no arrays will be allocated.
See also:
add
Draft:
This API has been introduced in ICU 2.6. It is still in draft state and may be modified in a future release.

virtual ValueRuns::~ValueRuns   [virtual]
 

The destructor; virtual so that subclass destructors are invoked as well.

Draft:
This API has been introduced in ICU 2.6. It is still in draft state and may be modified in a future release.

ValueRuns::ValueRuns   [inline, private]
 

Definition at line 623 of file RunArrays.h.

ValueRuns::ValueRuns const ValueRuns &    other [inline, private]
 

Definition at line 629 of file RunArrays.h.


Member Function Documentation

le_int32 ValueRuns::add le_int32    value,
le_int32    limit
 

Add an integer value and limit index pair to the data arrays and return the run index where the data was stored.

This method calls RunArray::add(limit) which will create or grow the arrays as needed.

If the ValueRuns object was created with a client-supplied font and limit indices arrays, this method will return a run index of -1.

Subclasses should not override this method. Rather they should provide a new add method which takes an integer value and a limit index along with whatever other data they implement. The new add method should first call this method to grow the font and limit indices arrays, and use the returned run index to store data their own arrays.

Parameters:
value  is the integer value to add
limit  is the limit index to add
Returns:
the run index where the value and limit index were stored, or -1 if the data cannot be stored.
Draft:
This API has been introduced in ICU 2.6. It is still in draft state and may be modified in a future release.

virtual UClassID ValueRuns::getDynamicClassID void    const [inline, virtual]
 

ICU "poor man's RTTI", returns a UClassID for the actual class.

Draft:
This API has been introduced in ICU 2.6. It is still in draft state and may be modified in a future release.

Reimplemented from RunArray.

Definition at line 595 of file RunArrays.h.

UClassID ValueRuns::getStaticClassID void    [inline, static]
 

ICU "poor man's RTTI", returns a UClassID for this class.

Draft:
This API has been introduced in ICU 2.6. It is still in draft state and may be modified in a future release.

Reimplemented from RunArray.

Definition at line 602 of file RunArrays.h.

le_int32 ValueRuns::getValue le_int32    run const
 

Get the integer value assoicated with the given run of text.

Use RunArray::getLimit(run) to get the corresponding limit index.

Parameters:
run  is the index into the font and limit indices arrays.
Returns:
the integer value associated with the given text run.
See also:
RunArray::getLimit
Draft:
This API has been introduced in ICU 2.6. It is still in draft state and may be modified in a future release.

virtual void ValueRuns::grow le_int32    capacity [protected, virtual]
 

Grow a data array to the given initial size.

This method will be called by the add method if the limit indices array is full. Subclasses which override this method must also call it from the overriding method to grow the limit indices array.

Parameters:
capacity  is the initial size of the data array.
See also:
add
Draft:
This API has been introduced in ICU 2.6. It is still in draft state and may be modified in a future release.

Reimplemented from RunArray.

virtual void ValueRuns::init le_int32    capacity [protected, virtual]
 

Create a data array with the given initial size.

This method will be called by the add method if there is no limit indices array. Subclasses which override this method must also call it from the overriding method to create the limit indices array.

Parameters:
capacity  is the initial size of the data array.
See also:
add
Draft:
This API has been introduced in ICU 2.6. It is still in draft state and may be modified in a future release.

Reimplemented from RunArray.

ValueRuns& ValueRuns::operator= const ValueRuns &    [inline, private]
 

Definition at line 612 of file RunArrays.h.


Member Data Documentation

const le_int32* ValueRuns::fValues [private]
 

Definition at line 620 of file RunArrays.h.

const char ValueRuns::fgClassID [static, private]
 

The address of this static class variable serves as this class's ID for ICU "poor man's RTTI".

Reimplemented from RunArray.

Definition at line 618 of file RunArrays.h.


The documentation for this class was generated from the following file:
Generated on Mon Nov 24 14:37:09 2003 for ICU 2.8 by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001