Utility class used for string formatting. More...

#include <vtkPVStringFormatter.h>

Inheritance diagram for vtkPVStringFormatter:

Collaboration diagram for vtkPVStringFormatter:

[legend]

Classes
class	TraceScope
	This subclass should ONLY be used to enable automatic push/pop of argument scopes in the same scope of code. More...

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkPVStringFormatter *	New ()

static int	IsTypeOf (const char *type)

static vtkPVStringFormatter *	SafeDownCast (vtkObject *o)

template<typename... Args>
static void	PushScope (Args &&... args)
	Pushes arguments using fmt::arg(name, arg) to add a new scope to the scope stack. More...

template<typename... Args>
static void	PushScope (const char *scopeName, Args &&... args)
	Pushes arguments using a scope name and arguments in the form of fmt::arg(name, arg) to add a new scope to the scope stack. More...

static void	PopScope ()
	Pops the top scope of the scope stack. More...

static std::string	Format (const std::string &formattableString)
	Given a formattable string, use the top scope of the argument stack, and return the formatted string. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkPVStringFormatter ()

	~vtkPVStringFormatter () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Utility class used for string formatting.

vtkPVStringFormatter is a utility class that defines the API for formatting strings using a stack of argument scopes. Scopes can be created by defining arguments using the fmt library. A string will always be formatted using the top argument scope in the scope stack.

Definition at line 33 of file vtkPVStringFormatter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPVStringFormatter::Superclass

Definition at line 37 of file vtkPVStringFormatter.h.

Constructor & Destructor Documentation

◆ vtkPVStringFormatter()

vtkPVStringFormatter::vtkPVStringFormatter ( )

protected

◆ ~vtkPVStringFormatter()

vtkPVStringFormatter::~vtkPVStringFormatter ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPVStringFormatter* vtkPVStringFormatter::New ( )

static

◆ GetClassName()

virtual const char* vtkPVStringFormatter::GetClassName ( )

virtual

◆ IsTypeOf()

static int vtkPVStringFormatter::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkPVStringFormatter::IsA ( const char * type )

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkPVStringFormatter* vtkPVStringFormatter::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ PushScope() [1/2]

template<typename... Args>

static void vtkPVStringFormatter::PushScope ( Args &&... args )

inlinestatic

Pushes arguments using fmt::arg(name, arg) to add a new scope to the scope stack.

The new scope has as a baseline the top scope of the scope stack.

Definition at line 67 of file vtkPVStringFormatter.h.

◆ PushScope() [2/2]

template<typename... Args>

static void vtkPVStringFormatter::PushScope	(	const char *	scopeName,
		Args &&...	args
	)

inlinestatic

Pushes arguments using a scope name and arguments in the form of fmt::arg(name, arg) to add a new scope to the scope stack.

E.g. if PushScope("TEST", fmt::arg("test1", test)) is used then the scope the scope will have the following arguments: TEST_test1 and test1, The new scope has as a baseline the top scope of the scope stack.

Note: If you want to call this function, scope name MUST be const char*, otherwise the implementation of this function without the scope name will be invoked.

Definition at line 94 of file vtkPVStringFormatter.h.

◆ PopScope()

static void vtkPVStringFormatter::PopScope ( )

static

Pops the top scope of the scope stack.

◆ Format()

static std::string vtkPVStringFormatter::Format ( const std::string & formattableString )

static

Given a formattable string, use the top scope of the argument stack, and return the formatted string.

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

/builds/gitlab-kitware-sciviz-ci/VTKExtensions/Core/vtkPVStringFormatter.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPVStringFormatter()

◆ ~vtkPVStringFormatter()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ PushScope() [1/2]

◆ PushScope() [2/2]

◆ PopScope()

◆ Format()