ParaView: vtkSMProxyProperty::vtkPPInternals Class Reference

This class is used by vtkSMProxyProperty to keep track of the proxies. More...

#include <vtkSMProxyPropertyInternals.h>

Public Types
typedef std::vector< vtkSmartPointer< vtkSMProxy > >	SmartVectorOfProxies

typedef std::vector< vtkWeakPointer< vtkSMProxy > >	WeakVectorOfProxies

typedef std::vector< unsigned int >	VectorOfUInts

Public Member Functions
	vtkPPInternals (vtkSMProxyProperty *self)

bool	AddUnchecked (vtkSMProxy *proxy, unsigned int port=0)

bool	Add (vtkSMProxy *proxy, unsigned int port=0)

bool	Remove (vtkSMProxy *proxy)

bool	Resize (unsigned int count)

bool	ResizeUnchecked (unsigned int count)

bool	Clear ()

bool	ClearUnchecked ()

bool	Set (unsigned int index, vtkSMProxy *proxy, unsigned int port=0)

bool	SetUnchecked (unsigned int index, vtkSMProxy *proxy, unsigned int port=0)

bool	Set (unsigned int count, vtkSMProxy *proxies, const unsigned int ports=nullptr)

bool	SetProxies (const SmartVectorOfProxies &otherProxies, const VectorOfUInts &otherPorts)

bool	SetUncheckedProxies (const WeakVectorOfProxies &otherProxies, const VectorOfUInts &otherPorts)

bool	IsAdded (vtkSMProxy *proxy)

const SmartVectorOfProxies &	GetProxies () const

const WeakVectorOfProxies &	GetUncheckedProxies () const

const VectorOfUInts &	GetPorts () const

const VectorOfUInts &	GetUncheckedPorts () const

vtkSMProxy *	Get (unsigned int index) const

vtkSMProxy *	GetUnchecked (unsigned int index) const

unsigned int	GetPort (unsigned int index) const

unsigned int	GetUncheckedPort (unsigned int index) const

bool	WriteTo (paraview_protobuf::Variant *variant) const

bool	ReadFrom (const paraview_protobuf::Variant &variant, vtkSMProxyLocator *locator)

Detailed Description

This class is used by vtkSMProxyProperty to keep track of the proxies.

It keeps proxies as well as output port information which is needed for vtkSMInputProperty. That makes it easier and less error prone to keep the number of ports and proxies in sync and correctly check when values are modified.

Definition at line 26 of file vtkSMProxyPropertyInternals.h.

Member Typedef Documentation

◆ SmartVectorOfProxies

typedef std::vector<vtkSmartPointer<vtkSMProxy> > vtkSMProxyProperty::vtkPPInternals::SmartVectorOfProxies

Definition at line 29 of file vtkSMProxyPropertyInternals.h.

◆ WeakVectorOfProxies

typedef std::vector<vtkWeakPointer<vtkSMProxy> > vtkSMProxyProperty::vtkPPInternals::WeakVectorOfProxies

Definition at line 30 of file vtkSMProxyPropertyInternals.h.

◆ VectorOfUInts

typedef std::vector<unsigned int> vtkSMProxyProperty::vtkPPInternals::VectorOfUInts

Definition at line 31 of file vtkSMProxyPropertyInternals.h.

Constructor & Destructor Documentation

◆ vtkPPInternals()

vtkSMProxyProperty::vtkPPInternals::vtkPPInternals ( vtkSMProxyProperty * self )

inline

Definition at line 110 of file vtkSMProxyPropertyInternals.h.

Member Function Documentation

◆ AddUnchecked()

bool vtkSMProxyProperty::vtkPPInternals::AddUnchecked	(	vtkSMProxy *	proxy,
		unsigned int	port = `0`
	)

inline

Definition at line 122 of file vtkSMProxyPropertyInternals.h.

◆ Add()

bool vtkSMProxyProperty::vtkPPInternals::Add	(	vtkSMProxy *	proxy,
		unsigned int	port = `0`
	)

inline

Definition at line 130 of file vtkSMProxyPropertyInternals.h.

◆ Remove()

bool vtkSMProxyProperty::vtkPPInternals::Remove ( vtkSMProxy * proxy )

inline

Definition at line 137 of file vtkSMProxyPropertyInternals.h.

◆ Resize()

bool vtkSMProxyProperty::vtkPPInternals::Resize ( unsigned int count )

inline

Definition at line 154 of file vtkSMProxyPropertyInternals.h.

◆ ResizeUnchecked()

bool vtkSMProxyProperty::vtkPPInternals::ResizeUnchecked ( unsigned int count )

inline

Definition at line 165 of file vtkSMProxyPropertyInternals.h.

◆ Clear()

bool vtkSMProxyProperty::vtkPPInternals::Clear ( void )

inline

Definition at line 176 of file vtkSMProxyPropertyInternals.h.

◆ ClearUnchecked()

bool vtkSMProxyProperty::vtkPPInternals::ClearUnchecked ( )

inline

Definition at line 187 of file vtkSMProxyPropertyInternals.h.

◆ Set() [1/2]

bool vtkSMProxyProperty::vtkPPInternals::Set	(	unsigned int	index,
		vtkSMProxy *	proxy,
		unsigned int	port = `0`
	)

inline

Definition at line 199 of file vtkSMProxyPropertyInternals.h.

◆ SetUnchecked()

bool vtkSMProxyProperty::vtkPPInternals::SetUnchecked	(	unsigned int	index,
		vtkSMProxy *	proxy,
		unsigned int	port = `0`
	)

inline

Definition at line 216 of file vtkSMProxyPropertyInternals.h.

◆ Set() [2/2]

bool vtkSMProxyProperty::vtkPPInternals::Set	(	unsigned int	count,
		vtkSMProxy **	proxies,
		const unsigned int *	ports = `nullptr`
	)

inline

Definition at line 234 of file vtkSMProxyPropertyInternals.h.

◆ SetProxies()

bool vtkSMProxyProperty::vtkPPInternals::SetProxies	(	const SmartVectorOfProxies &	otherProxies,
		const VectorOfUInts &	otherPorts
	)

inline

Definition at line 256 of file vtkSMProxyPropertyInternals.h.

◆ SetUncheckedProxies()

bool vtkSMProxyProperty::vtkPPInternals::SetUncheckedProxies	(	const WeakVectorOfProxies &	otherProxies,
		const VectorOfUInts &	otherPorts
	)

inline

Definition at line 268 of file vtkSMProxyPropertyInternals.h.

◆ IsAdded()

bool vtkSMProxyProperty::vtkPPInternals::IsAdded ( vtkSMProxy * proxy )

inline

Definition at line 282 of file vtkSMProxyPropertyInternals.h.

◆ GetProxies()

const SmartVectorOfProxies& vtkSMProxyProperty::vtkPPInternals::GetProxies ( ) const

inline

Definition at line 289 of file vtkSMProxyPropertyInternals.h.

◆ GetUncheckedProxies()

const WeakVectorOfProxies& vtkSMProxyProperty::vtkPPInternals::GetUncheckedProxies ( ) const

inline

Definition at line 290 of file vtkSMProxyPropertyInternals.h.

◆ GetPorts()

const VectorOfUInts& vtkSMProxyProperty::vtkPPInternals::GetPorts ( ) const

inline

Definition at line 291 of file vtkSMProxyPropertyInternals.h.

◆ GetUncheckedPorts()

const VectorOfUInts& vtkSMProxyProperty::vtkPPInternals::GetUncheckedPorts ( ) const

inline

Definition at line 292 of file vtkSMProxyPropertyInternals.h.

◆ Get()

vtkSMProxy* vtkSMProxyProperty::vtkPPInternals::Get ( unsigned int index ) const

inline

Definition at line 295 of file vtkSMProxyPropertyInternals.h.

◆ GetUnchecked()

vtkSMProxy* vtkSMProxyProperty::vtkPPInternals::GetUnchecked ( unsigned int index ) const

inline

Definition at line 302 of file vtkSMProxyPropertyInternals.h.

◆ GetPort()

unsigned int vtkSMProxyProperty::vtkPPInternals::GetPort ( unsigned int index ) const

inline

Definition at line 313 of file vtkSMProxyPropertyInternals.h.

◆ GetUncheckedPort()

unsigned int vtkSMProxyProperty::vtkPPInternals::GetUncheckedPort ( unsigned int index ) const

inline

Definition at line 317 of file vtkSMProxyPropertyInternals.h.

◆ WriteTo()

bool vtkSMProxyProperty::vtkPPInternals::WriteTo ( paraview_protobuf::Variant * variant ) const

inline

Definition at line 331 of file vtkSMProxyPropertyInternals.h.

◆ ReadFrom()

bool vtkSMProxyProperty::vtkPPInternals::ReadFrom	(	const paraview_protobuf::Variant &	variant,
		vtkSMProxyLocator *	locator
	)

inline

Definition at line 355 of file vtkSMProxyPropertyInternals.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSMProxyPropertyInternals.h