vl::VLXVisitorLinkMapper Class Reference

Compiles the link-map which associates a VLXStructure to it's ID, to be used later by other visitors. More...

#include <VLXVisitorLinkMapper.hpp>

Inheritance diagram for vl::VLXVisitorLinkMapper:

Public Types
enum	EError { NoError, DuplicateID }

Public Member Functions
	VLXVisitorLinkMapper (std::map< std::string, ref< VLXStructure > > *map=NULL)
void	setLinkMap (std::map< std::string, ref< VLXStructure > > *map)
void	declareID (VLXStructure *obj)
virtual void	visitStructure (VLXStructure *obj)
virtual void	visitList (VLXList *list)
virtual void	visitArray (VLXArrayInteger *)
virtual void	visitArray (VLXArrayReal *)
EError	error () const
void	setError (EError err)
Public Member Functions inherited from vl::VLXVisitor
virtual void	visitRawtextBlock (VLXRawtextBlock *)
bool	isVisited (void *node)
void	resetVisitedNodes ()
Public Member Functions inherited from vl::Object
	Object ()
	Constructor. More...
	Object (const Object &other)
	Copy constructor: copies the name, ref count mutex and user data. More...
Object &	operator= (const Object &other)
	Copy operator: copies the object's name, ref count mutex and user data. More...
const std::string &	objectName () const
	The name of the object, by default set to the object's class name. More...
void	setObjectName (const char *name)
	The name of the object, by default set to the object's class name in debug builds. More...
void	setObjectName (const std::string &name)
	The name of the object, by default set to the object's class name in debug builds. More...
void	setRefCountMutex (IMutex *mutex)
	The mutex used to protect the reference counting of an Object across multiple threads. More...
IMutex *	refCountMutex ()
	The mutex used to protect the reference counting of an Object across multiple threads. More...
const IMutex *	refCountMutex () const
	The mutex used to protect the reference counting of an Object across multiple threads. More...
int	referenceCount () const
	Returns the number of references of an object. More...
void	incReference () const
	Increments the reference count of an object. More...
void	decReference ()
	Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More...
void	setAutomaticDelete (bool autodel_on)
	If set to true the Object is deleted when its reference count reaches 0. More...
bool	automaticDelete () const
	If set to true the Object is deleted when its reference count reaches 0. More...
template<class T >
T *	as ()
	Casts an Object to the specified class. More...
template<class T >
const T *	as () const
	Casts an Object to the specified class. More...

Additional Inherited Members
Protected Member Functions inherited from vl::Object
virtual	~Object ()
Protected Attributes inherited from vl::Object
std::string	mObjectName
IMutex *	mRefCountMutex
int	mReferenceCount
bool	mAutomaticDelete

Detailed Description

Compiles the link-map which associates a VLXStructure to it's ID, to be used later by other visitors.

Can be called multiple times.

Definition at line 40 of file VLXVisitorLinkMapper.hpp.

Member Enumeration Documentation

EError

enum vl::VLXVisitorLinkMapper::EError

Enumerator
NoError
DuplicateID

Definition at line 45 of file VLXVisitorLinkMapper.hpp.

Constructor & Destructor Documentation

VLXVisitorLinkMapper()

vl::VLXVisitorLinkMapper::VLXVisitorLinkMapper ( std::map< std::string, ref< VLXStructure > > *  map = NULL )

inline

Definition at line 52 of file VLXVisitorLinkMapper.hpp.

References NoError.

Member Function Documentation

declareID()

void vl::VLXVisitorLinkMapper::declareID ( VLXStructure *  obj )

inline

Definition at line 63 of file VLXVisitorLinkMapper.hpp.

References DuplicateID, vl::Log::error(), vl::VLXTaggedValue::tag(), and vl::VLXStructure::uid().

Referenced by visitStructure().

error()

EError vl::VLXVisitorLinkMapper::error ( ) const

inline

Definition at line 129 of file VLXVisitorLinkMapper.hpp.

Referenced by vl::VLXLinker::link().

setError()

void vl::VLXVisitorLinkMapper::setError ( EError  err )

inline

Definition at line 131 of file VLXVisitorLinkMapper.hpp.

setLinkMap()

void vl::VLXVisitorLinkMapper::setLinkMap ( std::map< std::string, ref< VLXStructure > > *  map )

inline

Definition at line 58 of file VLXVisitorLinkMapper.hpp.

visitArray() [1/2]

virtual void vl::VLXVisitorLinkMapper::visitArray ( VLXArrayInteger *  )

inlinevirtual

Reimplemented from vl::VLXVisitor.

Definition at line 125 of file VLXVisitorLinkMapper.hpp.

visitArray() [2/2]

virtual void vl::VLXVisitorLinkMapper::visitArray ( VLXArrayReal *  )

inlinevirtual

Reimplemented from vl::VLXVisitor.

Definition at line 127 of file VLXVisitorLinkMapper.hpp.

visitList()

virtual void vl::VLXVisitorLinkMapper::visitList ( VLXList *  list )

inlinevirtual

Reimplemented from vl::VLXVisitor.

Definition at line 98 of file VLXVisitorLinkMapper.hpp.

References vl::VLXVisitor::isVisited(), vl::VLXValue::List, vl::VLXValue::Structure, vl::VLXList::value(), and vl::Log::warning().

visitStructure()

virtual void vl::VLXVisitorLinkMapper::visitStructure ( VLXStructure *  obj )

inlinevirtual

Reimplemented from vl::VLXVisitor.

Definition at line 81 of file VLXVisitorLinkMapper.hpp.

References declareID(), vl::VLXVisitor::isVisited(), vl::VLXValue::List, vl::VLXValue::Structure, and vl::VLXStructure::value().

---

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

• /home/master/UCL/VisualizationLibrary/src/vlCore/VLXVisitorLinkMapper.hpp