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

vtkInformationExecutivePortKey Class Reference

#include <vtkInformationExecutivePortKey.h>

Inheritance diagram for vtkInformationExecutivePortKey:

Inheritance graph
Collaboration diagram for vtkInformationExecutivePortKey:

Collaboration graph
List of all members.

Detailed Description

Key for vtkExecutive/Port value pairs.

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

Definition at line 32 of file vtkInformationExecutivePortKey.h.

Public Types

typedef vtkInformationKey Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
 vtkInformationExecutivePortKey (const char *name, const char *location)
virtual void ShallowCopy (vtkInformation *from, vtkInformation *to)
virtual void Report (vtkInformation *info, vtkGarbageCollector *collector)
virtual void Print (ostream &os, vtkInformation *info)
 ~vtkInformationExecutivePortKey ()
void Set (vtkInformation *info, vtkExecutive *, int)
vtkExecutiveGetExecutive (vtkInformation *info)
int GetPort (vtkInformation *info)
void Get (vtkInformation *info, vtkExecutive *&executive, int &port)
int Has (vtkInformation *info)

Static Public Member Functions

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

Member Typedef Documentation

typedef vtkInformationKey vtkInformationExecutivePortKey::Superclass

Reimplemented from vtkInformationKey.

Definition at line 35 of file vtkInformationExecutivePortKey.h.

Constructor & Destructor Documentation

vtkInformationExecutivePortKey::vtkInformationExecutivePortKey const char *  name,
const char *  location

vtkInformationExecutivePortKey::~vtkInformationExecutivePortKey  ) 

Member Function Documentation

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

Reimplemented from vtkInformationKey.

static int vtkInformationExecutivePortKey::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 vtkInformationExecutivePortKey::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 vtkInformationExecutivePortKey* vtkInformationExecutivePortKey::SafeDownCast vtkObject o  )  [static]

Reimplemented from vtkInformationKey.

void vtkInformationExecutivePortKey::PrintSelf ostream &  os,
vtkIndent  indent

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 vtkInformationExecutivePortKey::Set vtkInformation info,
vtkExecutive ,

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

vtkExecutive* vtkInformationExecutivePortKey::GetExecutive vtkInformation info  ) 

int vtkInformationExecutivePortKey::GetPort vtkInformation info  ) 

void vtkInformationExecutivePortKey::Get vtkInformation info,
vtkExecutive *&  executive,
int &  port

int vtkInformationExecutivePortKey::Has vtkInformation info  ) 

virtual void vtkInformationExecutivePortKey::ShallowCopy vtkInformation from,
vtkInformation to

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 vtkInformationExecutivePortKey::Report vtkInformation info,
vtkGarbageCollector collector

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

Reimplemented from vtkInformationKey.

virtual void vtkInformationExecutivePortKey::Print ostream &  os,
vtkInformation info

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

Reimplemented from vtkInformationKey.

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