Package com.powsybl.iidm.network

Class MultiThreadReportNodeContext

java.lang.Object

com.powsybl.iidm.network.AbstractReportNodeContext

com.powsybl.iidm.network.MultiThreadReportNodeContext

All Implemented Interfaces:

ReportNodeContext

public class MultiThreadReportNodeContext
extends AbstractReportNodeContext

Multi-thread ReportNodeContext's implementation.

To avoid memory leaks, this context must be closed (with the close() method) after usage.

Author:

Olivier Perrin <olivier.perrin at rte-france.com>

Constructor Summary

Constructors

Constructor	Description
MultiThreadReportNodeContext()
MultiThreadReportNodeContext(AbstractReportNodeContext reportNodeContext)

Method Summary

Modifier and Type	Method	Description
void	close()
protected Iterator<ReportNode>	descendingIterator()	Return a descending iterator on the elements (first pushed first)
ReportNode	getReportNode()	Get the current ReportNode.
ReportNode	popReportNode()	Pop the current ReportNode (defined via ReportNode) and restore the previous one.
void	pushReportNode(ReportNode reportNode)	Use the given ReportNode instead of the current one. The reportNodes are stacked and the previous one should be restored later using ReportNodeContext.popReportNode().

Methods inherited from class com.powsybl.iidm.network.AbstractReportNodeContext

copyReportNodes, peekReportNode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MultiThreadReportNodeContext

public MultiThreadReportNodeContext()

MultiThreadReportNodeContext

public MultiThreadReportNodeContext(AbstractReportNodeContext reportNodeContext)

Method Details

getReportNode

public ReportNode getReportNode()

Description copied from interface: ReportNodeContext

Get the current ReportNode.

Returns:

the last defined ReportNode

See Also:

• ReportNodeContext.pushReportNode(ReportNode)
• ReportNodeContext.popReportNode()

pushReportNode

public void pushReportNode(ReportNode reportNode)

Description copied from interface: ReportNodeContext

Use the given ReportNode instead of the current one.
The reportNodes are stacked and the previous one should be restored later using ReportNodeContext.popReportNode().

Parameters:

reportNode - The new reportNode to use.

See Also:

• ReportNodeContext.popReportNode()

popReportNode

public ReportNode popReportNode()

Description copied from interface: ReportNodeContext

Pop the current ReportNode (defined via ReportNode) and restore the previous one.

Returns:

the current ReportNode

See Also:

• ReportNodeContext.pushReportNode(ReportNode)

close

public void close()

descendingIterator

protected Iterator<ReportNode> descendingIterator()

Description copied from class: AbstractReportNodeContext

Return a descending iterator on the elements (first pushed first)

Specified by:

descendingIterator in class AbstractReportNodeContext

Returns:

an Iterator on the elements