Interface for UML edge insertion algorithms. More...

#include <ogdf/uml/UMLEdgeInsertionModule.h>

Inheritance diagram for ogdf::UMLEdgeInsertionModule:

Public Member Functions
	UMLEdgeInsertionModule ()
	Initializes a UML edge insertion module (default constructor).

	UMLEdgeInsertionModule (const UMLEdgeInsertionModule &eim)
	Initializes a UML edge insertion module (copy constructor).

virtual	~UMLEdgeInsertionModule ()
	Destructor.

ReturnType	call (PlanRepLight &pr, const Array< edge > &origEdges)
	Inserts all edges in `origEdges` into `pr` while avoiding crossings between generalizations.

ReturnType	call (PlanRepLight &pr, const Array< edge > &origEdges, const EdgeArray< int > &costOrig)
	Inserts all edges in `origEdges` with given costs into `pr` while avoiding crossings between generalizations.

ReturnType	callEx (PlanRepLight &pr, const Array< edge > &origEdges, const EdgeArray< int > pCostOrig=nullptr, const EdgeArray< uint32_t > pEdgeSubGraphs=nullptr)
	Inserts all edges in `origEdges` into `pr` while avoiding crossings between generalizations, optionally costs and subgraphs may be given.

virtual UMLEdgeInsertionModule *	clone () const =0
	Returns a new instance of the UML edge insertion module with the same option settings.

Public Member Functions inherited from ogdf::Module
	Module ()
	Initializes a module.

virtual	~Module ()

Public Member Functions inherited from ogdf::Timeouter
	Timeouter ()
	timeout is turned of by default

	Timeouter (bool t)
	timeout is turned off (false) or on (true) (with 0 second)

	Timeouter (const Timeouter &t)

	Timeouter (double t)
	timeout is set to the given value (seconds)

	~Timeouter ()

bool	isTimeLimit () const
	returns whether any time limit is set or not

Timeouter &	operator= (const Timeouter &t)

double	timeLimit () const
	returns the current time limit for the call

void	timeLimit (bool t)
	shorthand to turn timelimit off or on (with 0 seconds)

void	timeLimit (double t)
	sets the time limit for the call (in seconds); <0 means no limit.

Protected Member Functions
virtual ReturnType	doCall (PlanRepLight &pr, const Array< edge > &origEdges, const EdgeArray< int > pCostOrig, const EdgeArray< uint32_t > pEdgeSubGraphs)=0
	Actual algorithm call that has to be implemented by derived classes.

Additional Inherited Members
Public Types inherited from ogdf::Module
enum class	ReturnType { Feasible , Optimal , NoFeasibleSolution , TimeoutFeasible , TimeoutInfeasible , Error }
	The return type of a module. More...

Static Public Member Functions inherited from ogdf::Module
static bool	isSolution (ReturnType ret)
	Returns true iff `ret` indicates that the module returned a feasible solution.

Protected Attributes inherited from ogdf::Timeouter
double	m_timeLimit
	Time limit for module calls (< 0 means no limit).

Detailed Description

Interface for UML edge insertion algorithms.

UML edge insertion algorithms take care that generalization edges do not cross in the resulting planarzation.

See also: SubgraphPlanarizerUML

Definition at line 48 of file UMLEdgeInsertionModule.h.

Constructor & Destructor Documentation

◆ UMLEdgeInsertionModule() [1/2]

ogdf::UMLEdgeInsertionModule::UMLEdgeInsertionModule ( )

inline

Initializes a UML edge insertion module (default constructor).

Definition at line 51 of file UMLEdgeInsertionModule.h.

◆ UMLEdgeInsertionModule() [2/2]

ogdf::UMLEdgeInsertionModule::UMLEdgeInsertionModule ( const UMLEdgeInsertionModule & eim )

inline

Initializes a UML edge insertion module (copy constructor).

Definition at line 54 of file UMLEdgeInsertionModule.h.

◆ ~UMLEdgeInsertionModule()

virtual ogdf::UMLEdgeInsertionModule::~UMLEdgeInsertionModule ( )

inlinevirtual

Destructor.

Definition at line 57 of file UMLEdgeInsertionModule.h.

Member Function Documentation

◆ call() [1/2]

ReturnType ogdf::UMLEdgeInsertionModule::call	(	PlanRepLight &	pr,
		const Array< edge > &	origEdges
	)

inline

Inserts all edges in origEdges into pr while avoiding crossings between generalizations.

Parameters

pr	is the input planarized representation and will also receive the result.
origEdges	is the array of original edges (edges in the original graph of `pr`) that have to be inserted.

Returns: the status of the result.

Definition at line 69 of file UMLEdgeInsertionModule.h.

◆ call() [2/2]

ReturnType ogdf::UMLEdgeInsertionModule::call	(	PlanRepLight &	pr,
		const Array< edge > &	origEdges,
		const EdgeArray< int > &	costOrig
	)

inline

Inserts all edges in origEdges with given costs into pr while avoiding crossings between generalizations.

Parameters

pr	is the input planarized representation and will also receive the result.
costOrig	is an edge array containing the costs of original edges; edges in `pr` without an original edge have zero costs.
origEdges	is the array of original edges (edges in the original graph of `pr`) that have to be inserted.

Returns: the status of the result.

Definition at line 81 of file UMLEdgeInsertionModule.h.

◆ callEx()

ReturnType ogdf::UMLEdgeInsertionModule::callEx	(	PlanRepLight &	pr,
		const Array< edge > &	origEdges,
		const EdgeArray< int > *	pCostOrig = `nullptr`,
		const EdgeArray< uint32_t > *	pEdgeSubGraphs = `nullptr`
	)

inline

Inserts all edges in origEdges into pr while avoiding crossings between generalizations, optionally costs and subgraphs may be given.

Parameters

pr	is the input planarized representation and will also receive the result.
origEdges	is the array of original edges (edges in the original graph of `pr`) that have to be inserted.
pCostOrig	is an edge array containing the costs of original edges; edges in `pr` without an original edge have zero costs. May be a 0-pointer, in which case all edges have cost 1.
pEdgeSubGraphs	points to an edge array specifying to which subgraph an edge belongs. May be a 0-poiner, in which case no subgraphs / simultaneous embedding is used.

Returns: the status of the result.

Definition at line 96 of file UMLEdgeInsertionModule.h.

◆ clone()

virtual UMLEdgeInsertionModule * ogdf::UMLEdgeInsertionModule::clone ( ) const

pure virtual

Returns a new instance of the UML edge insertion module with the same option settings.

Implemented in ogdf::FixedEmbeddingInserterUML, ogdf::VariableEmbeddingInserterDynUML, and ogdf::VariableEmbeddingInserterUML.

◆ doCall()

virtual ReturnType ogdf::UMLEdgeInsertionModule::doCall	(	PlanRepLight &	pr,
		const Array< edge > &	origEdges,
		const EdgeArray< int > *	pCostOrig,
		const EdgeArray< uint32_t > *	pEdgeSubGraphs
	)

protectedpure virtual

Actual algorithm call that has to be implemented by derived classes.

Parameters

pr	is the input planarized representation and will also receive the result.
origEdges	is the array of original edges (edges in the original graph of `pr`) that have to be inserted.
pCostOrig	is an edge array containing the costs of original edges; edges in `pr` without an original edge have zero costs. May be a 0-pointer, in which case all edges have cost 1.
pEdgeSubGraphs	points to an edge array specifying to which subgraph an edge belongs. May be a 0-poiner, in which case no subgraphs / simultaneous embedding is used.

Returns: the status of the result.

Implemented in ogdf::FixedEmbeddingInserterUML, ogdf::VariableEmbeddingInserterDynUML, and ogdf::VariableEmbeddingInserterUML.

The documentation for this class was generated from the following file:

include/ogdf/uml/UMLEdgeInsertionModule.h

OpenGraph DrawingFramework

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UMLEdgeInsertionModule() [1/2]

◆ UMLEdgeInsertionModule() [2/2]

◆ ~UMLEdgeInsertionModule()

Member Function Documentation

◆ call() [1/2]

◆ call() [2/2]

◆ callEx()

◆ clone()

◆ doCall()

Open
Graph Drawing
Framework