pqTimeKeeper is pqProxy for "TimeKeeper" proxy. More...

#include <pqTimeKeeper.h>

Inheritance diagram for pqTimeKeeper:

Collaboration diagram for pqTimeKeeper:

Signals
void	timeStepsChanged ()
	Fired when the keeper updates the times. More...

void	timeChanged ()
	Fired when the current time changes. More...

void	timeRangeChanged ()
	Fired when the time range changes. More...

Signals inherited from pqProxy
void	nameChanged (pqServerManagerModelItem *)
	Fired when the name of the proxy is changed. More...

void	modifiedStateChanged (pqServerManagerModelItem *)
	Fired when the modified status changes for the proxy. More...

Public Member Functions
	pqTimeKeeper (const QString &group, const QString &name, vtkSMProxy timekeeper, pqServer server, QObject *parent=nullptr)

	~pqTimeKeeper () override

int	getNumberOfTimeStepValues () const
	Returns the number of timestep values known to this time keeper. More...

double	getTimeStepValue (int index) const
	Returns the timestep value at the given index. More...

int	getTimeStepValueIndex (double time) const
	Returns the maximum index in the timestep values for the given time for which timestep value[index] <= time. More...

QList< double >	getTimeSteps () const
	Returns the available timesteps. More...

QPair< double, double >	getTimeRange () const
	Returns the time range. More...

double	getTime () const
	Returns the current time. More...

void	setTime (double time)
	Update the current time. More...

Public Member Functions inherited from pqProxy
	pqProxy (const QString &group, const QString &name, vtkSMProxy proxy, pqServer server, QObject *parent=nullptr)

	~pqProxy () override

pqServer *	getServer () const
	Get the server on which this proxy exists. More...

void	rename (const QString &newname)
	This is a convenience method. More...

const QString &	getSMName ()
	Get the name with which this proxy is registered on the server manager. More...

const QString &	getSMGroup ()

vtkSMProxy *	getProxy () const
	Get the vtkSMProxy this object stands for. More...

ModifiedState	modifiedState () const
	Gets whether or not the source has been modified. More...

void	setModifiedState (ModifiedState modified)
	Sets whether or not the source has been modified. More...

vtkPVXMLElement *	getHints () const
	Returns the hints for this proxy, if any. More...

QList< vtkSMProxy * >	getHelperProxies () const
	Returns a list of all helper proxies. More...

QList< vtkSMProxy * >	getHelperProxies (const QString &key) const
	Returns a list of all the helper proxies added with a given key. More...

QList< QString >	getHelperKeys () const
	Returns the keys for helper proxies. More...

virtual void	addHelperProxy (const QString &key, vtkSMProxy *)
	Concept of helper proxies: A pqProxy is created for every important vtkSMProxy registered. More...

void	removeHelperProxy (const QString &key, vtkSMProxy *)

void	updateHelperProxies () const
	Updates the internal datastructures using the proxies currently registered under the group that would be used for helper proxies. More...

vtkSMSessionProxyManager *	proxyManager () const
	Returns the proxy manager by calling this->getProxy()->GetProxyManager();. More...

bool	userModifiedSMName ()
	Return whether or not the user has modified the GUI name of the source. More...

Public Member Functions inherited from pqServerManagerModelItem
	pqServerManagerModelItem (QObject *parent=nullptr)

	~pqServerManagerModelItem () override

Additional Inherited Members
Public Types inherited from pqProxy
enum	ModifiedState { UNINITIALIZED, MODIFIED, UNMODIFIED }
	The modification state of this proxy. More...

Static Public Member Functions inherited from pqProxy
static pqProxy *	findProxyWithHelper (vtkSMProxy *aproxy, QString &key)
	Returns a pqProxy instance, of any, whose helper proxy is the aproxy. More...

static std::string	rstToHtml (const char *rstStr)
	convert proxy documentation from RST to HTML (so that it can be used in Qt) More...

static QString	rstToHtml (const QString &rstStr)
	convert proxy documentation from RST to HTML (so that it can be used in Qt) More...

Protected Slots inherited from pqProxy
void	onProxyRegistered (const QString &, const QString &, vtkSMProxy *)

void	onProxyUnRegistered (const QString &, const QString &, vtkSMProxy *)

Protected Member Functions inherited from pqProxy
void	setSMName (const QString &new_name)
	Make this pqProxy take on a new identity. More...

virtual void	initialize ()

virtual void	addInternalHelperProxy (const QString &key, vtkSMProxy *) const

virtual void	removeInternalHelperProxy (const QString &key, vtkSMProxy *) const

Protected Member Functions inherited from pqServerManagerModelItem
vtkEventQtSlotConnect *	getConnector ()
	All subclasses generally need some vtkEventQtSlotConnect instance to connect to VTK events. More...

Detailed Description

pqTimeKeeper is pqProxy for "TimeKeeper" proxy.

A timekeeper is created by default per connection. pqServer keeps a pointer to the connection's time keeper. A time keeper keeps track of the global time and timesteps available currently.

Definition at line 18 of file pqTimeKeeper.h.

Constructor & Destructor Documentation

◆ pqTimeKeeper()

pqTimeKeeper::pqTimeKeeper	(	const QString &	group,
		const QString &	name,
		vtkSMProxy *	timekeeper,
		pqServer *	server,
		QObject *	parent = `nullptr`
	)

◆ ~pqTimeKeeper()

pqTimeKeeper::~pqTimeKeeper ( )

override

Member Function Documentation

◆ getNumberOfTimeStepValues()

int pqTimeKeeper::getNumberOfTimeStepValues ( ) const

Returns the number of timestep values known to this time keeper.

◆ getTimeStepValue()

double pqTimeKeeper::getTimeStepValue ( int index ) const

Returns the timestep value at the given index.

index < getNumberOfTimeStepValues().

◆ getTimeStepValueIndex()

int pqTimeKeeper::getTimeStepValueIndex ( double time ) const

Returns the maximum index in the timestep values for the given time for which timestep value[index] <= time.

◆ getTimeSteps()

QList<double> pqTimeKeeper::getTimeSteps ( ) const

Returns the available timesteps.

◆ getTimeRange()

QPair<double, double> pqTimeKeeper::getTimeRange ( ) const

Returns the time range.

Return (0,0) is getNumberOfTimeStepValues() == 0.

◆ getTime()

double pqTimeKeeper::getTime ( ) const

Returns the current time.

◆ setTime()

void pqTimeKeeper::setTime ( double time )

Update the current time.

◆ timeStepsChanged

void pqTimeKeeper::timeStepsChanged ( )

signal

Fired when the keeper updates the times.

◆ timeChanged

void pqTimeKeeper::timeChanged ( )

signal

Fired when the current time changes.

◆ timeRangeChanged

void pqTimeKeeper::timeRangeChanged ( )

signal

Fired when the time range changes.

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

/builds/gitlab-kitware-sciviz-ci/Qt/Core/pqTimeKeeper.h

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pqTimeKeeper()

◆ ~pqTimeKeeper()

Member Function Documentation

◆ getNumberOfTimeStepValues()

◆ getTimeStepValue()

◆ getTimeStepValueIndex()

◆ getTimeSteps()

◆ getTimeRange()

◆ getTime()

◆ setTime()

◆ timeStepsChanged

◆ timeChanged

◆ timeRangeChanged