Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkInformationExecutivePortVectorKey Class Reference

#include <vtkInformationExecutivePortVectorKey.h>

Inheritance diagram for vtkInformationExecutivePortVectorKey:

Inheritance graph
[legend]
Collaboration diagram for vtkInformationExecutivePortVectorKey:

Collaboration graph
[legend]
List of all members.

Detailed Description

Key for vtkExecutive/Port value pair vectors.

vtkInformationExecutivePortVectorKey is used to represent keys in vtkInformation for values that are vectors of vtkExecutive instances paired with port numbers.

Definition at line 32 of file vtkInformationExecutivePortVectorKey.h.
virtual void Print (ostream &os, vtkInformation *info)
vtkExecutive ** GetExecutivesWatchAddress (vtkInformation *info)
int * GetPortsWatchAddress (vtkInformation *info)

Public Types

typedef vtkInformationKey Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
 vtkInformationExecutivePortVectorKey (const char *name, const char *location)
virtual void ShallowCopy (vtkInformation *from, vtkInformation *to)
virtual void Remove (vtkInformation *info)
virtual void Report (vtkInformation *info, vtkGarbageCollector *collector)
 ~vtkInformationExecutivePortVectorKey ()
void Append (vtkInformation *info, vtkExecutive *executive, int port)
void Remove (vtkInformation *info, vtkExecutive *executive, int port)
void Set (vtkInformation *info, vtkExecutive **executives, int *ports, int length)
vtkExecutive ** GetExecutives (vtkInformation *info)
int * GetPorts (vtkInformation *info)
void Get (vtkInformation *info, vtkExecutive **executives, int *ports)
int Length (vtkInformation *info)
int Has (vtkInformation *info)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkInformationExecutivePortVectorKeySafeDownCast (vtkObject *o)


Member Typedef Documentation

typedef vtkInformationKey vtkInformationExecutivePortVectorKey::Superclass
 

Reimplemented from vtkInformationKey.

Definition at line 35 of file vtkInformationExecutivePortVectorKey.h.


Constructor & Destructor Documentation

vtkInformationExecutivePortVectorKey::vtkInformationExecutivePortVectorKey const char *  name,
const char *  location
 

vtkInformationExecutivePortVectorKey::~vtkInformationExecutivePortVectorKey  ) 
 


Member Function Documentation

virtual const char* vtkInformationExecutivePortVectorKey::GetClassName  )  [virtual]
 

Reimplemented from vtkInformationKey.

static int vtkInformationExecutivePortVectorKey::IsTypeOf const char *  type  )  [static]
 

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

Reimplemented from vtkInformationKey.

virtual int vtkInformationExecutivePortVectorKey::IsA const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkInformationKey.

static vtkInformationExecutivePortVectorKey* vtkInformationExecutivePortVectorKey::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkInformationKey.

void vtkInformationExecutivePortVectorKey::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 vtkInformationKey.

void vtkInformationExecutivePortVectorKey::Append vtkInformation info,
vtkExecutive executive,
int  port
 

Get/Set the value associated with this key in the given information object.

void vtkInformationExecutivePortVectorKey::Remove vtkInformation info,
vtkExecutive executive,
int  port
 

void vtkInformationExecutivePortVectorKey::Set vtkInformation info,
vtkExecutive **  executives,
int *  ports,
int  length
 

vtkExecutive** vtkInformationExecutivePortVectorKey::GetExecutives vtkInformation info  ) 
 

int* vtkInformationExecutivePortVectorKey::GetPorts vtkInformation info  ) 
 

void vtkInformationExecutivePortVectorKey::Get vtkInformation info,
vtkExecutive **  executives,
int *  ports
 

int vtkInformationExecutivePortVectorKey::Length vtkInformation info  ) 
 

int vtkInformationExecutivePortVectorKey::Has vtkInformation info  ) 
 

virtual void vtkInformationExecutivePortVectorKey::ShallowCopy vtkInformation from,
vtkInformation to
[virtual]
 

Copy the entry associated with this key from one information object to another. If there is no entry in the first information object for this key, the value is removed from the second.

Implements vtkInformationKey.

virtual void vtkInformationExecutivePortVectorKey::Remove vtkInformation info  )  [virtual]
 

Remove this key from the given information object.

Reimplemented from vtkInformationKey.

virtual void vtkInformationExecutivePortVectorKey::Report vtkInformation info,
vtkGarbageCollector collector
[virtual]
 

Report a reference this key has in the given information object.

Reimplemented from vtkInformationKey.

virtual void vtkInformationExecutivePortVectorKey::Print ostream &  os,
vtkInformation info
[virtual]
 

Print the key's value in an information object to a stream.

Reimplemented from vtkInformationKey.

vtkExecutive** vtkInformationExecutivePortVectorKey::GetExecutivesWatchAddress vtkInformation info  )  [protected]
 

Get the address at which the actual value is stored. This is meant for use from a debugger to add watches and is therefore not a public method.

int* vtkInformationExecutivePortVectorKey::GetPortsWatchAddress vtkInformation info  )  [protected]
 

Print the key's value in an information object to a stream.


The documentation for this class was generated from the following file:
Generated on Mon Jan 21 23:55:42 2008 for VTK by  doxygen 1.4.3-20050530