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

#include <vtkSMOutputPort.h>

Inheritance diagram for vtkSMOutputPort:

Collaboration diagram for vtkSMOutputPort:

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkPVDataInformation *	GetDataInformation ()
virtual vtkPVTemporalDataInformation *	GetTemporalDataInformation ()
virtual const char *	GetDataClassName ()
virtual vtkPVClassNameInformation *	GetClassNameInformation ()
virtual void	InvalidateDataInformation ()
vtkSMSourceProxy *	GetSourceProxy ()

virtual int	GetPortIndex ()
Static Public Member Functions
static vtkSMOutputPort *	New ()
static int	IsTypeOf (const char *type)
static vtkSMOutputPort *	SafeDownCast (vtkObject *o)
static void	SetUseStreaming (bool value)
Protected Member Functions
virtual void	GatherClassNameInformation ()
virtual void	GatherDataInformation ()
virtual void	GatherTemporalDataInformation ()
void	SetSourceProxy (vtkSMSourceProxy *src)
void	SetCompoundSourceProxy (vtkSMCompoundSourceProxy *src)
virtual void	UpdatePipelineInternal (double time, bool doTime)
virtual void	SetPortIndex (int)
Protected Attributes
int	PortIndex
vtkWeakPointer< vtkSMSourceProxy >	SourceProxy
vtkWeakPointer < vtkSMCompoundSourceProxy >	CompoundSourceProxy
vtkPVClassNameInformation *	ClassNameInformation
int	ClassNameInformationValid
vtkPVDataInformation *	DataInformation
bool	DataInformationValid
vtkPVTemporalDataInformation *	TemporalDataInformation
bool	TemporalDataInformationValid
Static Protected Attributes
static bool	UseStreaming
static int	DefaultPass
static int	DefaultNumPasses
static double	DefaultResolution
Friends
class	vtkSMSourceProxy
class	vtkSMCompoundSourceProxy
static void	SetDefaultPiece (int dp, int dnp, double dr)
	vtkSMOutputPort ()
	~vtkSMOutputPort ()

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=NULL.

Definition at line 42 of file vtkSMOutputPort.h.

Constructor & Destructor Documentation

vtkSMOutputPort::vtkSMOutputPort ( ) [protected]

Streaming plugin uses this to specify the prototypical piece to update the get information from.

vtkSMOutputPort::~vtkSMOutputPort ( ) [protected]

Streaming plugin uses this to specify the prototypical piece to update the get information from.

Member Function Documentation

static vtkSMOutputPort* vtkSMOutputPort::New ( ) [static]

Reimplemented from vtkSMProxy.

virtual const char* vtkSMOutputPort::GetClassName ( ) [virtual]

Reimplemented from vtkSMProxy.

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

Reimplemented from vtkSMProxy.

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

Reimplemented from vtkSMProxy.

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

Reimplemented from vtkSMProxy.

void vtkSMOutputPort::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkSMProxy.

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.

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.

virtual const char* vtkSMOutputPort::GetDataClassName ( ) [virtual]

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

virtual vtkPVClassNameInformation* vtkSMOutputPort::GetClassNameInformation ( ) [virtual]

Returns classname information.

virtual void vtkSMOutputPort::InvalidateDataInformation ( ) [virtual]

Mark data information as invalid.

virtual int vtkSMOutputPort::GetPortIndex ( ) [virtual]

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

vtkSMSourceProxy* vtkSMOutputPort::GetSourceProxy ( )

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

static void vtkSMOutputPort::SetUseStreaming ( bool value ) [static]

Streaming plugin turns this on to prevent GUI from updating whole extent at one time.

static void vtkSMOutputPort::SetDefaultPiece	(	int	dp,
		int	dnp,
		double	dr
	)		`[static]`

Streaming plugin uses this to specify the prototypical piece to update the get information from.

virtual void vtkSMOutputPort::GatherClassNameInformation ( ) [protected, virtual]

Get the classname of the dataset from server.

virtual void vtkSMOutputPort::GatherDataInformation ( ) [protected, virtual]

Get information about dataset from server. Fires the vtkCommand::UpdateInformationEvent event.

virtual void vtkSMOutputPort::GatherTemporalDataInformation ( ) [protected, virtual]

Get temporal information from the server.

void vtkSMOutputPort::SetSourceProxy ( vtkSMSourceProxy * src ) [protected]

void vtkSMOutputPort::SetCompoundSourceProxy ( vtkSMCompoundSourceProxy * src ) [protected]

virtual void vtkSMOutputPort::UpdatePipelineInternal	(	double	time,
		bool	doTime
	)		`[protected, virtual]`

An internal update pipeline method that subclasses may override.

virtual void vtkSMOutputPort::SetPortIndex ( int ) [protected, virtual]

Friends And Related Function Documentation

friend class vtkSMSourceProxy [friend]

These classes have been declared as friends to minimize the public interface exposed by vtkSMProxy. Each of these classes use a small subset of protected methods. This should be kept as such.

Reimplemented from vtkSMProxy.

Definition at line 135 of file vtkSMOutputPort.h.

friend class vtkSMCompoundSourceProxy [friend]

These classes have been declared as friends to minimize the public interface exposed by vtkSMProxy. Each of these classes use a small subset of protected methods. This should be kept as such.

Reimplemented from vtkSMProxy.

Definition at line 136 of file vtkSMOutputPort.h.