vl::VLXVisitorLinker Class Reference

Substitutes IDs into VLXStructures using the provided link map. More...

#include <VLXVisitorLinker.hpp>

Inheritance diagram for vl::VLXVisitorLinker:

Public Types
enum	EError { NoError, UnresolvedID }

Public Member Functions
	VLXVisitorLinker (const std::map< std::string, ref< VLXStructure > > *map=NULL)
void	setLinkMap (const std::map< std::string, ref< VLXStructure > > *map)
VLXStructure *	link (const std::string &uid)
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

Substitutes IDs into VLXStructures using the provided link map.

Definition at line 41 of file VLXVisitorLinker.hpp.

Member Enumeration Documentation

EError

enum vl::VLXVisitorLinker::EError

Enumerator
NoError
UnresolvedID

Definition at line 46 of file VLXVisitorLinker.hpp.

Constructor & Destructor Documentation

VLXVisitorLinker()

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

inline

Definition at line 53 of file VLXVisitorLinker.hpp.

References NoError.

Member Function Documentation

error()

EError vl::VLXVisitorLinker::error ( ) const

inline

Definition at line 162 of file VLXVisitorLinker.hpp.

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

link()

VLXStructure* vl::VLXVisitorLinker::link ( const std::string &  uid )

inline

Definition at line 64 of file VLXVisitorLinker.hpp.

References vl::Log::error(), NULL, UnresolvedID, and VL_CHECK.

Referenced by visitList(), and visitStructure().

setError()

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

inline

Definition at line 164 of file VLXVisitorLinker.hpp.

setLinkMap()

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

inline

Definition at line 59 of file VLXVisitorLinker.hpp.

visitArray() [1/2]

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

inlinevirtual

Reimplemented from vl::VLXVisitor.

Definition at line 158 of file VLXVisitorLinker.hpp.

visitArray() [2/2]

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

inlinevirtual

Reimplemented from vl::VLXVisitor.

Definition at line 160 of file VLXVisitorLinker.hpp.

visitList()

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

inlinevirtual

Reimplemented from vl::VLXVisitor.

Definition at line 115 of file VLXVisitorLinker.hpp.

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

visitStructure()

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

inlinevirtual

Reimplemented from vl::VLXVisitor.

Definition at line 88 of file VLXVisitorLinker.hpp.

References vl::VLXValue::ID, vl::VLXVisitor::isVisited(), link(), 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/VLXVisitorLinker.hpp