pqLinksModel Class Reference

A Qt based model to represent the vtkSMLinks in the server manager. More...

#include <pqLinksModel.h>

List of all members.

Public Types
enum	ItemType { Unknown, Proxy, Camera, Property }
	type of link (camera, proxy or property) More...
Public Member Functions
	pqLinksModel (QObject *parent=0)
	construct a links model
	~pqLinksModel ()
	destruct a links model
int	rowCount (const QModelIndex &parent=QModelIndex()) const
	the number of rows (number of links)
int	columnCount (const QModelIndex &parent=QModelIndex()) const
	the number of columns
QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const
	data for an index
QVariant	headerData (int section, Qt::Orientation orient, int role=Qt::DisplayRole) const
	header data
ItemType	getLinkType (const QModelIndex &idx) const
	get the type of link from model index
vtkSMLink *	getLink (const QModelIndex &idx) const
	get the link from model index
QModelIndex	findLink (vtkSMLink *link) const
	search for a link and return model index
vtkSMProxy *	getProxy1 (const QModelIndex &idx) const
	get the first proxy for a link
vtkSMProxy *	getProxy2 (const QModelIndex &idx) const
	get the second proxy for a link
QString	getProperty1 (const QModelIndex &idx) const
	get the first property for a link
QString	getProperty2 (const QModelIndex &idx) const
	get the second property for a link
QString	getLinkName (const QModelIndex &idx) const
	get the name of a link
vtkSMLink *	getLink (const QString &name) const
	get the link from a name
void	addProxyLink (const QString &name, vtkSMProxy *proxy1, vtkSMProxy *proxy2)
	add a proxy based link
void	addCameraLink (const QString &name, vtkSMProxy *proxy1, vtkSMProxy *proxy2)
	add a camera based link
void	addPropertyLink (const QString &name, vtkSMProxy *proxy1, const QString &prop1, vtkSMProxy *proxy2, const QString &prop2)
	add a property based link
void	removeLink (const QModelIndex &idx)
	remove a link by index
void	removeLink (const QString &name)
	remove a link by name
Static Public Member Functions
static pqProxy *	representativeProxy (vtkSMProxy *proxy)
	Return a representative proxy.
static vtkSMProxyListDomain *	proxyListDomain (vtkSMProxy *proxy)
	return the proxy list domain for a proxy this domain is used to get internal linkable proxies
Protected Slots
void	onSessionCreated (pqServer *)
void	onSessionRemoved (pqServer *)

---

Detailed Description

A Qt based model to represent the vtkSMLinks in the server manager.

All links are bi-directional between two proxies.

Definition at line 51 of file pqLinksModel.h.

---

Member Enumeration Documentation

enum pqLinksModel::ItemType

type of link (camera, proxy or property)

Enumerator:

Unknown
Proxy
Camera
Property

Definition at line 58 of file pqLinksModel.h.

---

Constructor & Destructor Documentation

pqLinksModel::pqLinksModel

(

QObject *

parent = 0

)

construct a links model

pqLinksModel::~pqLinksModel

(

)

destruct a links model

---

Member Function Documentation

int pqLinksModel::rowCount

(

const QModelIndex &

parent = QModelIndex()

)

const

the number of rows (number of links)

int pqLinksModel::columnCount

(

const QModelIndex &

parent = QModelIndex()

)

const

the number of columns

QVariant pqLinksModel::data	(	const QModelIndex &	index,
		int	role = Qt::DisplayRole
	)		const

data for an index

QVariant pqLinksModel::headerData	(	int	section,
		Qt::Orientation	orient,
		int	role = Qt::DisplayRole
	)		const

header data

ItemType pqLinksModel::getLinkType

(

const QModelIndex &

idx

)

const

get the type of link from model index

vtkSMLink* pqLinksModel::getLink

(

const QModelIndex &

idx

)

const

get the link from model index

QModelIndex pqLinksModel::findLink

(

vtkSMLink *

link

)

const

search for a link and return model index

vtkSMProxy* pqLinksModel::getProxy1

(

const QModelIndex &

idx

)

const

get the first proxy for a link

vtkSMProxy* pqLinksModel::getProxy2

(

const QModelIndex &

idx

)

const

get the second proxy for a link

QString pqLinksModel::getProperty1

(

const QModelIndex &

idx

)

const

get the first property for a link

QString pqLinksModel::getProperty2

(

const QModelIndex &

idx

)

const

get the second property for a link

QString pqLinksModel::getLinkName

(

const QModelIndex &

idx

)

const

get the name of a link

vtkSMLink* pqLinksModel::getLink

(

const QString &

name

)

const

get the link from a name

void pqLinksModel::addProxyLink	(	const QString &	name,
		vtkSMProxy *	proxy1,
		vtkSMProxy *	proxy2
	)

add a proxy based link

void pqLinksModel::addCameraLink	(	const QString &	name,
		vtkSMProxy *	proxy1,
		vtkSMProxy *	proxy2
	)

add a camera based link

void pqLinksModel::addPropertyLink	(	const QString &	name,
		vtkSMProxy *	proxy1,
		const QString &	prop1,
		vtkSMProxy *	proxy2,
		const QString &	prop2
	)

add a property based link

void pqLinksModel::removeLink

(

const QModelIndex &

idx

)

remove a link by index

void pqLinksModel::removeLink

(

const QString &

name

)

remove a link by name

static pqProxy* pqLinksModel::representativeProxy

(

vtkSMProxy *

proxy

)

[static]

Return a representative proxy.

It could be itself, or in the case of internal proxies, the owning pqProxy.

static vtkSMProxyListDomain* pqLinksModel::proxyListDomain

(

vtkSMProxy *

proxy

)

[static]

return the proxy list domain for a proxy this domain is used to get internal linkable proxies

void pqLinksModel::onSessionCreated

(

pqServer *

)

[protected, slot]

void pqLinksModel::onSessionRemoved

(

pqServer *

)

[protected, slot]

---

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

• /home/kitware/Dashboards/My Tests/ParaView/Qt/Core/pqLinksModel.h