VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkInformationExecutivePortVectorKey Class Reference

Key for vtkExecutive/Port value pair vectors. More...

#include <vtkInformationExecutivePortVectorKey.h>

Inherits vtkInformationKey.

Public Types

typedef vtkInformationKey Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkInformationExecutivePortVectorKeyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
 vtkInformationExecutivePortVectorKey (const char *name, const char *location)
 
 ~vtkInformationExecutivePortVectorKey ()
 
virtual void ShallowCopy (vtkInformation *from, vtkInformation *to)
 
virtual void Remove (vtkInformation *info)
 
virtual void Report (vtkInformation *info, vtkGarbageCollector *collector)
 
virtual void Print (ostream &os, vtkInformation *info)
 
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)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static
vtkInformationExecutivePortVectorKey
SafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
vtkExecutive ** GetExecutivesWatchAddress (vtkInformation *info)
 
int * GetPortsWatchAddress (vtkInformation *info)
 

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 33 of file vtkInformationExecutivePortVectorKey.h.

Member Typedef Documentation

Definition at line 36 of file vtkInformationExecutivePortVectorKey.h.

Constructor & Destructor Documentation

vtkInformationExecutivePortVectorKey::vtkInformationExecutivePortVectorKey ( const char *  name,
const char *  location 
)
vtkInformationExecutivePortVectorKey::~vtkInformationExecutivePortVectorKey ( )

Member Function Documentation

static int vtkInformationExecutivePortVectorKey::IsTypeOf ( const char *  type)
static
virtual int vtkInformationExecutivePortVectorKey::IsA ( const char *  type)
virtual
static vtkInformationExecutivePortVectorKey* vtkInformationExecutivePortVectorKey::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkInformationExecutivePortVectorKey::NewInstanceInternal ( ) const
protectedvirtual
vtkInformationExecutivePortVectorKey* vtkInformationExecutivePortVectorKey::NewInstance ( ) const
void vtkInformationExecutivePortVectorKey::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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 
)

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

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

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

vtkExecutive** vtkInformationExecutivePortVectorKey::GetExecutives ( vtkInformation *  info)

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

int* vtkInformationExecutivePortVectorKey::GetPorts ( vtkInformation *  info)

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

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

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

int vtkInformationExecutivePortVectorKey::Length ( vtkInformation *  info)

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

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.

virtual void vtkInformationExecutivePortVectorKey::Remove ( vtkInformation *  info)
virtual

Remove this key from the given information object.

virtual void vtkInformationExecutivePortVectorKey::Report ( vtkInformation *  info,
vtkGarbageCollector *  collector 
)
virtual

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

virtual void vtkInformationExecutivePortVectorKey::Print ( ostream &  os,
vtkInformation *  info 
)
virtual

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

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

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.


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