rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Charts Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvLogScaleStepsUpdater Class Reference

Class for computing the graduations of a scale. More...

#include <ilviews/charts/scaledis.h>

Inheritance diagram for IlvLogScaleStepsUpdater:
IlvScaleStepsUpdater IlvNamedProperty

List of all members.

Public Member Functions

 IlvLogScaleStepsUpdater (IlvSingleScaleDisplayer *scale)
 Constructor.
virtual IlBoolean checkRange (IlvCoordInterval &range) const
 Checks whether an interval is valid with respect to the step definition.
virtual char * computeStepLabel (IlDouble value) const
 Computes and returns the label displayed for a given data value.
virtual void getStepSubStepValues (const IlvProjectorArea &area, IlUInt &stepsCount, IlDouble *&stepValues, IlUInt &subStepsCount, IlDouble *&subStepValues) const
 Computes and returns the step and substep values for the associated scale.

Detailed Description

Class for computing the graduations of a scale.

Library: ilvcharts

IlvLogScaleStepsUpdater is a subclass of IlvScaleStepsUpdater that computes logarithmic graduations.

Warning:
This class must be used to compute the steps for a given scale only when a logarithmic transformation is set on the coordinate represented by the scale.
See also:
IlvScaleStepsUpdater, IlvSingleScaleDisplayer.

Constructor & Destructor Documentation

IlvLogScaleStepsUpdater::IlvLogScaleStepsUpdater ( IlvSingleScaleDisplayer scale  ) 

Constructor.

Initializes a new IlvLogScaleStepsUpdater object.


Member Function Documentation

virtual IlBoolean IlvLogScaleStepsUpdater::checkRange ( IlvCoordInterval range  )  const [virtual]

Checks whether an interval is valid with respect to the step definition.

Called whenever the range of the coordinate associated with the current scale is modified. With this method, you can modify the interval range so that it becomes consistent with the steps definition. The default implementation simply returns IlTrue.

Parameters:
range The range to check.
Returns:
IlFalse if the range was not correct and had to be modified, and IlTrue otherwise.

Reimplemented from IlvScaleStepsUpdater.

virtual char* IlvLogScaleStepsUpdater::computeStepLabel ( IlDouble  value  )  const [virtual]

Computes and returns the label displayed for a given data value.

Parameters:
value The data value for which the label to be displayed is computed.

Reimplemented from IlvScaleStepsUpdater.

virtual void IlvLogScaleStepsUpdater::getStepSubStepValues ( const IlvProjectorArea &  area,
IlUInt stepsCount,
IlDouble *&  stepValues,
IlUInt subStepsCount,
IlDouble *&  subStepValues 
) const [virtual]

Computes and returns the step and substep values for the associated scale.

Parameters:
area The data area definition. This data area definition can be retrieved with the IlvChartGraphic::getProjectorArea method.
stepsCount Returns the number of major steps.
stepValues Returns the values associated with the major steps.
subStepsCount Returns the number of minor steps.
subStepValues Returns the values associated with the minor steps.

Implements IlvScaleStepsUpdater.


© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.