reference for an output port of a vtkAlgorithm. More...

#include <vtkSMOutputPort.h>

Inheritance diagram for vtkSMOutputPort:

Collaboration diagram for vtkSMOutputPort:

[legend]

Public Types
typedef vtkSMProxy	Superclass

Public Types inherited from vtkSMProxy
enum	ResetPropertiesMode { DEFAULT = 0, ONLY_XML = 1, ONLY_DOMAIN = 2 }

enum	{ COPY_PROXY_PROPERTY_VALUES_BY_REFERENCE = 0, COPY_PROXY_PROPERTY_VALUES_BY_CLONING }
	Flags used for the proxyPropertyCopyFlag argument to the Copy method. More...

typedef vtkSMRemoteObject	Superclass

Public Types inherited from vtkSMRemoteObject
typedef vtkSMSessionObject	Superclass

Public Types inherited from vtkSMSessionObject
typedef vtkSMObject	Superclass

Public Types inherited from vtkSMObject
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual vtkPVDataInformation *	GetDataInformation ()
	Returns data information. More...

vtkPVDataInformation *	GetRankDataInformation (int rank)
	Get rank-specific data information. More...

vtkPVDataInformation *	GetSubsetDataInformation (unsigned int compositeIndex)
	A `GetSubsetDataInformation` overload that uses composite index. More...

virtual vtkPVTemporalDataInformation *	GetTemporalDataInformation ()
	Returns data information collected over all timesteps provided by the pipeline. More...

virtual const char *	GetDataClassName ()
	Returns the classname of the data object on this output port. More...

virtual vtkPVClassNameInformation *	GetClassNameInformation ()
	Returns classname information. More...

virtual void	InvalidateDataInformation ()
	Mark data information as invalid. More...

vtkSMSourceProxy *	GetSourceProxy ()
	Provides access to the source proxy to which the output port belongs. More...


vtkPVDataInformation *	GetSubsetDataInformation (const char selector, const char assemblyName=nullptr)
	For composite datasets, `GetDataInformation` returns summary data information for all blocks combined. More...


vtkPVTemporalDataInformation *	GetTemporalSubsetDataInformation (const char selector, const char assemblyName=nullptr)
	Get Temporal data information for a specific selector. More...


virtual int	GetPortIndex ()
	Returns the index of the port the output is obtained from. More...


vtkSMSession *	GetSession () override
	Overridden to forward to the source proxy. More...

vtkSMSessionProxyManager *	GetSessionProxyManager () override
	Overridden to forward to the source proxy. More...

Public Member Functions inherited from vtkSMProxy
void	PrintSelf (ostream &os, vtkIndent indent) override

void	SetAnnotation (const char key, const char value)

const char *	GetAnnotation (const char *key)
	Retrieve an annotation with a given key. More...

void	RemoveAnnotation (const char *key)
	Remove a given annotation based on its key to the proxy. More...

void	RemoveAllAnnotations ()
	Remove all proxy annotations. More...

bool	HasAnnotation (const char *key)
	Return true if a given annotation exists. More...

int	GetNumberOfAnnotations ()
	Return the number of available annotations. More...

const char *	GetAnnotationKeyAt (int index)
	Return the nth key of the available annotations. More...

void	SetLocation (vtkTypeUInt32) override
	Get/Set the location where the underlying VTK-objects are created. More...

virtual vtkSMProperty *	GetProperty (const char *name)
	Return the property with the given name. More...

virtual vtkSMProperty *	GetProperty (const char *name, int selfOnly)
	Return a property of the given name from self or one of the sub-proxies. More...

const char *	GetPropertyName (vtkSMProperty *prop)
	Given a property pointer, returns the name that was used to add it to the proxy. More...

virtual void	UpdateVTKObjects ()
	Update the VTK object on the server by pushing the values of all modified properties (un-modified properties are ignored). More...

virtual void	RecreateVTKObjects ()
	Recreate the VTK object for this proxy. More...

void	InvokeCommand (const char *name)
	Convenience method equivalent to UpdateProperty(name, 1). More...

virtual vtkSMPropertyIterator *	NewPropertyIterator ()
	Returns a new (initialized) iterator of the properties. More...

unsigned int	GetNumberOfConsumers ()
	Returns the number of consumers. More...

vtkSMProxy *	GetConsumerProxy (unsigned int idx)
	Returns the consumer of given index. More...

vtkSMProperty *	GetConsumerProperty (unsigned int idx)
	Returns the corresponding property of the consumer of given index. More...

unsigned int	GetNumberOfProducers ()
	Returns the number of proxies this proxy depends on (uses or is connected to through the pipeline). More...

vtkSMProxy *	GetProducerProxy (unsigned int idx)
	Returns a proxy this proxy depends on, given index. More...

vtkSMProperty *	GetProducerProperty (unsigned int idx)
	Returns the property holding a producer proxy given an index. More...

virtual void	UpdatePropertyInformation ()
	Updates all property information by calling UpdateInformation() and populating the values. More...

virtual void	UpdatePropertyInformation (vtkSMProperty *prop)
	Similar to UpdatePropertyInformation() but updates only the given property. More...

virtual void	MarkAllPropertiesAsModified ()
	Marks all properties as modified. More...

virtual void	ResetPropertiesToXMLDefaults ()
	Use this method to set all properties on this proxy to their default values. More...

virtual void	ResetPropertiesToDomainDefaults ()
	Use this method to set all properties on this proxy to their default domains. More...

virtual void	ResetPropertiesToDefault (ResetPropertiesMode mode=DEFAULT)
	Use this method to set all properties on this proxy to their default domain or values. More...

virtual void	MarkModified (vtkSMProxy *modifiedProxy)
	Calls MarkDirty() and invokes ModifiedEvent. More...

void	InitializeAndCopyFromProxy (vtkSMProxy *source)
	Given a source proxy, makes this proxy point to the same server-side object (with a new id). More...

virtual void	MarkDirty (vtkSMProxy *modifiedProxy)
	Dirty means this algorithm will execute during next update. More...

vtkObjectBase *	GetClientSideObject ()
	Returns the client side object associated with the VTKObjectID (if any). More...

virtual vtkPVXMLElement *	SaveXMLState (vtkPVXMLElement *root)
	Saves the state of the proxy. More...

virtual vtkPVXMLElement *	SaveXMLState (vtkPVXMLElement root, vtkSMPropertyIterator iter)
	The iterator is use to filter the property available on the given proxy. More...

virtual int	LoadXMLState (vtkPVXMLElement element, vtkSMProxyLocator locator)
	Loads the proxy state from the XML element. More...

void	UpdateSelfAndAllInputs ()
	This method call UpdateVTKObjects on the current pipeline by starting at the sources. More...

bool	GetIsSubProxy ()
	A proxy instance can be a sub-proxy for some other proxy. More...

vtkSMProxy *	GetParentProxy ()
	If this instance is a sub-proxy, this method will return the proxy of which this instance is an immediate sub-proxy. More...

vtkSMProxy *	GetTrueParentProxy ()
	Call GetParentProxy() recursively till a proxy that is not a subproxy of any other proxy is found. More...

void	EnableLocalPushOnly () override
	Allow to switch off any push of state change to the server for that particular object. More...

void	DisableLocalPushOnly () override
	Enable the given remote object to communicate its state normally to the server location. More...

const vtkSMMessage *	GetFullState () override
	This method return the full object state that can be used to create that object from scratch. More...

void	LoadState (const vtkSMMessage msg, vtkSMProxyLocator locator) override
	This method is used to initialise the object to the given state If the definitionOnly Flag is set to True the proxy won't load the properties values and just setup the new proxy hierarchy with all subproxy globalID set. More...

vtkSMPropertyGroup *	GetPropertyGroup (size_t index) const
	Returns the property group at `index` for the proxy. More...

size_t	GetNumberOfPropertyGroups () const
	Returns the number of property groups that the proxy contains. More...

const char *	GetLogNameOrDefault ()
	A helper that makes up an default name if none is provided. More...

bool	GetPropertiesModified ()

bool	UpdateProperty (const char *name)
	Update the value of one property (pushed to the server) if it is modified. More...

bool	UpdateProperty (const char *name, int force)
	Update the value of one property (pushed to the server) if it is modified. More...

virtual char *	GetVTKClassName ()
	Returns the type of object managed by the proxy. More...

virtual void	SetVTKClassName (const char *)
	the type of object created by the proxy. More...

virtual char *	GetXMLName ()
	Assigned by the XML parser. More...

virtual char *	GetXMLGroup ()
	Assigned by the XML parser. More...

virtual char *	GetXMLLabel ()
	Assigned by the XML parser. More...

void	Copy (vtkSMProxy *src)
	Copies values of all the properties and sub-proxies from src. More...

void	Copy (vtkSMProxy src, const char exceptionClass)
	Copies values of all the properties and sub-proxies from src. More...

virtual void	Copy (vtkSMProxy src, const char exceptionClass, int proxyPropertyCopyFlag)
	Copies values of all the properties and sub-proxies from src. More...

virtual vtkSMDocumentation *	GetDocumentation ()
	Returns the documentation for this proxy. More...

virtual vtkPVXMLElement *	GetHints ()
	The server manager configuration XML may define `<Hints/>` element for a proxy. More...

virtual int	GetObjectsCreated ()
	Returns if the VTK objects for this proxy have been created. More...

bool	GatherInformation (vtkPVInformation *information)
	Gathers information about this proxy. More...

bool	GatherInformation (vtkPVInformation *information, vtkTypeUInt32 location)
	Gathers information about this proxy. More...

void	PrototypeOn () override
	Allow user to set the remote object to be discard for Undo/Redo action. More...

void	PrototypeOff () override
	Allow user to set the remote object to be discard for Undo/Redo action. More...

void	SetPrototype (bool undo) override
	Allow user to set the remote object to be discard for Undo/Redo action. More...

void	SetLogName (const char *name)
	Log name is a name for this proxy that will be used when logging status messages. More...

virtual char *	GetLogName ()
	Log name is a name for this proxy that will be used when logging status messages. More...

Public Member Functions inherited from vtkSMRemoteObject
void	PrintSelf (ostream &os, vtkIndent indent) override

void	SetSession (vtkSMSession *) override
	Override the SetSession so if the object already have an ID we automatically register it to the associated session. More...

bool	HasGlobalID ()
	Allow the user to test if the RemoteObject has already a GlobalID without assigning a new one to it. More...

virtual bool	IsLocalPushOnly ()
	Let the session be aware that even if the Location is client only, the message should not be send to the server for a general broadcast. More...

virtual vtkTypeUInt32	GetLocation ()
	Get/Set the location where the underlying VTK-objects are created. More...

virtual vtkTypeUInt32	GetGlobalID ()
	Get the global unique id for this object. More...

const char *	GetGlobalIDAsString ()
	Get the global unique id for this object. More...

bool	IsPrototype ()
	Allow user to set the remote object to be discard for Undo/Redo action. More...

Public Member Functions inherited from vtkSMSessionObject
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 vtkSMOutputPort *	New ()

static int	IsTypeOf (const char *type)

static vtkSMOutputPort *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

static vtkSMProxy *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMRemoteObject
static int	IsTypeOf (const char *type)

static vtkSMRemoteObject *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

static vtkSMSessionObject *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

static vtkSMObject *	SafeDownCast (vtkObject *o)

static std::string	CreatePrettyLabel (const std::string &name)
	Return a well-formated label using provided name by adding spaces between lower cases and upper cases: 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
	vtkSMOutputPort ()

	~vtkSMOutputPort () override

virtual void	GatherClassNameInformation ()
	Get the classname of the dataset from server. More...

virtual void	GatherDataInformation ()
	Get information about dataset from server. More...

virtual void	GatherTemporalDataInformation ()
	Get temporal information from the server. More...

void	SetSourceProxy (vtkSMSourceProxy *src)

void	SetCompoundSourceProxy (vtkSMCompoundSourceProxy *src)

virtual void	UpdatePipelineInternal (double time, bool doTime)
	An internal update pipeline method that subclasses may override. More...

virtual void	SetPortIndex (int)

Protected Member Functions inherited from vtkSMProxy
	vtkSMProxy ()

	~vtkSMProxy () override

void	ExecuteStream (const vtkClientServerStream &msg, bool ignore_errors=false, vtkTypeUInt32 location=0)
	Invoke that takes a vtkClientServerStream as the argument. More...

virtual void	UpdateAndPushAnnotationState ()

virtual void	AddProperty (const char name, vtkSMProperty prop)
	Add a property with the given key (name). More...

virtual void	MarkConsumersAsDirty (vtkSMProxy *modifiedProxy)
	Calls `MarkDirtyFromProducer` on all consumers. More...

virtual void	MarkDirtyFromProducer (vtkSMProxy modifiedProxy, vtkSMProxy producer, vtkSMProperty *property)
	`MarkConsumersAsDirty` calls this method on each consumer, instead of directly calling `MarkDirty` on the consumer. More...

void	MarkInputsAsDirty ()
	This method is called by vtkSMRepresentationProxy whenever the time request for the pipeline may have potentially changed. More...

virtual void	CreateVTKObjects ()
	Given a class name (by setting VTKClassName) and server ids (by setting ServerIDs), this methods instantiates the objects on the server(s) More...

void	RemoveAllObservers ()
	Cleanup code. More...

virtual void	SetPropertyModifiedFlag (const char *name, int flag)
	Note on property modified flags: The modified flag of each property associated with a proxy is stored in the proxy object instead of in the property itself. More...

void	AddSubProxy (const char name, vtkSMProxy proxy, int overrideOK=0)
	Add a sub-proxy. More...

void	RemoveSubProxy (const char *name)
	Remove a sub-proxy. More...

vtkSMProxy *	GetSubProxy (const char *name)
	Returns a sub-proxy. More...

vtkSMProxy *	GetSubProxy (unsigned int index)
	Returns a sub-proxy. More...

const char *	GetSubProxyName (unsigned int index)
	Returns the name used to store sub-proxy. More...

const char *	GetSubProxyName (vtkSMProxy *)
	Returns the name used to store sub-proxy. More...

unsigned int	GetNumberOfSubProxies ()
	Returns the number of sub-proxies. More...

virtual void	AddConsumer (vtkSMProperty property, vtkSMProxy proxy)
	Called by a proxy property, this adds the property,proxy pair to the list of consumers. More...

virtual void	RemoveConsumer (vtkSMProperty property, vtkSMProxy proxy)
	Remove the property,proxy pair from the list of consumers. More...

virtual void	RemoveAllConsumers ()
	Remove all consumers. More...

void	AddProducer (vtkSMProperty property, vtkSMProxy proxy)
	Called by an proxy/input property to add property, proxy pair to the list of producers. More...

void	RemoveProducer (vtkSMProperty property, vtkSMProxy proxy)
	Remove the property,proxy pair from the list of producers. More...

virtual void	PostUpdateData (bool using_cache)
	This method is called after the algorithm(s) (if any) associated with this proxy execute. More...

void	PostUpdateDataSelfOnly (bool using_cache)
	This is called by `PostUpdateData` to only update state for this proxy without iterative over producers. More...

bool	WarnIfDeprecated ()
	If a proxy is deprecated, prints a warning. More...

virtual void	UpdatePipelineInformation ()
	This method simply iterates over subproxies and calls UpdatePipelineInformation() on them. More...

void	LinkProperty (vtkSMProperty inputProperty, vtkSMProperty outputProperty)
	Links properties such that when inputProperty's checked or unchecked values are changed, the outputProperty's corresponding values are also changed. More...

vtkSMPropertyGroup *	NewPropertyGroup (vtkPVXMLElement *propElement)
	Parses the XML to create a new property group. More...

void	AppendPropertyGroup (vtkSMPropertyGroup *group)
	Adds a property groups. More...

void	ExposeSubProxyProperty (const char subproxy_name, const char property_name, const char *exposed_name, int overrideOK=0)
	Expose a subproxy property from the base proxy. More...

virtual void	ExecuteSubProxyEvent (vtkSMProxy o, unsigned long event, void data)
	Handle events fired by subproxies. More...

virtual int	CreateSubProxiesAndProperties (vtkSMSessionProxyManager pm, vtkPVXMLElement element)

virtual void	UpdatePropertyInformationInternal (vtkSMProperty *prop=nullptr)
	Called to update the property information on the property. More...

void	RebuildStateForProperties ()
	vtkSMProxy tracks state of properties on this proxy in an internal State object. More...

virtual void	SetLogNameInternal (const char *name, bool propagate_to_subproxies, bool propagate_to_proxylistdomains)
	Internal method used by `SetLogName` More...

bool	ArePropertiesModified ()
	Indicates if any properties are modified. More...

void	SetHints (vtkPVXMLElement *hints)

void	SetDeprecated (vtkPVXMLElement *deprecated)

void	SetXMLElement (vtkPVXMLElement *element)

	vtkSMProxy (const vtkSMProxy &)=delete

void	operator= (const vtkSMProxy &)=delete

virtual const vtkClientServerStream &	GetLastResult ()
	Get the last result. More...

virtual const vtkClientServerStream &	GetLastResult (vtkTypeUInt32 location)
	Get the last result. More...

virtual void	SetXMLName (const char *)
	Assigned by the XML parser. More...

virtual void	SetXMLGroup (const char *)
	Assigned by the XML parser. More...

virtual void	SetXMLLabel (const char *)
	Assigned by the XML parser. More...

virtual void	SetXMLSubProxyName (const char *)
	Assigned by the XML parser. More...

vtkSMProperty *	NewProperty (const char *name)
	Creates a new property and initializes it by calling ReadXMLAttributes() with the right XML element. More...

vtkSMProperty *	NewProperty (const char name, vtkPVXMLElement propElement)
	Creates a new property and initializes it by calling ReadXMLAttributes() with the right XML element. More...

virtual int	ReadXMLAttributes (vtkSMSessionProxyManager pm, vtkPVXMLElement element)
	Read attributes from an XML element. More...

void	SetupExposedProperties (const char subproxy_name, vtkPVXMLElement element)
	Read attributes from an XML element. More...

void	SetupSharedProperties (vtkSMProxy subproxy, vtkPVXMLElement element)
	Read attributes from an XML element. More...

virtual void	SetSIClassName (const char *)
	SIClassName identifies the classname for the helper on the server side. More...

virtual char *	GetSIClassName ()
	SIClassName identifies the classname for the helper on the server side. More...

Protected Member Functions inherited from vtkSMRemoteObject
	vtkSMRemoteObject ()
	Default constructor. More...

	~vtkSMRemoteObject () override
	Destructor. More...

void	PushState (vtkSMMessage *msg)
	Subclasses can call this method to send a message to its state object on the server processes specified. More...

bool	PullState (vtkSMMessage *msg)
	Subclasses can call this method to pull the state from the state-object on the server processes specified. More...

void	SetGlobalID (vtkTypeUInt32 guid)
	Set the GlobalUniqueId. More...

vtkTypeUInt32	GetFilteredLocation ()

Protected Member Functions inherited from vtkSMSessionObject
	vtkSMSessionObject ()

	~vtkSMSessionObject () override

Protected Member Functions inherited from vtkSMObject
	vtkSMObject ()

	~vtkSMObject () 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 &)

Protected Attributes
int	PortIndex

vtkWeakPointer< vtkSMSourceProxy >	SourceProxy

vtkWeakPointer< vtkSMCompoundSourceProxy >	CompoundSourceProxy

vtkPVClassNameInformation *	ClassNameInformation

int	ClassNameInformationValid

vtkPVDataInformation *	DataInformation

bool	DataInformationValid

vtkPVTemporalDataInformation *	TemporalDataInformation

bool	TemporalDataInformationValid

std::map< std::string, std::map< int, vtkSmartPointer< vtkPVDataInformation > > >	SubsetDataInformations

std::map< std::string, std::map< int, vtkSmartPointer< vtkPVTemporalDataInformation > > >	TemporalSubsetDataInformations

std::map< int, vtkSmartPointer< vtkPVDataInformation > >	RankDataInformations

Protected Attributes inherited from vtkSMProxy
bool	NeedsUpdate

char *	VTKClassName

char *	XMLGroup

char *	XMLName

char *	XMLLabel

char *	XMLSubProxyName

int	ObjectsCreated

int	DoNotUpdateImmediately

int	DoNotModifyProperty

int	InUpdateVTKObjects
	Avoids calls to UpdateVTKObjects in UpdateVTKObjects. More...

bool	PropertiesModified
	Flag used to help speed up UpdateVTKObjects and ArePropertiesModified calls. More...

vtkPVXMLElement *	XMLElement

vtkSMDocumentation *	Documentation

vtkPVXMLElement *	Hints

vtkPVXMLElement *	Deprecated

vtkSMMessage *	State

int	InMarkModified

vtkWeakPointer< vtkSMProxy >	ParentProxy

vtkSMProxyInternals *	Internals

vtkSMProxyObserver *	SubProxyObserver

char *	SIClassName
	SIClassName identifies the classname for the helper on the server side. More...

Protected Attributes inherited from vtkSMRemoteObject
vtkTypeUInt32	GlobalID

vtkTypeUInt32	Location

bool	Prototype

bool	ClientOnlyLocationFlag

Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSession >	Session
	Identifies the session id to which this object is related. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkSMSourceProxy

class	vtkSMCompoundSourceProxy

Detailed Description

reference for an output port of a vtkAlgorithm.

This object manages one output port of an algorithm. It is used internally by vtkSMSourceProxy to manage all of it's outputs.

Attention: Previously, vtkSMOutputPort used to be a vtkSMProxy subclass since it was indeed a Proxy for the output port. However that has now changed. This merely sits as a datastructure to manage ports specific things like data-information. However for backwards compatibility, to keep the impact minimal, we leave this as a sub-class of a Proxy with GlobalID=0 and Session=nullptr.

Definition at line 36 of file vtkSMOutputPort.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMProxy vtkSMOutputPort::Superclass

Definition at line 40 of file vtkSMOutputPort.h.

Constructor & Destructor Documentation

◆ vtkSMOutputPort()

vtkSMOutputPort::vtkSMOutputPort ( )

protected

◆ ~vtkSMOutputPort()

vtkSMOutputPort::~vtkSMOutputPort ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMOutputPort* vtkSMOutputPort::New ( )

static

◆ GetClassName()

virtual const char* vtkSMOutputPort::GetClassName ( )

virtual

Reimplemented from vtkSMProxy.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMProxy.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMObject.

◆ GetDataInformation()

virtual vtkPVDataInformation* vtkSMOutputPort::GetDataInformation ( )

virtual

Returns data information.

If data information is marked invalid, calls GatherDataInformation. If data information is gathered then this fires the vtkCommand::UpdateInformationEvent event.

◆ GetRankDataInformation()

vtkPVDataInformation* vtkSMOutputPort::GetRankDataInformation ( int rank )

Get rank-specific data information.

◆ GetSubsetDataInformation() [1/2]

vtkPVDataInformation* vtkSMOutputPort::GetSubsetDataInformation	(	const char *	selector,
		const char *	assemblyName = `nullptr`
	)

For composite datasets, GetDataInformation returns summary data information for all blocks combined.

However, applications may require information about specific subset of blocks. In that case, one can use this API. Internally, the data information is cached per selector / assembly-name pair. That way, if the data information is not re-gathered unless changed.

selector the selector expression
assemblyName name of the assembly to use to apply the selector to determine the subset. If none specified, hierarchy is assumed.

◆ GetSubsetDataInformation() [2/2]

vtkPVDataInformation* vtkSMOutputPort::GetSubsetDataInformation ( unsigned int compositeIndex )

A GetSubsetDataInformation overload that uses composite index.

It is only supported for multiblock datasets.

◆ GetTemporalDataInformation()

virtual vtkPVTemporalDataInformation* vtkSMOutputPort::GetTemporalDataInformation ( )

virtual

Returns data information collected over all timesteps provided by the pipeline.

If the data information is not valid, this results iterating over the pipeline and hence can be slow. Use with caution.

◆ GetTemporalSubsetDataInformation()

vtkPVTemporalDataInformation* vtkSMOutputPort::GetTemporalSubsetDataInformation	(	const char *	selector,
		const char *	assemblyName = `nullptr`
	)

Get Temporal data information for a specific selector.

selector the selector expression
assemblyName name of the assembly to use to apply the selector to determine the subset. If none specified, hierarchy is assumed.

◆ GetDataClassName()

virtual const char* vtkSMOutputPort::GetDataClassName ( )

virtual

Returns the classname of the data object on this output port.

◆ GetClassNameInformation()

virtual vtkPVClassNameInformation* vtkSMOutputPort::GetClassNameInformation ( )

virtual

Returns classname information.

◆ InvalidateDataInformation()

virtual void vtkSMOutputPort::InvalidateDataInformation ( )

virtual

Mark data information as invalid.

◆ GetPortIndex()

virtual int vtkSMOutputPort::GetPortIndex ( )

virtual

Returns the index of the port the output is obtained from.

◆ GetSourceProxy()

vtkSMSourceProxy* vtkSMOutputPort::GetSourceProxy ( )

Provides access to the source proxy to which the output port belongs.

◆ GetSession()

vtkSMSession* vtkSMOutputPort::GetSession ( )

overridevirtual

Overridden to forward to the source proxy.

Reimplemented from vtkSMSessionObject.

◆ GetSessionProxyManager()

vtkSMSessionProxyManager* vtkSMOutputPort::GetSessionProxyManager ( )

overridevirtual

Overridden to forward to the source proxy.

Reimplemented from vtkSMSessionObject.

◆ GatherClassNameInformation()

virtual void vtkSMOutputPort::GatherClassNameInformation ( )

protectedvirtual

Get the classname of the dataset from server.

◆ GatherDataInformation()

virtual void vtkSMOutputPort::GatherDataInformation ( )

protectedvirtual

Get information about dataset from server.

Fires the vtkCommand::UpdateInformationEvent event.

◆ GatherTemporalDataInformation()

virtual void vtkSMOutputPort::GatherTemporalDataInformation ( )

protectedvirtual

Get temporal information from the server.

◆ SetSourceProxy()

void vtkSMOutputPort::SetSourceProxy ( vtkSMSourceProxy * src )

protected

◆ SetCompoundSourceProxy()

void vtkSMOutputPort::SetCompoundSourceProxy ( vtkSMCompoundSourceProxy * src )

protected

◆ UpdatePipelineInternal()

virtual void vtkSMOutputPort::UpdatePipelineInternal	(	double	time,
		bool	doTime
	)

protectedvirtual

An internal update pipeline method that subclasses may override.

◆ SetPortIndex()

virtual void vtkSMOutputPort::SetPortIndex ( int )

protectedvirtual

Friends And Related Function Documentation

◆ vtkSMSourceProxy

friend class vtkSMSourceProxy

friend

Definition at line 189 of file vtkSMOutputPort.h.

◆ vtkSMCompoundSourceProxy

friend class vtkSMCompoundSourceProxy

friend

Definition at line 190 of file vtkSMOutputPort.h.

Member Data Documentation

◆ PortIndex

int vtkSMOutputPort::PortIndex

protected

Definition at line 164 of file vtkSMOutputPort.h.

◆ SourceProxy

vtkWeakPointer<vtkSMSourceProxy> vtkSMOutputPort::SourceProxy

protected

Definition at line 167 of file vtkSMOutputPort.h.

◆ CompoundSourceProxy

vtkWeakPointer<vtkSMCompoundSourceProxy> vtkSMOutputPort::CompoundSourceProxy

protected

Definition at line 168 of file vtkSMOutputPort.h.

◆ ClassNameInformation

vtkPVClassNameInformation* vtkSMOutputPort::ClassNameInformation

protected

Definition at line 170 of file vtkSMOutputPort.h.

◆ ClassNameInformationValid

int vtkSMOutputPort::ClassNameInformationValid

protected

Definition at line 171 of file vtkSMOutputPort.h.

◆ DataInformation

vtkPVDataInformation* vtkSMOutputPort::DataInformation

protected

Definition at line 173 of file vtkSMOutputPort.h.

◆ DataInformationValid

bool vtkSMOutputPort::DataInformationValid

protected

Definition at line 174 of file vtkSMOutputPort.h.

◆ TemporalDataInformation

vtkPVTemporalDataInformation* vtkSMOutputPort::TemporalDataInformation

protected

Definition at line 176 of file vtkSMOutputPort.h.

◆ TemporalDataInformationValid

bool vtkSMOutputPort::TemporalDataInformationValid

protected

Definition at line 177 of file vtkSMOutputPort.h.

◆ SubsetDataInformations

std::map<std::string, std::map<int, vtkSmartPointer<vtkPVDataInformation> > > vtkSMOutputPort::SubsetDataInformations

protected

Definition at line 180 of file vtkSMOutputPort.h.

◆ TemporalSubsetDataInformations

std::map<std::string, std::map<int, vtkSmartPointer<vtkPVTemporalDataInformation> > > vtkSMOutputPort::TemporalSubsetDataInformations

protected

Definition at line 182 of file vtkSMOutputPort.h.

◆ RankDataInformations

std::map<int, vtkSmartPointer<vtkPVDataInformation> > vtkSMOutputPort::RankDataInformations

protected

Definition at line 183 of file vtkSMOutputPort.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMOutputPort()

◆ ~vtkSMOutputPort()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ GetDataInformation()

◆ GetRankDataInformation()

◆ GetSubsetDataInformation() [1/2]

◆ GetSubsetDataInformation() [2/2]

◆ GetTemporalDataInformation()

◆ GetTemporalSubsetDataInformation()

◆ GetDataClassName()

◆ GetClassNameInformation()

◆ InvalidateDataInformation()

◆ GetPortIndex()

◆ GetSourceProxy()

◆ GetSession()

◆ GetSessionProxyManager()

◆ GatherClassNameInformation()

◆ GatherDataInformation()

◆ GatherTemporalDataInformation()

◆ SetSourceProxy()

◆ SetCompoundSourceProxy()

◆ UpdatePipelineInternal()

◆ SetPortIndex()

Friends And Related Function Documentation

◆ vtkSMSourceProxy

◆ vtkSMCompoundSourceProxy

Member Data Documentation

◆ PortIndex

◆ SourceProxy

◆ CompoundSourceProxy

◆ ClassNameInformation

◆ ClassNameInformationValid

◆ DataInformation

◆ DataInformationValid

◆ TemporalDataInformation

◆ TemporalDataInformationValid

◆ SubsetDataInformations

◆ TemporalSubsetDataInformations

◆ RankDataInformations