Classes

class tlp::AbstractProperty< Tnode, Tedge, TPROPERTY >
This class is used to store a property of a graph. It implements PropertyInterface and add new methods to deal with two distinct type of values : More...
class tlp::AbstractVectorProperty< vectType, eltType >
class tlp::BooleanProperty
class tlp::BooleanVectorProperty
class tlp::ColorProperty
class tlp::ColorVectorProperty
class tlp::GraphProperty
class tlp::IntegerProperty
class tlp::IntegerVectorProperty
class tlp::LayoutProperty
class tlp::CoordVectorProperty
class tlp::PropertyObserver
Observer for Property. More...
class tlp::PropertyInterface
class tlp::PropertyInterface::MetaValueCalculator
class tlp::PropertyEvent
Event class for specific events on PropertyInterface. More...
class tlp::SizeProperty
class tlp::SizeVectorProperty

Functions

tlp::BooleanProperty::BooleanProperty (Graph *g, std::string n="")
PropertyInterface * tlp::BooleanProperty::clonePrototype (Graph *, const std::string &)
std::string tlp::BooleanProperty::getTypename () const
void tlp::BooleanProperty::reverse ()
void tlp::BooleanProperty::reverseEdgeDirection ()
Iterator< node > * tlp::BooleanProperty::getNodesEqualTo (const bool val, Graph *g=0)
Iterator< edge > * tlp::BooleanProperty::getEdgesEqualTo (const bool val, Graph *g=0)
PropertyInterface * tlp::BooleanVectorProperty::clonePrototype (Graph *, const std::string &)
std::string tlp::BooleanVectorProperty::getTypename () const
virtual tlp::PropertyInterface::~PropertyInterface ()
virtual void tlp::PropertyInterface::erase (const node)=0
virtual void tlp::PropertyInterface::erase (const edge)=0
virtual bool tlp::PropertyInterface::copy (const node dst, const node src, PropertyInterface *prop, bool ifNotDefault=false)=0
virtual bool tlp::PropertyInterface::copy (const edge dst, const edge src, PropertyInterface *prop, bool ifNotDefault=false)=0
virtual void tlp::PropertyInterface::copy (PropertyInterface *prop)=0
virtual PropertyInterface * tlp::PropertyInterface::clonePrototype (Graph *, const std::string &)=0
virtual std::string tlp::PropertyInterface::getTypename () const =0
const std::string & tlp::PropertyInterface::getName () const
tlp::Graph * tlp::PropertyInterface::getGraph ()
virtual std::string tlp::PropertyInterface::getNodeDefaultStringValue () const =0
virtual bool tlp::PropertyInterface::setAllNodeStringValue (const std::string &v)=0
virtual std::string tlp::PropertyInterface::getEdgeDefaultStringValue () const =0
virtual bool tlp::PropertyInterface::setAllEdgeStringValue (const std::string &v)=0
virtual std::string tlp::PropertyInterface::getNodeStringValue (const node n) const =0
virtual bool tlp::PropertyInterface::setNodeStringValue (const node n, const std::string &v)=0
virtual std::string tlp::PropertyInterface::getEdgeStringValue (const edge e) const =0
virtual bool tlp::PropertyInterface::setEdgeStringValue (const edge e, const std::string &v)=0
virtual DataMem * tlp::PropertyInterface::getNodeDefaultDataMemValue () const =0
virtual void tlp::PropertyInterface::setAllNodeDataMemValue (const DataMem *v)=0
virtual DataMem * tlp::PropertyInterface::getEdgeDefaultDataMemValue () const =0
virtual void tlp::PropertyInterface::setAllEdgeDataMemValue (const DataMem *v)=0
virtual DataMem * tlp::PropertyInterface::getNodeDataMemValue (const node n) const =0
virtual DataMem * tlp::PropertyInterface::getNonDefaultDataMemValue (const node n) const =0
virtual void tlp::PropertyInterface::setNodeDataMemValue (const node n, const DataMem *v)=0
virtual DataMem * tlp::PropertyInterface::getEdgeDataMemValue (const edge e) const =0
virtual DataMem * tlp::PropertyInterface::getNonDefaultDataMemValue (const edge e) const =0
virtual void tlp::PropertyInterface::setEdgeDataMemValue (const edge e, const DataMem *v)=0
virtual tlp::Iterator< node > * tlp::PropertyInterface::getNonDefaultValuatedNodes (const Graph *=NULL) const =0
virtual tlp::Iterator< edge > * tlp::PropertyInterface::getNonDefaultValuatedEdges (const Graph *=NULL) const =0
virtual void tlp::PropertyInterface::computeMetaValue (node mN, Graph *sg, Graph *mg)=0
virtual void tlp::PropertyInterface::computeMetaValue (edge mE, tlp::Iterator< edge > *itE, Graph *mg)=0
MetaValueCalculator * tlp::PropertyInterface::getMetaValueCalculator ()
virtual void tlp::PropertyInterface::setMetaValueCalculator (MetaValueCalculator *mvCalc)
void tlp::PropertyInterface::addPropertyObserver (PropertyObserver *pObs)
void tlp::PropertyInterface::removePropertyObserver (PropertyObserver *pObs)
unsigned int tlp::PropertyInterface::countPropertyObservers () const
virtual int tlp::PropertyInterface::compare (const node n1, const node n2) const =0
Compare value of the node n1 to the value of the node n2.
virtual int tlp::PropertyInterface::compare (const edge e1, const edge e2) const =0
Compare value of the edge e1 to the value of the edge e2.
void tlp::PropertyInterface::notifyBeforeSetNodeValue (const node n)
void tlp::PropertyInterface::notifyAfterSetNodeValue (const node n)
void tlp::PropertyInterface::notifyBeforeSetEdgeValue (const edge e)
void tlp::PropertyInterface::notifyAfterSetEdgeValue (const edge e)
void tlp::PropertyInterface::notifyBeforeSetAllNodeValue ()
void tlp::PropertyInterface::notifyAfterSetAllNodeValue ()
void tlp::PropertyInterface::notifyBeforeSetAllEdgeValue ()
void tlp::PropertyInterface::notifyAfterSetAllEdgeValue ()
void tlp::PropertyInterface::notifyDestroy ()
tlp::PropertyEvent::PropertyEvent (const PropertyInterface &prop, PropertyEventType propEvtType, Event::EventType evtType=Event::TLP_MODIFICATION, unsigned int id=UINT_MAX)
PropertyInterface * tlp::PropertyEvent::getProperty () const
node tlp::PropertyEvent::getNode () const
edge tlp::PropertyEvent::getEdge () const
PropertyEventType tlp::PropertyEvent::getType () const

Variables

static const std::string tlp::BooleanProperty::propertyTypename
static const std::string tlp::BooleanVectorProperty::propertyTypename
std::string tlp::PropertyInterface::name
Graph * tlp::PropertyInterface::graph
MetaValueCalculator * tlp::PropertyInterface::metaValueCalculator
PropertyEventType tlp::PropertyEvent::evtType
unsigned int tlp::PropertyEvent::eltId

Function Documentation

void tlp::PropertyInterface::addPropertyObserver ( PropertyObserver * pObs )

Registers a new property observer.

tlp::BooleanProperty::BooleanProperty	(	Graph *	g,
		std::string	n = `""`
	)		`[inline]`

PropertyInterface* tlp::BooleanVectorProperty::clonePrototype	(	Graph *	,
		const std::string &
	)		`[virtual]`

Creates an object of the same real type of the current property, in the the graph (first parameter) with the name (second parameter). Values are not copied.

Implements tlp::PropertyInterface.

virtual PropertyInterface* tlp::PropertyInterface::clonePrototype	(	Graph *	,
		const std::string &
	)		`[pure virtual]`

Creates an object of the same real type of the current property, in the the graph (first parameter) with the name (second parameter). Values are not copied.

Implemented in tlp::BooleanProperty, tlp::BooleanVectorProperty, tlp::ColorProperty, tlp::ColorVectorProperty, tlp::DoubleProperty, tlp::DoubleVectorProperty, tlp::GraphProperty, tlp::IntegerProperty, tlp::IntegerVectorProperty, tlp::LayoutProperty, tlp::CoordVectorProperty, tlp::SizeProperty, tlp::SizeVectorProperty, tlp::StringProperty, and tlp::StringVectorProperty.

PropertyInterface* tlp::BooleanProperty::clonePrototype	(	Graph *	,
		const std::string &
	)		`[virtual]`

Creates an object of the same real type of the current property, in the the graph (first parameter) with the name (second parameter). Values are not copied.

Implements tlp::PropertyInterface.

virtual int tlp::PropertyInterface::compare	(	const node	n1,
		const node	n2
	)		const `[pure virtual]`

Compare value of the node n1 to the value of the node n2.

Returns:: Return 0 if values are equal otherwise a number different from 0 is returned, with its sign indicating whether the value ot the node n1 is considered greater than the comparing value of the node n2(positive sign), or smaller (negative sign).

virtual int tlp::PropertyInterface::compare	(	const edge	e1,
		const edge	e2
	)		const `[pure virtual]`

Compare value of the edge e1 to the value of the edge e2.

Returns:: Return 0 if values are equal otherwise a number different from 0 is returned, with its sign indicating whether the value of edge e1 is considered greater than the comparing value of the edge e2 (positive sign), or smaller (negative sign).

virtual void tlp::PropertyInterface::computeMetaValue	(	edge	mE,
		tlp::Iterator< edge > *	itE,
		Graph *	mg
	)		`[pure virtual]`

Sets a computed value for the meta edge mE representing the edges from the iterator itE. mg is the graph owning the meta edge.

virtual void tlp::PropertyInterface::computeMetaValue	(	node	mN,
		Graph *	sg,
		Graph *	mg
	)		`[pure virtual]`

Sets a computed value for the meta node mN pointing to the sub-graph sg mg is the graph owning the meta node

virtual bool tlp::PropertyInterface::copy	(	const node	dst,
		const node	src,
		PropertyInterface *	prop,
		bool	ifNotDefault = `false`
	)		`[pure virtual]`

Sets the value of a node (first argument) in the current property (this) with the value of the node (second argument) defined in prop (third argument) If the fourth argument is set to true, the value will be copied only if it is not the default value. Returns true if a copy has been done

virtual bool tlp::PropertyInterface::copy	(	const edge	dst,
		const edge	src,
		PropertyInterface *	prop,
		bool	ifNotDefault = `false`
	)		`[pure virtual]`

Sets the value of an edge (first argument) in the current property (this) with the value of the edge (second argument) defined in prop (third argument) defined in this property (this). If the fourth argument is set to true, the value will be copied only if it is not the default value. Returns true if a copy has been done

virtual void tlp::PropertyInterface::copy ( PropertyInterface * prop ) [pure virtual]

Copies the values hold by the property argument on this property

unsigned int tlp::PropertyInterface::countPropertyObservers ( ) const [inline]

Returns the number of registered observers.

virtual void tlp::PropertyInterface::erase ( const node ) [pure virtual]

Removes the value stored for the node given in parameter. The new value for the node is the default one.

virtual void tlp::PropertyInterface::erase ( const edge ) [pure virtual]

Removes the value stored for the edge given in parameter. The new value for the edge is the default one.

edge tlp::PropertyEvent::getEdge ( ) const [inline]

virtual DataMem* tlp::PropertyInterface::getEdgeDataMemValue ( const edge e ) const [pure virtual]

Returns a pointer to a DataMem structure embedding the edge registered value WARNING: it is of the caller responsibility to delete the returned structure.

virtual DataMem* tlp::PropertyInterface::getEdgeDefaultDataMemValue ( ) const [pure virtual]

Returns a pointer to a DataMem structure embedding the edge default value WARNING: the caller have the responsibility to delete the returned structure.

virtual std::string tlp::PropertyInterface::getEdgeDefaultStringValue ( ) const [pure virtual]

Returns a string representation of the edge default value.

Iterator<edge>* tlp::BooleanProperty::getEdgesEqualTo	(	const bool	val,
		Graph *	g = `0`
	)

virtual std::string tlp::PropertyInterface::getEdgeStringValue ( const edge e ) const [pure virtual]

Returns a string conversion of the value registered for the given edge.

tlp::Graph* tlp::PropertyInterface::getGraph ( ) [inline]

Returns the graph on which the property has been defined. WARNING : If the property is inherited the graph could be different that the one used to get that property.

MetaValueCalculator* tlp::PropertyInterface::getMetaValueCalculator ( ) [inline]

Returns the meta value calculator associated to this property.

const std::string& tlp::PropertyInterface::getName ( ) const [inline]

Returns the name of the property.

node tlp::PropertyEvent::getNode ( ) const [inline]

virtual DataMem* tlp::PropertyInterface::getNodeDataMemValue ( const node n ) const [pure virtual]

Returns a pointer to a DataMem structure embedding the node registered value WARNING: it is of the caller responsibility to delete the returned structure.

virtual DataMem* tlp::PropertyInterface::getNodeDefaultDataMemValue ( ) const [pure virtual]

Returns a pointer to a DataMem structure embedding the node default value WARNING: it is of the caller responsibility to delete the returned structure.

virtual std::string tlp::PropertyInterface::getNodeDefaultStringValue ( ) const [pure virtual]

Returns a string representation of the node default value.

Iterator<node>* tlp::BooleanProperty::getNodesEqualTo	(	const bool	val,
		Graph *	g = `0`
	)

virtual std::string tlp::PropertyInterface::getNodeStringValue ( const node n ) const [pure virtual]

Returns a string conversion of the value registered for the given node.

virtual DataMem* tlp::PropertyInterface::getNonDefaultDataMemValue ( const node n ) const [pure virtual]

Returns a NULL pointer if the given node registered value is the default else returns a pointer to a DataMem structure embedding the value WARNING: it is of the caller responsibility to delete the returned structure.

virtual DataMem* tlp::PropertyInterface::getNonDefaultDataMemValue ( const edge e ) const [pure virtual]

Returns a NULL pointer if the given edge registered value is the default else returns a pointer to a DataMem structure embedding the value. WARNING: it is of the caller responsibility to delete the returned structure.

virtual tlp::Iterator<edge>* tlp::PropertyInterface::getNonDefaultValuatedEdges ( const Graph * = NULL ) const [pure virtual]

Returns an iterator on all edges whose value is different from the default value. When the pointer to the graph is not NULL only the edges owned by this graph are returned by the iterator. WARNING: it is of the caller responsibility to delete the returned iterator.

virtual tlp::Iterator<node>* tlp::PropertyInterface::getNonDefaultValuatedNodes ( const Graph * = NULL ) const [pure virtual]

Returns an iterator on all nodes whose value is different from the default value. When the pointer to the graph is not NULL only the nodes owned by this graph are returned by the iterator. WARNING: it is of the caller responsibility to delete the returned iterator.

PropertyInterface* tlp::PropertyEvent::getProperty ( ) const [inline]

PropertyEventType tlp::PropertyEvent::getType ( ) const [inline]

virtual std::string tlp::PropertyInterface::getTypename ( ) const [pure virtual]

Returns a string describing the type of the property. i.e. "graph", "double", "layout", "string", "integer", "color", "size", ...

Implemented in tlp::BooleanProperty, tlp::BooleanVectorProperty, tlp::ColorProperty, tlp::ColorVectorProperty, tlp::DoubleProperty, tlp::DoubleVectorProperty, tlp::GraphProperty, tlp::IntegerProperty, tlp::IntegerVectorProperty, tlp::LayoutProperty, tlp::CoordVectorProperty, tlp::SizeProperty, tlp::SizeVectorProperty, tlp::StringProperty, and tlp::StringVectorProperty.

std::string tlp::BooleanVectorProperty::getTypename ( ) const [inline, virtual]

Returns a string describing the type of the property. i.e. "graph", "double", "layout", "string", "integer", "color", "size", ...

Implements tlp::PropertyInterface.

std::string tlp::BooleanProperty::getTypename ( ) const [inline, virtual]

Returns a string describing the type of the property. i.e. "graph", "double", "layout", "string", "integer", "color", "size", ...

Implements tlp::PropertyInterface.

void tlp::PropertyInterface::notifyAfterSetAllEdgeValue ( ) [protected]

void tlp::PropertyInterface::notifyAfterSetAllNodeValue ( ) [protected]

void tlp::PropertyInterface::notifyAfterSetEdgeValue ( const edge e ) [protected]

void tlp::PropertyInterface::notifyAfterSetNodeValue ( const node n ) [protected]

void tlp::PropertyInterface::notifyBeforeSetAllEdgeValue ( ) [protected]

void tlp::PropertyInterface::notifyBeforeSetAllNodeValue ( ) [protected]

void tlp::PropertyInterface::notifyBeforeSetEdgeValue ( const edge e ) [protected]

void tlp::PropertyInterface::notifyBeforeSetNodeValue ( const node n ) [protected]

void tlp::PropertyInterface::notifyDestroy ( ) [protected]

tlp::PropertyEvent::PropertyEvent	(	const PropertyInterface &	prop,
		PropertyEventType	propEvtType,
		Event::EventType	evtType = `Event::TLP_MODIFICATION`,
		unsigned int	id = `UINT_MAX`
	)		`[inline]`

void tlp::PropertyInterface::removePropertyObserver ( PropertyObserver * pObs )

Removes a registered property observer.

void tlp::BooleanProperty::reverse ( )

void tlp::BooleanProperty::reverseEdgeDirection ( )

virtual void tlp::PropertyInterface::setAllEdgeDataMemValue ( const DataMem * v ) [pure virtual]

Clears all edges registered values, and set a new edge default value using the value embedded in the pointed DataMem structure.

virtual bool tlp::PropertyInterface::setAllEdgeStringValue ( const std::string & v ) [pure virtual]

Clears all edges registered values, and sets a new edge default value in converting the given string representation of a value. Returns true if the given string representation has been successfully converted to a value, false otherwise.

Implemented in tlp::AbstractProperty< Tnode, Tedge, TPROPERTY >, tlp::GraphProperty, tlp::AbstractProperty< tlp::BooleanVectorType, tlp::BooleanVectorType >, tlp::AbstractProperty< tlp::ColorVectorType, tlp::ColorVectorType >, tlp::AbstractProperty< tlp::SizeVectorType, tlp::SizeVectorType >, tlp::AbstractProperty< tlp::StringVectorType, tlp::StringVectorType >, tlp::AbstractProperty< tlp::IntegerVectorType, tlp::IntegerVectorType >, tlp::AbstractProperty< tlp::DoubleVectorType, tlp::DoubleVectorType >, tlp::AbstractProperty< tlp::BooleanType, tlp::BooleanType, tlp::BooleanAlgorithm >, tlp::AbstractProperty< vectType, vectType >, and tlp::AbstractProperty< tlp::CoordVectorType, tlp::CoordVectorType >.

virtual void tlp::PropertyInterface::setAllNodeDataMemValue ( const DataMem * v ) [pure virtual]

Clears all nodes registered values, and set a new node default value using the value embedded in the pointed DataMem structure.

virtual bool tlp::PropertyInterface::setAllNodeStringValue ( const std::string & v ) [pure virtual]

Clears all nodes registered values, and sets a new node default value in converting the given string representation of a value. Returns true if the given string representation has been successfully converted to a value, false otherwise.

Implemented in tlp::AbstractProperty< Tnode, Tedge, TPROPERTY >, tlp::GraphProperty, tlp::AbstractProperty< tlp::BooleanVectorType, tlp::BooleanVectorType >, tlp::AbstractProperty< tlp::ColorVectorType, tlp::ColorVectorType >, tlp::AbstractProperty< tlp::SizeVectorType, tlp::SizeVectorType >, tlp::AbstractProperty< tlp::StringVectorType, tlp::StringVectorType >, tlp::AbstractProperty< tlp::IntegerVectorType, tlp::IntegerVectorType >, tlp::AbstractProperty< tlp::DoubleVectorType, tlp::DoubleVectorType >, tlp::AbstractProperty< tlp::BooleanType, tlp::BooleanType, tlp::BooleanAlgorithm >, tlp::AbstractProperty< vectType, vectType >, and tlp::AbstractProperty< tlp::CoordVectorType, tlp::CoordVectorType >.

virtual void tlp::PropertyInterface::setEdgeDataMemValue	(	const edge	e,
		const DataMem *	v
	)		`[pure virtual]`

Registers a new value for the given node using the value embedded in the pointed DataMem structure.

virtual bool tlp::PropertyInterface::setEdgeStringValue	(	const edge	e,
		const std::string &	v
	)		`[pure virtual]`

Registers a new value for the given edge in converting the given string representation. Returns true if the given string representation has been successfully converted to a value, false otherwise.

Implemented in tlp::AbstractProperty< Tnode, Tedge, TPROPERTY >, tlp::GraphProperty, tlp::AbstractProperty< tlp::BooleanVectorType, tlp::BooleanVectorType >, tlp::AbstractProperty< tlp::ColorVectorType, tlp::ColorVectorType >, tlp::AbstractProperty< tlp::SizeVectorType, tlp::SizeVectorType >, tlp::AbstractProperty< tlp::StringVectorType, tlp::StringVectorType >, tlp::AbstractProperty< tlp::IntegerVectorType, tlp::IntegerVectorType >, tlp::AbstractProperty< tlp::DoubleVectorType, tlp::DoubleVectorType >, tlp::AbstractProperty< tlp::BooleanType, tlp::BooleanType, tlp::BooleanAlgorithm >, tlp::AbstractProperty< vectType, vectType >, and tlp::AbstractProperty< tlp::CoordVectorType, tlp::CoordVectorType >.

virtual void tlp::PropertyInterface::setMetaValueCalculator ( MetaValueCalculator * mvCalc ) [inline, virtual]

Sets the meta value calculator. Be careful that its destruction is not managed by the property.

virtual void tlp::PropertyInterface::setNodeDataMemValue	(	const node	n,
		const DataMem *	v
	)		`[pure virtual]`

Registers a new value for the given node using the value embedded in the pointed DataMem structure.

virtual bool tlp::PropertyInterface::setNodeStringValue	(	const node	n,
		const std::string &	v
	)		`[pure virtual]`

Registers a new value for the given node in converting the given string representation. Returns true if the given string representation has been successfully converted to a value, false otherwise.

Implemented in tlp::AbstractProperty< Tnode, Tedge, TPROPERTY >, tlp::GraphProperty, tlp::AbstractProperty< tlp::BooleanVectorType, tlp::BooleanVectorType >, tlp::AbstractProperty< tlp::ColorVectorType, tlp::ColorVectorType >, tlp::AbstractProperty< tlp::SizeVectorType, tlp::SizeVectorType >, tlp::AbstractProperty< tlp::StringVectorType, tlp::StringVectorType >, tlp::AbstractProperty< tlp::IntegerVectorType, tlp::IntegerVectorType >, tlp::AbstractProperty< tlp::DoubleVectorType, tlp::DoubleVectorType >, tlp::AbstractProperty< tlp::BooleanType, tlp::BooleanType, tlp::BooleanAlgorithm >, tlp::AbstractProperty< vectType, vectType >, and tlp::AbstractProperty< tlp::CoordVectorType, tlp::CoordVectorType >.

virtual tlp::PropertyInterface::~PropertyInterface ( ) [virtual]

Variable Documentation

unsigned int tlp::PropertyEvent::eltId [protected]

PropertyEventType tlp::PropertyEvent::evtType [protected]

Graph* tlp::PropertyInterface::graph [protected]

MetaValueCalculator* tlp::PropertyInterface::metaValueCalculator [protected]

std::string tlp::PropertyInterface::name [protected]

const std::string tlp::BooleanProperty::propertyTypename [static]

const std::string tlp::BooleanVectorProperty::propertyTypename [static]