Base class for coordinate information storage. More...

#include <ilviews/charts/common.h>

Inheritance diagram for IlvCoordinateInfo:

Public Member Functions
	IlvCoordinateInfo (const IlvCoordinateInfo &coordinateInfo)
	Constructor. More...

	IlvCoordinateInfo (IlvCoordinateType coordinateType, IlDouble dataMin, IlDouble dataMax, IlvCoordinateTransformer *transfo=0)
	Constructor. More...

	IlvCoordinateInfo (IlvCoordinateType coordinateType, IlvCoordinateTransformer *transfo=0)
	Constructor. More...

	IlvCoordinateInfo (IlvInputFile &file)
	Constructor. More...

virtual	~IlvCoordinateInfo ()
	Destructor. More...

void	addListener (IlvCoordinateInfoListener *listener)
	Adds a listener. More...

virtual IlvCoordinateInfo *	copy () const
	Virtual copy constructor. More...

IlDouble	getAutoDataMax () const
	Returns the maximum value automatically computed from the considered data. More...

IlDouble	getAutoDataMin () const
	Returns the minimum value automatically computed from the considered data. More...

const IlvCoordInterval &	getAutoDataRange () const
	Returns the values interval automatically computed from the considered data. More...

IlvCoordinateType	getCoordinateType () const
	Returns the type of the corresponding coordinate. More...

IlDouble	getDataMax () const
	Returns the maximum value used to select the data to display. More...

IlDouble	getDataMin () const
	Returns the minimum value used to select the data to display. More...

const IlvCoordInterval &	getDataRange () const
	Returns the values interval used to select the data to display. More...

void	getFirstCycleRange (IlvCoordInterval &range) const
	Returns the interval of values that are not shifted by the cycle length. More...

IlvCoordinateInfoListener const	getListeners (IlUInt &count) const
	Returns all the listeners. More...

IlDouble	getMaxPosData () const
	Returns the value positioned at the maximum position of the associated scale. More...

IlDouble	getMinPosData () const
	Returns the value positioned at the minimum position of the associated scale. More...

void	getSecondCycleRange (IlvCoordInterval &range) const
	Returns the interval of values that are shifted by the cycle length. More...

IlvCoordinateTransformer *	getTransformer () const
	Returns the applied transformation. More...

IlDouble	getUserDataMax () const
	Returns the maximum value specified by the user. More...

IlDouble	getUserDataMin () const
	Returns the minimum value specified by the user. More...

const IlvCoordInterval &	getUserDataRange () const
	Returns the values interval specified by the user. More...

IlBoolean	isInCyclicMode () const
	Indicates whether the coordinate is in cyclic mode. More...

IlBoolean	isOnAbscissa () const
	Indicates whether the current object is associated with the abscissa. More...

IlBoolean	isOnOrdinate () const
	Indicates whether the current object is associated with the ordinate. More...

IlBoolean	isUsingAutoDataRange () const
	Indicates whether the automatically computed minimum and maximum values are used to select the data to display. More...

void	lock ()
	Locks the current `IlvCoordinateInfo` object. More...

IlvCoordinateInfoListener *	removeListener (IlvCoordinateInfoListener *l)
	Removes a listener. More...

void	removeListeners ()
	Removes all the listeners. More...

void	resetAutoDataRange ()
	Sets the minimum and maximum values automatically computed from the considered data to `0`. More...

void	resetDataRangeToAuto ()
	Resets the minimum and maximum values to the automatically computed values. More...

void	resetDataRangeToUser ()
	Resets the minimum and maximum values to the values specified by the user. More...

IlvOutputFile &	save (IlvOutputFile &file) const
	Writes a complete description of the current object in a file. More...

void	setAutoDataRange (const IlvCoordInterval &range)
	Sets the minimum and maximum values automatically computed from the data. More...

void	setCoordinateType (IlvCoordinateType coordinateType)
	Sets the type of the corresponding coordinate. More...

void	setDataMax (IlDouble value)
	Sets the maximum value used to select the data to display. More...

void	setDataMin (IlDouble value)
	Sets the minimum value used to select the data to display. More...

virtual void	setDataRange (const IlvCoordInterval &range)
	Sets the minimum and maximum values used to select the data to display. More...

virtual void	setMaxPosData (IlDouble value)
	Sets the value positioned at the maximum position of the associated scale. More...

virtual void	setMinPosData (IlDouble value)
	Sets the value positioned at the minimum position of the associated scale. More...

void	setTransformer (IlvCoordinateTransformer *transfo)
	Sets the applied transformation. More...

void	setUserDataMax (IlDouble value)
	Sets the maximum value specified by the user. More...

void	setUserDataMin (IlDouble value)
	Sets the minimum value specified by the user. More...

virtual void	setUserDataRange (const IlvCoordInterval &range)
	Sets the values interval specified by the user. More...

void	unLock ()
	Unlocks the current `IlvCoordinateInfo` object. More...

void	updateAutoDataRange (const IlvCoordInterval &range)
	Updates the minimum and maximum values automatically computed from the data. More...

void	useAutoDataRange (IlBoolean b)
	Specifies whether the minimum and maximum values used to select the data are automatically computed. More...

virtual void	write (IlvOutputFile &file) const
	Writes the attributes of the current object in a file. More...

Static Public Member Functions
static IlvCoordinateInfo *	Load (IlvInputFile &file)
	Reads a coordinate information object from a file. More...

static IlvCoordinateInfo *	Read (IlvInputFile &file)
	Reads the attributes of a coordinate information object from a file. More...

Detailed Description

Base class for coordinate information storage.

Library: ilvcharts

This class stores specific information related to a data coordinate (x, y, theta, or rho) that is represented by a given scale. It stores the minimum and maximum values for the coordinate that will be used to select the data to display. It also stores a pointer to an IlvCoordinateTransformer object that specifies a transformation that will be applied to this coordinate.

The minimum and maximum values for a coordinate that will be used to select the data to display can be specified in two ways:

By hand by the means of the IlvCoordinateInfo::setUserDataMin, IlvCoordinateInfo::setUserDataMax or IlvCoordinateInfo::setUserDataRange methods. In this case, the values set by the user will be used to select the data. This means that only the data within the specified interval for the coordinate will be displayed.
By automatic computation by calling the IlvCoordinateInfo::useAutoDataRange with IlTrue as a parameter. In this case, the minimum and maximum values for the coordinate are automatically computed from the data so that they include all the defined data. This means that all the data will be selected to be displayed.

The minimum and maximum values that are set by the user are returned by the IlvCoordinateInfo::getUserDataMin and IlvCoordinateInfo::getUserDataMax methods, respectively. If no values are specified by the user, the returned values are both equal to 0.

The minimum and maximum values that are automatically computed from the data are returned by the IlvCoordinateInfo::getAutoDataMin and IlvCoordinateInfo::getAutoDataMax methods, respectively.

The minimum and maximum values that are actually used to select the data to display are returned by the IlvCoordinateInfo::getDataMin and IlvCoordinateInfo::getDataMax methods. These values correspond to the values set by the user or to the automatically computed values if no values have been set by the user.

The values that are positioned at the minimum and maximum positions of the scale associated with the coordinate are obtained by the IlvCoordinateInfo::getMinPosData and IlvCoordinateInfo::getMaxPosData methods.

You can see an example on the figure below where two scales are represented: a normal scale and a cyclic scale. The values that are positioned at the minimum and maximum positions of both scales are 0 and 6 (see minPosData and maxPosData in the figure). The minimum and maximum values used to select the data are 0 and 6 for the normal scale, and 2 and 8 for the cyclic scale (see dataMin and dataMax in the figure).

A lock/unlock system is provided in order to share this object among the different objects that use it. The lock/unlock system ensures that the coordinate information object will not be deleted as long as an object needs it (see the IlvCoordinateInfo::lock and IlvCoordinateInfo::unLock methods for more details).

See also: IlvChartCoordinateInfo, IlvCoordinateTransformer.

Constructor & Destructor Documentation

◆ IlvCoordinateInfo() [1/4]

IlvCoordinateInfo::IlvCoordinateInfo	(	IlvCoordinateType	coordinateType,
		IlvCoordinateTransformer *	transfo = `0`
	)

Constructor.

Initializes a new IlvCoordinateInfo object for a given coordinate (x, y, theta, or rho). By default, the minimum and maximum values used to select the data to display and the values that will be positioned at the minimum and maximum positions of the associated scale are set to 0. Since no minimum and maximum values used to select the data to display are specified, the flag indicating that the minimum and maximum values are automatically computed from the data is set to IlTrue. At this point in time, these automatically computed values are equal to 0, since the data that will be displayed is not yet known.

Parameters

coordinateType	The type of the coordinate with which the current object is associated. This type is `IlvAbscissaCoordinate` if the current object is associated with the abscissa or `IlvOrdinateCoordinate` if it is associated with the ordinate.
transfo	The transformation that will be applied to the considered coordinate.

◆ IlvCoordinateInfo() [2/4]

IlvCoordinateInfo::IlvCoordinateInfo	(	IlvCoordinateType	coordinateType,
		IlDouble	dataMin,
		IlDouble	dataMax,
		IlvCoordinateTransformer *	transfo = `0`
	)

Constructor.

Initializes a new IlvCoordinateInfo object for a given coordinate (x, y, theta, or rho). The parameters dataMin and dataMax correspond to the minimum and maximum values set by the user. The minimum and maximum values used to select the data to display are set to these values. The values that will be positioned at the minimum and maximum positions of the associated scale are set to the minimum and maximum values that will be used to select the data to display. Therefore, they are also set to dataMin and dataMax. The flag indicating that the minimum and maximum values are automatically computed from the data is set to IlFalse since the minimum and maximum values used to select the data to display are specified by hand.

Parameters

coordinateType	The type of the coordinate with which the current object is associated. This type is `IlvAbscissaCoordinate` if the current object is associated with the abscissa or `IlvOrdinateCoordinate` if it is associated with the ordinate.
dataMin	The minimum value of the coordinate used to select the data to display.
dataMax	The maximum value of the coordinate used to select the data to display.
transfo	The transformation that will be applied to the considered coordinate.

◆ IlvCoordinateInfo() [3/4]

IlvCoordinateInfo::IlvCoordinateInfo ( const IlvCoordinateInfo & coordinateInfo )

Constructor.

Initializes a new IlvCoordinateInfo object as a copy of coordinateInfo.

Parameters

coordinateInfo The object used to initialize the current one.

◆ IlvCoordinateInfo() [4/4]

IlvCoordinateInfo::IlvCoordinateInfo ( IlvInputFile & file )

Constructor.

Initializes a new IlvCoordinateInfo object from the description read in the input file named file.

Parameters

file	The file used to initialize the current object.

◆ ~IlvCoordinateInfo()

virtual IlvCoordinateInfo::~IlvCoordinateInfo ( )

virtual

Destructor.

The destructor deletes the object derived from the IlvCoordinateTransformer class that specifies a transformation that will be applied to the coordinate.

Member Function Documentation

◆ addListener()

void IlvCoordinateInfo::addListener ( IlvCoordinateInfoListener * listener )

Adds a listener.

Parameters

listener The new listener.

Note: Listeners are automatically deleted when the object is deleted.

◆ copy()

virtual IlvCoordinateInfo* IlvCoordinateInfo::copy ( ) const

virtual

Virtual copy constructor.

Creates and returns a copy of the current object. This method must be overloaded in subclasses. It is automatically declared by the DeclareCoordinateInfoTypeInfo macro. The IlvPredefinedCoordinateInfoIOMembers macro lets you define a default implementation, which returns an instance initialized with the copy constructor.

Returns: A copy of the current object.

◆ getAutoDataMax()

IlDouble IlvCoordinateInfo::getAutoDataMax ( ) const

Returns the maximum value automatically computed from the considered data.

Returns: The maximum value for the considered coordinate that is automatically computed from the considered data. This value is used to select the data to display if the flag indicating that the automatically computed values are used to select the data to display is set to IlTrue (see the IlvCoordinateInfo::useAutoDataRange and IlvCoordinateInfo::isUsingAutoDataRange methods).

◆ getAutoDataMin()

IlDouble IlvCoordinateInfo::getAutoDataMin ( ) const

Returns the minimum value automatically computed from the considered data.

Returns: The minimum value for the considered coordinate that is automatically computed from the considered data. This value is used to select the data to display if the flag indicating that the automatically computed values are used to select the data to display is set to IlTrue (see the IlvCoordinateInfo::useAutoDataRange and IlvCoordinateInfo::isUsingAutoDataRange methods).

◆ getAutoDataRange()

const IlvCoordInterval& IlvCoordinateInfo::getAutoDataRange ( ) const

Returns the values interval automatically computed from the considered data.

Returns: The values interval for the coordinate that is automatically computed from the data. This interval is characterized by its minimum and maximum values. These values are used to select the data to display if the flag indicating that the automatically computed values are used to select the data to display is set to IlTrue (see the IlvCoordinateInfo::useAutoDataRange and IlvCoordinateInfo::isUsingAutoDataRange methods).

◆ getCoordinateType()

IlvCoordinateType IlvCoordinateInfo::getCoordinateType ( ) const

Returns the type of the corresponding coordinate.

Returns: IlvAbscissaCoordinate if the current object is associated with the abscissa and IlvOrdinateCoordinate if the current object is associated with the ordinate.

◆ getDataMax()

IlDouble IlvCoordinateInfo::getDataMax ( ) const

Returns the maximum value used to select the data to display.

Returns: The maximum value that is used to select the data to display for the considered coordinate. This value is equal to the value returned by the IlvCoordinateInfo::getAutoDataMax method if the flag indicating that the automatically computed values are used to select the data to display is set to IlTrue. Otherwise, it is equal to the value returned by the IlvCoordinateInfo::getUserDataMax method.

◆ getDataMin()

IlDouble IlvCoordinateInfo::getDataMin ( ) const

Returns the minimum value used to select the data to display.

Returns: The minimum value that is used to select the data to display for the considered coordinate. This value is equal to the value returned by the IlvCoordinateInfo::getAutoDataMin method if the flag indicating that the automatically computed values are used to select the data to display is set to IlTrue. Otherwise, it is equal to the value returned by the IlvCoordinateInfo::getUserDataMin method.

◆ getDataRange()

const IlvCoordInterval& IlvCoordinateInfo::getDataRange ( ) const

Returns the values interval used to select the data to display.

Returns: The values interval for the considered coordinate that is used to select the data to display. This values interval is equal to the values interval returned by the IlvCoordinateInfo::getAutoDataRange method if the flag indicating that the automatically computed values are used to select the data to display is set to IlTrue. Otherwise, it is equal to the values interval returned by the IlvCoordinateInfo::getUserDataRange method.

◆ getFirstCycleRange()

void IlvCoordinateInfo::getFirstCycleRange ( IlvCoordInterval & range ) const

Returns the interval of values that are not shifted by the cycle length.

In the cyclic mode, the interval of the displayed values is divided into two parts. The first part is not shifted by the cycle length. The second one is shifted by the cycle length and is displayed from the minimum position where data are displayed. This minimum position corresponds to the left most position of the scale. (See the figure in the Detailed Description paragraph.)

The first part is delimited by the minimum value used to select the data to display (value returned by the IlvCoordinateInfo::getDataMin method) and the data value positioned at the maximum position where data are displayed (value returned by the IlvCoordinateInfo::getMaxPosData method). The second part is delimited by the data value positioned at the maximum position where data are displayed and the maximum value used to select the data to display (value returned by the IlvCoordinateInfo::getDataMax method).

This method returns the bounding values of the first part.

Parameters

range The interval of values which are represented without being shifted by the cycle length in the cyclic mode.

◆ getListeners()

IlvCoordinateInfoListener* const* IlvCoordinateInfo::getListeners ( IlUInt & count ) const

Returns all the listeners.

Parameters

count The number of returned listeners.

Returns: An array of all the listeners defined for the current object.

Note: The returned array should not be freed or modified directly since it is maintained internally.

◆ getMaxPosData()

IlDouble IlvCoordinateInfo::getMaxPosData ( ) const

Returns the value positioned at the maximum position of the associated scale.

Returns: The data value that is positioned at the maximum position of the scale associated with the considered coordinate. (See the Detailed Description paragraph for more information.)

◆ getMinPosData()

IlDouble IlvCoordinateInfo::getMinPosData ( ) const

Returns the value positioned at the minimum position of the associated scale.

Returns: The data value that is positioned at the minimum position of the scale associated with the considered coordinate. (See the Detailed Description paragraph for more information.)

◆ getSecondCycleRange()

void IlvCoordinateInfo::getSecondCycleRange ( IlvCoordInterval & range ) const

Returns the interval of values that are shifted by the cycle length.

In the cyclic mode, the interval of the displayed values is divided into two parts. The first part is not shifted by the cycle length. The second one is shifted by the cycle length and is displayed from the minimum position where data are displayed. This minimum position corresponds to the left most position of the scale. (See the figure in the Detailed Description paragraph.)

The first part is delimited by the minimum value used to select the data to display (value returned by the IlvCoordinateInfo::getDataMin method) and the data value positioned at the maximum position where data are displayed (value returned by the IlvCoordinateInfo::getMaxPosData method). The second part is delimited by the data value positioned at the maximum position where data are displayed and the maximum value used to select the data to display (value returned by the IlvCoordinateInfo::getDataMax method).

This method returns the bounding values of the second part.

Parameters

range The interval of values which are represented as being shifted by the cycle length in the cyclic mode.

◆ getTransformer()

IlvCoordinateTransformer* IlvCoordinateInfo::getTransformer ( ) const

Returns the applied transformation.

Returns: A pointer to the object specifying the transformation that will be applied to the considered coordinate.

◆ getUserDataMax()

IlDouble IlvCoordinateInfo::getUserDataMax ( ) const

Returns the maximum value specified by the user.

Returns: The maximum value specified by the user for the considered coordinate. This value is used to select the data to display if the flag indicating that the automatically computed values are used to select the data to display is set to IlFalse (see the IlvCoordinateInfo::useAutoDataRange and IlvCoordinateInfo::isUsingAutoDataRange methods).

◆ getUserDataMin()

IlDouble IlvCoordinateInfo::getUserDataMin ( ) const

Returns the minimum value specified by the user.

Returns: The minimum value specified by the user for the considered coordinate. This value is used to select the data to display if the flag indicating that the automatically computed values are used to select the data to display is set to IlFalse (see the IlvCoordinateInfo::useAutoDataRange and IlvCoordinateInfo::isUsingAutoDataRange methods).

◆ getUserDataRange()

const IlvCoordInterval& IlvCoordinateInfo::getUserDataRange ( ) const

Returns the values interval specified by the user.

Returns: The values interval specified by the user for the considered coordinate.
This interval is characterized by its minimum and maximum values. These values are used to select the data to display if the flag indicating that the automatically computed values are used to select the data to display is set to IlFalse (see the IlvCoordinateInfo::useAutoDataRange and IlvCoordinateInfo::isUsingAutoDataRange methods).

◆ isInCyclicMode()

IlBoolean IlvCoordinateInfo::isInCyclicMode ( ) const

Indicates whether the coordinate is in cyclic mode.

Returns: IlTrue if the coordinate is in cyclic mode and IlFalse otherwise.

Note: A given coordinate is in cyclic mode only when it is an abscissa and when the value returned by IlvCoordinateInfo::getDataMin() is different from the value returned by IlvCoordinateInfo::getMinPosData() or when the value returned by IlvCoordinateInfo::getDataMax() is different from the value returned by IlvCoordinateInfo::getMaxPosData(). (See the Detailed Description paragraph and the accompanying figure for more information.)

◆ isOnAbscissa()

IlBoolean IlvCoordinateInfo::isOnAbscissa ( ) const

Indicates whether the current object is associated with the abscissa.

Returns: IlTrue if the current object is associated with the abscissa and IlFalse otherwise.

◆ isOnOrdinate()

IlBoolean IlvCoordinateInfo::isOnOrdinate ( ) const

Indicates whether the current object is associated with the ordinate.

Returns: IlTrue if the current object is associated with the ordinate and IlFalse otherwise.

◆ isUsingAutoDataRange()

IlBoolean IlvCoordinateInfo::isUsingAutoDataRange ( ) const

Indicates whether the automatically computed minimum and maximum values are used to select the data to display.

Returns: IlTrue if the automatically computed minimum and maximum values are used to select the data to display, and IlFalse otherwise.

◆ Load()

static IlvCoordinateInfo* IlvCoordinateInfo::Load ( IlvInputFile & file )

static

Reads a coordinate information object from a file.

Creates a coordinate information instance from the description stored in the file file. The object description must have been written with the IlvCoordinateInfo::save method.

Parameters

file	The file where the object description is stored.

Returns: A pointer to the created object.

◆ lock()

void IlvCoordinateInfo::lock ( )

Locks the current IlvCoordinateInfo object.

Ensures that the current IlvCoordinateInfo object will not be destroyed before it is unlocked.
This method increments a reference count initially set to 0.

When you keep a pointer to an IlvCoordinateInfo object (because you store it in the field of an object or it is in a variable), you should lock it for the duration of its use so that it is not destroyed by some other object or component. When you do not need the IlvCoordinateInfo any more, you should release it with a call to unLock; if the lock you just removed was the last one, Rogue Wave Views will free the IlvCoordinateInfo.

◆ Read()

static IlvCoordinateInfo* IlvCoordinateInfo::Read ( IlvInputFile & file )

static

Reads the attributes of a coordinate information object from a file.

Reads from a file the attributes specific to an object which have been written by the corresponding IlvCoordinateInfo::write method and creates a copy of this object. The Read method is called by the IlvCoordinateInfo::Load method. The IlvCoordinateInfo::Load method read the information indicating the type of the stored object before calling the Read method. Therefore, you should use the Read method directly only when you know the type of the stored object.

Parameters

file	The file where the object attributes are stored.

Returns: A pointer to the created object.

◆ removeListener()

IlvCoordinateInfoListener* IlvCoordinateInfo::removeListener ( IlvCoordinateInfoListener * l )

Removes a listener.

Parameters

l	The listener to remove.

Returns: The removed listener, or 0 if l is not associated with the current object.

Note: The listener is not deleted.

◆ removeListeners()

void IlvCoordinateInfo::removeListeners ( )

Removes all the listeners.

All the listeners are deleted.

◆ resetAutoDataRange()

void IlvCoordinateInfo::resetAutoDataRange ( )

Sets the minimum and maximum values automatically computed from the considered data to 0.

Note: This method is for internal use only and should not be used directly by the user.

◆ resetDataRangeToAuto()

void IlvCoordinateInfo::resetDataRangeToAuto ( )

Resets the minimum and maximum values to the automatically computed values.

Resets the minimum and maximum values used to select the data to display for the considered coordinate to the minimum and maximum values automatically computed from the considered data.

◆ resetDataRangeToUser()

void IlvCoordinateInfo::resetDataRangeToUser ( )

Resets the minimum and maximum values to the values specified by the user.

Resets the minimum and maximum values used to select the data to display for the considered coordinate to the minimum and maximum values specified by the user.

◆ save()

IlvOutputFile& IlvCoordinateInfo::save ( IlvOutputFile & file ) const

Writes a complete description of the current object in a file.

Writes the complete object description in a file. This description contains all the information necessary to read back this object with the IlvCoordinateInfo::Load member function. This method first writes information regarding the type of the object and calls the IlvCoordinateInfo::write method.

Parameters

file	The file where the complete object description is written.

◆ setAutoDataRange()

void IlvCoordinateInfo::setAutoDataRange ( const IlvCoordInterval & range )

Sets the minimum and maximum values automatically computed from the data.

Parameters

range The new values interval that is automatically computed from the considered data.

Note: This method is for internal use only and should not be used directly by the user.

◆ setCoordinateType()

void IlvCoordinateInfo::setCoordinateType ( IlvCoordinateType coordinateType )

Sets the type of the corresponding coordinate.

Parameters

coordinateType The type of the coordinate with which the current object is associated.

Note: This method is for internal use only and should not be used directly by the user.

◆ setDataMax()

void IlvCoordinateInfo::setDataMax ( IlDouble value )

Sets the maximum value used to select the data to display.

Sets the maximum value used to select the data to display and the value that is positioned at the maximum position of the scale associated with the considered coordinate to value.

Parameters

value The new maximum value used to select the data to display.

Note: This method is for internal use only and should not be used directly by the user.

◆ setDataMin()

void IlvCoordinateInfo::setDataMin ( IlDouble value )

Sets the minimum value used to select the data to display.

Sets the minimum value used to select the data to display and the value that is positioned at the minimum position of the scale associated with the considered coordinate to value.

Parameters

value The new minimum value used to select the data to display.

Note: This method is for internal use only and should not be used directly by the user.

◆ setDataRange()

virtual void IlvCoordinateInfo::setDataRange ( const IlvCoordInterval & range )

virtual

Sets the minimum and maximum values used to select the data to display.

Sets the values interval used to select the data to display for the considered coordinate to range and the values that are positioned at the minimum and maximum positions of the scale associated with the considered coordinate to range.getMin() and range.getMax(), respectively.

Parameters

range The new values interval used to select the data to display.

Note: This method is for internal use only and should not be used directly by the user.

◆ setMaxPosData()

virtual void IlvCoordinateInfo::setMaxPosData ( IlDouble value )

virtual

Sets the value positioned at the maximum position of the associated scale.

Parameters

value The new data value that is positioned at the maximum position of the scale associated with the considered coordinate.

Note: This method is for internal use only and should not be used directly by the user.

◆ setMinPosData()

virtual void IlvCoordinateInfo::setMinPosData ( IlDouble value )

virtual

Sets the value positioned at the minimum position of the associated scale.

Parameters

value The new data value that is positioned at the minimum position of the scale associated with the considered coordinate.

Note: This method is for internal use only and should not be used directly by the user.

◆ setTransformer()

void IlvCoordinateInfo::setTransformer ( IlvCoordinateTransformer * transfo )

Sets the applied transformation.

Parameters

transfo The new transformation that will be applied to the considered coordinate.

◆ setUserDataMax()

void IlvCoordinateInfo::setUserDataMax ( IlDouble value )

Sets the maximum value specified by the user.

Allows the user to define a maximum value that will be used to select the data to display for the considered coordinate.

Parameters

value The new maximum value specified by the user for the considered coordinate.

◆ setUserDataMin()

void IlvCoordinateInfo::setUserDataMin ( IlDouble value )

Sets the minimum value specified by the user.

Allows the user to define a minimum value that will be used to select the data to display for the considered coordinate.

Parameters

value The new minimum value specified by the user for the considered coordinate.

◆ setUserDataRange()

virtual void IlvCoordinateInfo::setUserDataRange ( const IlvCoordInterval & range )

virtual

Sets the values interval specified by the user.

Allows the user to define a values interval that will be used to select the data to display for the considered coordinate.

Parameters

range The new values interval specified by the user for the considered coordinate.

◆ unLock()

void IlvCoordinateInfo::unLock ( )

Unlocks the current IlvCoordinateInfo object.

Decrements the reference count of the object and deletes the object if this count drops to 0.

◆ updateAutoDataRange()

void IlvCoordinateInfo::updateAutoDataRange ( const IlvCoordInterval & range )

Updates the minimum and maximum values automatically computed from the data.

This method is used to update the values interval that is automatically computed from the considered data.

If the old interval that is already stored has its minimum and maximum equal to 0, the new automatically computed interval is set to range. Otherwise, it is set to the smaller interval that contains both the old interval that is already stored and the interval range.

Parameters

range The new values interval that is automatically computed from the considered data.

Note: This method is for internal use only and should not be used directly by the user.

◆ useAutoDataRange()

void IlvCoordinateInfo::useAutoDataRange ( IlBoolean b )

Specifies whether the minimum and maximum values used to select the data are automatically computed.

Parameters

b	The new value of the Boolean indicating whether the minimum and maximum values used to select the data to display are automatically computed from the considered data.

◆ write()

virtual void IlvCoordinateInfo::write ( IlvOutputFile & file ) const

virtual

Writes the attributes of the current object in a file.

Called by the IlvCoordinateInfo::save method. This method can be overloaded in subclasses that define new attributes. The information written by the write method is read by the IO constructor, which takes an IlvInputFile as its only argument. Both this method and the IO constructor can be automatically declared by using the DeclareCoordinateInfoTypeInfo macro within the class declaration.

Parameters

file	The file where the attributes of the current object are written.

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ IlvCoordinateInfo() [1/4]

◆ IlvCoordinateInfo() [2/4]

◆ IlvCoordinateInfo() [3/4]

◆ IlvCoordinateInfo() [4/4]

◆ ~IlvCoordinateInfo()

Member Function Documentation

◆ addListener()

◆ copy()

◆ getAutoDataMax()

◆ getAutoDataMin()

◆ getAutoDataRange()

◆ getCoordinateType()

◆ getDataMax()

◆ getDataMin()

◆ getDataRange()

◆ getFirstCycleRange()

◆ getListeners()

◆ getMaxPosData()

◆ getMinPosData()

◆ getSecondCycleRange()

◆ getTransformer()

◆ getUserDataMax()

◆ getUserDataMin()

◆ getUserDataRange()

◆ isInCyclicMode()

◆ isOnAbscissa()

◆ isOnOrdinate()

◆ isUsingAutoDataRange()

◆ Load()

◆ lock()

◆ Read()

◆ removeListener()

◆ removeListeners()

◆ resetAutoDataRange()

◆ resetDataRangeToAuto()

◆ resetDataRangeToUser()

◆ save()

◆ setAutoDataRange()

◆ setCoordinateType()

◆ setDataMax()

◆ setDataMin()

◆ setDataRange()

◆ setMaxPosData()

◆ setMinPosData()

◆ setTransformer()

◆ setUserDataMax()

◆ setUserDataMin()

◆ setUserDataRange()

◆ unLock()

◆ updateAutoDataRange()

◆ useAutoDataRange()

◆ write()