rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Charts Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvSimpleChartTransformer Class Reference

Class defining a transformation made of a logarithmic transformation to be applied to a coordinate. More...

#include <ilviews/charts/common.h>

Inheritance diagram for IlvSimpleChartTransformer:
IlvChartCoordinateTransformer IlvCoordinateTransformer

List of all members.

Public Member Functions

 IlvSimpleChartTransformer (IlUInt logBase=0)
 Constructor.
virtual void applyElementaryTransfo (IlDouble &val) const
 Applies the elementary transformation to a value.
virtual void applyInverseElementaryTransfo (IlDouble &val) const
 Applies the inverse of the elementary transformation to a value.
virtual IlBoolean condToApplyElementaryTransfo () const
 Indicates whether the elementary transformation can be applied.
virtual IlBoolean condToApplyInverseElementaryTransfo () const
 Indicates whether the inverse of the elementary transformation can be applied.

Detailed Description

Class defining a transformation made of a logarithmic transformation to be applied to a coordinate.

Library: ilvcharts

This class is a subclass of IlvChartCoordinateTransformer with an identity transformation as the elementary transformation. This means that no transformation is applied to the coordinate or that only a logarithmic transformation is applied if the logarithmic base is greater than 1.

See also:
IlvChartCoordinateTransformer.

Constructor & Destructor Documentation

IlvSimpleChartTransformer::IlvSimpleChartTransformer ( IlUInt  logBase = 0  ) 

Constructor.

Initializes a new IlvSimpleChartTransformer object.

Parameters:
logBase The logarithmic base set for the current object.

Member Function Documentation

virtual void IlvSimpleChartTransformer::applyElementaryTransfo ( IlDouble val  )  const [virtual]

Applies the elementary transformation to a value.

Parameters:
val This parameter stores the value to transform and is also used to return the transformed value.
Warning:
[note] Nothing is done in the case of the IlvSimpleChartTransformer class: the value stored in val is not modified since the elementary transformation is the identity.

Implements IlvChartCoordinateTransformer.

virtual void IlvSimpleChartTransformer::applyInverseElementaryTransfo ( IlDouble val  )  const [virtual]

Applies the inverse of the elementary transformation to a value.

Parameters:
val This parameter stores the value to transform inversely and is also used to return the value once it has been inversely transformed.
Warning:
[note] Nothing is done in the case of the IlvSimpleChartTransformer class: the value stored in val is not modified since the elementary transformation is the identity.

Implements IlvChartCoordinateTransformer.

virtual IlBoolean IlvSimpleChartTransformer::condToApplyElementaryTransfo (  )  const [virtual]

Indicates whether the elementary transformation can be applied.

Returns:
IlTrue by default, since the elementary transformation is the identity and, therefore, can always be applied.

Implements IlvChartCoordinateTransformer.

virtual IlBoolean IlvSimpleChartTransformer::condToApplyInverseElementaryTransfo (  )  const [virtual]

Indicates whether the inverse of the elementary transformation can be applied.

Returns:
IlTrue by default, since the elementary transformation is the identity and, therefore, the inverse of this transformation can always be applied.

Implements IlvChartCoordinateTransformer.


© 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.