a collection for sockets. More...

#include <vtkSocketCollection.h>

Inheritance diagram for vtkSocketCollection:

Collaboration diagram for vtkSocketCollection:

Public Types
typedef vtkCollection	Superclass

Public Types inherited from vtkCollection
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkSocketCollection *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	AddItem (vtkSocket *soc)

int	SelectSockets (unsigned long msec=0)


vtkSocket *	GetLastSelectedSocket ()

Public Member Functions inherited from vtkCollection
vtkCollection *	NewInstance () const

void	AddItem (vtkObject *)

void	InsertItem (int i, vtkObject *)

void	ReplaceItem (int i, vtkObject *)

void	RemoveItem (int i)

void	RemoveItem (vtkObject *)

void	RemoveAllItems ()

int	IsItemPresent (vtkObject *a)

int	GetNumberOfItems ()

void	InitTraversal ()

vtkObject *	GetNextItemAsObject ()

vtkObject *	GetItemAsObject (int i)

vtkCollectionIterator *	NewIterator ()

void	InitTraversal (vtkCollectionSimpleIterator &cookie)

vtkObject *	GetNextItemAsObject (vtkCollectionSimpleIterator &cookie)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

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 )

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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkSocketCollection *	New ()

static int	IsTypeOf (const char *type)

static vtkSocketCollection *	SafeDownCast (vtkObjectBase *o)

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

static vtkCollection *	SafeDownCast (vtkObjectBase *o)

static vtkCollection *	New ()

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

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

Protected Member Functions inherited from vtkCollection
virtual void	RemoveElement (vtkCollectionElement element, vtkCollectionElement previous)

virtual void	DeleteElement (vtkCollectionElement *)

virtual void	ReportReferences (vtkGarbageCollector *collector)

	vtkCollection ()

	~vtkCollection ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkSocket *	SelectedSocket

Protected Attributes inherited from vtkCollection
int	NumberOfItems

vtkCollectionElement *	Top

vtkCollectionElement *	Bottom

vtkCollectionElement *	Current

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

void	ReplaceItem (int i, vtkObject *)

void	RemoveItem (int i)

void	RemoveItem (vtkObject *)

void	RemoveAllItems ()

	vtkSocketCollection ()

	~vtkSocketCollection ()

Detailed Description

a collection for sockets.

Apart from being vtkCollection subclass for sockets, this class provides means to wait for activity on all the sockets in the collection simultaneously.

Definition at line 30 of file vtkSocketCollection.h.

Member Typedef Documentation

typedef vtkCollection vtkSocketCollection::Superclass

Definition at line 34 of file vtkSocketCollection.h.

Constructor & Destructor Documentation

vtkSocketCollection::vtkSocketCollection ( )

protected

Overridden to unset SelectedSocket.

vtkSocketCollection::~vtkSocketCollection ( )

protected

Overridden to unset SelectedSocket.

Member Function Documentation

static vtkSocketCollection* vtkSocketCollection::New ( )

static

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

static

virtual int vtkSocketCollection::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCollection.

static vtkSocketCollection* vtkSocketCollection::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkSocketCollection::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCollection.

vtkSocketCollection* vtkSocketCollection::NewInstance ( ) const

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

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkCollection.

void vtkSocketCollection::AddItem ( vtkSocket * soc )

int vtkSocketCollection::SelectSockets ( unsigned long msec = 0 )

Select all Connected sockets in the collection. If msec is specified, it timesout after msec milliseconds on inactivity. Returns 0 on timeout, -1 on error; 1 is a socket was selected. The selected socket can be retrieved by GetLastSelectedSocket().

vtkSocket* vtkSocketCollection::GetLastSelectedSocket ( )

inline

Returns the socket selected during the last SelectSockets(), if any. NULL otherwise.

Definition at line 49 of file vtkSocketCollection.h.

void vtkSocketCollection::ReplaceItem	(	int	i,
		vtkObject *
	)

Overridden to unset SelectedSocket.

void vtkSocketCollection::RemoveItem ( int i )

Overridden to unset SelectedSocket.

void vtkSocketCollection::RemoveItem ( vtkObject * )

Overridden to unset SelectedSocket.

void vtkSocketCollection::RemoveAllItems ( )

Overridden to unset SelectedSocket.

Member Data Documentation

vtkSocket* vtkSocketCollection::SelectedSocket

protected

Definition at line 64 of file vtkSocketCollection.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/System/vtkSocketCollection.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation