vtkStringManager Class Reference

Manage string-token mappings. More...

#include <vtkStringManager.h>

Inheritance diagram for vtkStringManager:

Collaboration diagram for vtkStringManager:

Public Types
enum	Visit { Halt , Continue }
	An enumerant visitors return to terminate early (or not). More...
typedef vtkObject	Superclass
using	Hash = std::uint32_t
	The type of integer used to hash strings.
using	Visitor = std::function< Visit(Hash entry)>
	Signature for functions visiting strings in the manager or in a set held by the manager.

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkStringManager *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
Hash	Manage (const std::string &ss)
	Insert a string into the manager by computing a unique hash (the returned value).
std::size_t	Unmanage (Hash hh)
	Remove a hash from the manager.
const std::string &	Value (Hash hh) const
	Look up a string from its hashed value, hh.
Hash	Find (const std::string &s) const
	Look up a hash from a string value (without inserting it).
Hash	Compute (const std::string &ss) const
	Compute a hash from a string value (without inserting it into the manager).
Hash	Insert (const std::string &ss, Hash hh)
	Add the hash hh to the set ss.
bool	Insert (Hash ss, Hash hh)
bool	Remove (const std::string &ss, Hash hh)
	Remove the hash h from the set s.
bool	Remove (Hash ss, Hash hh)
bool	Contains (const std::string &ss, Hash hh) const
	Return true if the set ss exists and contains hash hh ; and false otherwise.
bool	Contains (Hash ss, Hash hh) const
bool	Contains (Hash hh) const
bool	Empty () const
	Return true if the manager is empty (i.e., managing no hashes) and false otherwise.
Visit	VisitMembers (Visitor visitor, Hash set=Invalid) const
	Visit all members of the set (or the entire Manager if passed the Invalid hash).
Visit	VisitSets (Visitor visitor) const
	Visit all set names in the manager.
void	Reset ()
	Reset the manager to an empty state, clearing both members and sets.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkStringManager *	SafeDownCast (vtkObjectBase *o)
static vtkStringManager *	New ()
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Static Public Attributes
static constexpr Hash	Invalid = 0
	An invalid hash (that should never exist inside the manager's storage).

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkStringManager ()=default
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

Manage string-token mappings.

The vtkStringToken class holds an instance of this class to map run-time hashes of strings back to the source string.

Tests:

vtkStringManager (Tests)

Definition at line 27 of file vtkStringManager.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkStringManager::Superclass

Definition at line 30 of file vtkStringManager.h.

Hash

using vtkStringManager::Hash = std::uint32_t

The type of integer used to hash strings.

Definition at line 42 of file vtkStringManager.h.

Visitor

using vtkStringManager::Visitor = std::function<Visit(Hash entry)>

Signature for functions visiting strings in the manager or in a set held by the manager.

Definition at line 45 of file vtkStringManager.h.

Member Enumeration Documentation

Visit

enum vtkStringManager::Visit

An enumerant visitors return to terminate early (or not).

Enumerator
Halt	Terminate visitation.
Continue	Continue visiting items.

Definition at line 35 of file vtkStringManager.h.

Constructor & Destructor Documentation

vtkStringManager()

vtkStringManager::vtkStringManager ( )

protecteddefault

Member Function Documentation

IsTypeOf()

static vtkTypeBool vtkStringManager::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkStringManager::IsA ( const char *  name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

SafeDownCast()

static vtkStringManager * vtkStringManager::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkStringManager::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkStringManager * vtkStringManager::NewInstance

(

)

const

New()

static vtkStringManager * vtkStringManager::New ( )

static

PrintSelf()

void vtkStringManager::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Manage()

Hash vtkStringManager::Manage

(

const std::string &

ss

)

Insert a string into the manager by computing a unique hash (the returned value).

Unmanage()

std::size_t vtkStringManager::Unmanage

(

Hash

hh

)

Remove a hash from the manager.

This also removes it from any string sets. The return value is the number of strings actually removed (0 or 1).

Value()

const std::string & vtkStringManager::Value

(

Hash

hh

)

const

Look up a string from its hashed value, hh.

Find()

Hash vtkStringManager::Find

(

const std::string &

s

)

const

Look up a hash from a string value (without inserting it).

If the string has not been previously managed, then Manager::Invalid will be returned.

Compute()

Hash vtkStringManager::Compute

(

const std::string &

ss

)

const

Compute a hash from a string value (without inserting it into the manager).

If the string is not already managed, this will compute the hash value that would be used if the string were to be immediately inserted. This method allows hash collisions to be avoided; one can compute a hash while the map is write-locked and insert if needed.

Unlike the find() method, this will never return Manager::Invalid.

Insert() [1/2]

Hash vtkStringManager::Insert	(	const std::string &	ss,
		Hash	hh
	)

Add the hash hh to the set ss.

The set ss need not exist prior to this call. It will be added to the manager as needed and then used as a key in the dictionary of sets. The returned value is the hash of the set ss (when passing a string for the set name) or a boolean indicating whether the insertion actually occurred (when passing a hash for the set name). Note that inserting an already-existing member will return false.

Insert() [2/2]

bool vtkStringManager::Insert	(	Hash	ss,
		Hash	hh
	)

Remove() [1/2]

bool vtkStringManager::Remove	(	const std::string &	ss,
		Hash	hh
	)

Remove the hash h from the set s.

This returns true if the hash was removed and false otherwise (i.e., because the set did not exist or did not contain h.

Remove() [2/2]

bool vtkStringManager::Remove	(	Hash	ss,
		Hash	hh
	)

Contains() [1/3]

bool vtkStringManager::Contains	(	const std::string &	ss,
		Hash	hh
	)		const

Return true if the set ss exists and contains hash hh ; and false otherwise.

If ss is Invalid, then this returns true if the hash exists in Data and false otherwise.

Contains() [2/3]

bool vtkStringManager::Contains	(	Hash	ss,
		Hash	hh
	)		const

Contains() [3/3]

bool vtkStringManager::Contains ( Hash  hh ) const

inline

Definition at line 92 of file vtkStringManager.h.

Empty()

bool vtkStringManager::Empty ( ) const

inline

Return true if the manager is empty (i.e., managing no hashes) and false otherwise.

Definition at line 95 of file vtkStringManager.h.

VisitMembers()

Visit vtkStringManager::VisitMembers	(	Visitor	visitor,
		Hash	set = Invalid
	)		const

Visit all members of the set (or the entire Manager if passed the Invalid hash).

Note that this method makes a copy of the set keys at the time it is invoked and visits them. Other threads (or even your visitor) may modify the string manager during traversal, so there is no guarantee when your visitor is invoked that the hash provided to it has a valid entry.

You may terminate early by returning Visit::Halt.

VisitSets()

Visit vtkStringManager::VisitSets

(

Visitor

visitor

)

const

Visit all set names in the manager.

Note that this method makes a copy of the set keys at the time it is invoked and visits them. Other threads (or even your visitor) may modify the string manager during traversal, so there is no guarantee when your visitor is invoked that the hash provided to it has a valid entry.

You may terminate early by returning Visit::Halt.

Reset()

void vtkStringManager::Reset

(

)

Reset the manager to an empty state, clearing both members and sets.

Member Data Documentation

Invalid

constexpr Hash vtkStringManager::Invalid = 0

staticconstexpr

An invalid hash (that should never exist inside the manager's storage).

Definition at line 47 of file vtkStringManager.h.

---

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

• Common/Core/vtkStringManager.h