IlvGraphLayoutReport Class Reference

The base class of the objects used to store information about the behavior of the layout algorithms. More...

#include <ilviews/layout/report.h>

Inherits IlvLayoutValueInterface.

Public Member Functions
	IlvGraphLayoutReport ()
	Creates a new instance of the report object. More...
IlvLayoutReportType	getCode ()
	Returns the code describing the particular behavior (The possible values are described in this class or, if needed, in its subclasses.) More...
IlvRunTimeType	getEndLayoutTime ()
	Returns the end time of the layout.
IlvRunTimeType	getLayoutTime ()
	Returns the total duration (in milliseconds) of the layout algorithm. More...
IlvRunTimeType	getStartLayoutTime ()
	Returns the start time of the layout.
void	setCode (IlvLayoutReportType)
	Allows you to specify the particular case of behavior of the layout algorithm. More...
void	setEndLayoutTime (IlvRunTimeType)
	Records the end time of the layout.
void	setStartLayoutTime (IlvRunTimeType)
	Records the start time of the layout.

Detailed Description

The base class of the objects used to store information about the behavior of the layout algorithms.

Library: ilvlayout

The layout report is returned by the method IlvGraphLayout::performLayout(). It can also be obtained during the layout using the layout event listener mechanism.

See also

IlvGraphLayout::performLayout

Constructor & Destructor Documentation

IlvGraphLayoutReport::IlvGraphLayoutReport

(

)

Creates a new instance of the report object.

This is done using the method IlvGraphLayout::createLayoutReport().

Member Function Documentation

IlvLayoutReportType IlvGraphLayoutReport::getCode

(

)

Returns the code describing the particular behavior (The possible values are described in this class or, if needed, in its subclasses.)

Note

This method returns IlvLayoutReportLayoutFinished if it is called inside the method GraphLayoutEventListener::layoutStepPerformed() at the end of the layout process (except if the layout is not needed).

See also

setCode(IlvLayoutReportType).

IlvRunTimeType IlvGraphLayoutReport::getLayoutTime

(

)

Returns the total duration (in milliseconds) of the layout algorithm.

The start and end times are automatically recorded. The total duration is the sum of the duration of the methods IlvGraphLayout::isLayoutNeeded() and IlvGraphLayout::layout().

void IlvGraphLayoutReport::setCode

(

IlvLayoutReportType

)

Allows you to specify the particular case of behavior of the layout algorithm.

Valid code values are those defined in this class (IlvLayoutReportLayoutDone, IlvLayoutReportNotNeeded, IlvLayoutReportNoMoveableNode, and so on) or those defined in subclasses of IlvGraphLayoutReport. The codes are mutually exclusive. The last value specified using setCode(IlvLayoutReportType) is returned by getCode(). Note that you should call this method only if you create your own layout class inside the implementation of IlvGraphLayout::layout(). To obtain the layout report, use IlvGraphLayout::getLayoutReport().

See also

getCode