Public Types | Public Member Functions | List of all members
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 ()
 
void ResetDefaultsToCurrent ()
 
bool IsValueDefault (bool recursive)
 
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 27 of file vtkSMProxyPropertyInternals.h.

Member Typedef Documentation

◆ SmartVectorOfProxies

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

Definition at line 30 of file vtkSMProxyPropertyInternals.h.

◆ WeakVectorOfProxies

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

Definition at line 31 of file vtkSMProxyPropertyInternals.h.

◆ VectorOfUInts

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

Definition at line 32 of file vtkSMProxyPropertyInternals.h.

Constructor & Destructor Documentation

◆ vtkPPInternals()

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

Definition at line 113 of file vtkSMProxyPropertyInternals.h.

Member Function Documentation

◆ AddUnchecked()

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

Definition at line 125 of file vtkSMProxyPropertyInternals.h.

◆ Add()

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

Definition at line 133 of file vtkSMProxyPropertyInternals.h.

◆ Remove()

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

Definition at line 140 of file vtkSMProxyPropertyInternals.h.

◆ Resize()

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

Definition at line 157 of file vtkSMProxyPropertyInternals.h.

◆ ResizeUnchecked()

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

Definition at line 168 of file vtkSMProxyPropertyInternals.h.

◆ Clear()

bool vtkSMProxyProperty::vtkPPInternals::Clear ( void  )
inline

Definition at line 179 of file vtkSMProxyPropertyInternals.h.

◆ ClearUnchecked()

bool vtkSMProxyProperty::vtkPPInternals::ClearUnchecked ( )
inline

Definition at line 190 of file vtkSMProxyPropertyInternals.h.

◆ ResetDefaultsToCurrent()

void vtkSMProxyProperty::vtkPPInternals::ResetDefaultsToCurrent ( )
inline

Definition at line 202 of file vtkSMProxyPropertyInternals.h.

◆ IsValueDefault()

bool vtkSMProxyProperty::vtkPPInternals::IsValueDefault ( bool  recursive)
inline

Definition at line 219 of file vtkSMProxyPropertyInternals.h.

◆ Set() [1/2]

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

Definition at line 257 of file vtkSMProxyPropertyInternals.h.

◆ SetUnchecked()

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

Definition at line 274 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 292 of file vtkSMProxyPropertyInternals.h.

◆ SetProxies()

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

Definition at line 314 of file vtkSMProxyPropertyInternals.h.

◆ SetUncheckedProxies()

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

Definition at line 326 of file vtkSMProxyPropertyInternals.h.

◆ IsAdded()

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

Definition at line 340 of file vtkSMProxyPropertyInternals.h.

◆ GetProxies()

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

Definition at line 347 of file vtkSMProxyPropertyInternals.h.

◆ GetUncheckedProxies()

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

Definition at line 348 of file vtkSMProxyPropertyInternals.h.

◆ GetPorts()

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

Definition at line 349 of file vtkSMProxyPropertyInternals.h.

◆ GetUncheckedPorts()

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

Definition at line 350 of file vtkSMProxyPropertyInternals.h.

◆ Get()

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

Definition at line 353 of file vtkSMProxyPropertyInternals.h.

◆ GetUnchecked()

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

Definition at line 360 of file vtkSMProxyPropertyInternals.h.

◆ GetPort()

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

Definition at line 371 of file vtkSMProxyPropertyInternals.h.

◆ GetUncheckedPort()

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

Definition at line 375 of file vtkSMProxyPropertyInternals.h.

◆ WriteTo()

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

Definition at line 389 of file vtkSMProxyPropertyInternals.h.

◆ ReadFrom()

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

Definition at line 413 of file vtkSMProxyPropertyInternals.h.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.13 on Sat Dec 6 2025