Graph::FMTGraphVertexToYield Class Reference

Adapter pointing to a vertex of a line graph or a full graph and its model, used to answer a generic yield request that depends on the graph. More...

#include <FMTGraphVertexToYield.h>

Public Member Functions
	FMTGraphVertexToYield (const Models::FMTModel &model, const FMTGraph< FMTBaseVertexProperties, FMTBaseEdgeProperties > &linegraph, const void *lvertex)
	Construct a FMTGraphVertexToYield from a model, a line graph and a vertex.
	FMTGraphVertexToYield (const Models::FMTModel &model, const FMTGraph< FMTVertexProperties, FMTEdgeProperties > &fullgraph, const void *lvertex)
	Construct a FMTGraphVertexToYield from a model, a full graph and a vertex.
	FMTGraphVertexToYield ()
	Default constructor for FMTGraphVertexToYield.
	FMTGraphVertexToYield (const FMTGraphVertexToYield &rhs)=default
	Copy constructor for FMTGraphVertexToYield.
FMTGraphVertexToYield &	operator= (const FMTGraphVertexToYield &rhs)=default
	Copy assignment operator for FMTGraphVertexToYield.
const FMTGraph< FMTBaseVertexProperties, FMTBaseEdgeProperties > *const	getLineGraph () const
	Return the line graph, or nullptr if the adapter points to a full graph.
const FMTGraph< FMTVertexProperties, FMTEdgeProperties > *const	getFullGraph () const
	Return the full graph, or nullptr if the adapter points to a line graph.
const void *	getVertexPtr () const
	Return a pointer to the vertex.
const Models::FMTModel *	getModel () const
	Return the model.

Detailed Description

Adapter pointing to a vertex of a line graph or a full graph and its model, used to answer a generic yield request that depends on the graph.

Constructor & Destructor Documentation

FMTGraphVertexToYield() [1/4]

Graph::FMTGraphVertexToYield::FMTGraphVertexToYield	(	const Models::FMTModel &	model,
		const FMTGraph< FMTBaseVertexProperties, FMTBaseEdgeProperties > &	linegraph,
		const void *	lvertex
	)

Construct a FMTGraphVertexToYield from a model, a line graph and a vertex.

Parameters

[in]	model	the model.
[in]	linegraph	the line graph.
[in]	lvertex	the vertex.

FMTGraphVertexToYield() [2/4]

Graph::FMTGraphVertexToYield::FMTGraphVertexToYield	(	const Models::FMTModel &	model,
		const FMTGraph< FMTVertexProperties, FMTEdgeProperties > &	fullgraph,
		const void *	lvertex
	)

Construct a FMTGraphVertexToYield from a model, a full graph and a vertex.

Parameters

[in]	model	the model.
[in]	fullgraph	the full graph.
[in]	lvertex	the vertex.

FMTGraphVertexToYield() [3/4]

Graph::FMTGraphVertexToYield::FMTGraphVertexToYield

(

)

Default constructor for FMTGraphVertexToYield.

FMTGraphVertexToYield() [4/4]

Graph::FMTGraphVertexToYield::FMTGraphVertexToYield ( const FMTGraphVertexToYield &  rhs )

default

Copy constructor for FMTGraphVertexToYield.

Parameters

[in]

rhs

the FMTGraphVertexToYield to copy.

Member Function Documentation

getFullGraph()

const FMTGraph< FMTVertexProperties, FMTEdgeProperties > *const Graph::FMTGraphVertexToYield::getFullGraph

(

)

const

Return the full graph, or nullptr if the adapter points to a line graph.

Returns

a pointer to the full graph.

getLineGraph()

const FMTGraph< FMTBaseVertexProperties, FMTBaseEdgeProperties > *const Graph::FMTGraphVertexToYield::getLineGraph

(

)

const

Return the line graph, or nullptr if the adapter points to a full graph.

Returns

a pointer to the line graph.

getModel()

const Models::FMTModel * Graph::FMTGraphVertexToYield::getModel

(

)

const

Return the model.

Returns

a pointer to the model.

getVertexPtr()

const void * Graph::FMTGraphVertexToYield::getVertexPtr ( ) const

inline

Return a pointer to the vertex.

Returns

a pointer to the vertex.

operator=()

FMTGraphVertexToYield & Graph::FMTGraphVertexToYield::operator= ( const FMTGraphVertexToYield &  rhs )

default

Copy assignment operator for FMTGraphVertexToYield.

Parameters

[in]

rhs

the FMTGraphVertexToYield to copy.

Returns

a reference to this FMTGraphVertexToYield.

---

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

• D:/FMT/Include/FMTGraphVertexToYield.h