vtkCPDataDescription Class Reference

This class provides the description of the data for the coprocessor pipelines. More...

#include <vtkCPDataDescription.h>

Inheritance diagram for vtkCPDataDescription:

Collaboration diagram for vtkCPDataDescription:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
void	SetTimeData (double time, vtkIdType timeStep)
	Set the time step and current simulation time. More...
virtual vtkIdType	GetTimeStep ()
	Get the current time step that should be set in the adaptor. More...
virtual double	GetTime ()
	Get the current time that should be set in the adaptor. More...
virtual void	SetForceOutput (bool)
	Specify whether or not to force output of all coprocessing pipelines. More...
virtual void	ForceOutputOn ()
	Specify whether or not to force output of all coprocessing pipelines. More...
virtual void	ForceOutputOff ()
virtual bool	GetForceOutput ()
	Return whether or not output is forced for all coprocessing pipelines. More...
void	AddInput (const char *gridName)
	Add names for grids produced by the simulation. More...
unsigned int	GetNumberOfInputDescriptions ()
	Returns the number of input descriptions. More...
void	ResetInputDescriptions ()
	Reset the names of the fields that are needed, the required meshes, etc. More...
void	ResetAll ()
	Reset the names of the fields that are needed, the required meshes, etc. More...
vtkCPInputDataDescription *	GetInputDescription (unsigned int)
	Provides access to a grid description using the index. More...
const char *	GetInputDescriptionName (unsigned int)
	Provides the name for the input description at the given index. More...
vtkCPInputDataDescription *	GetInputDescriptionByName (const char *)
	Provides access to a grid description using the grid name. More...
bool	GetIfGridIsNecessary (const char *)
	Returns true if the grid is necessary, given the grid's name. More...
bool	GetIfAnyGridNecessary ()
	Returns true if any of the grids is necessary. More...
void	SetUserData (vtkFieldData *UserData)
	Set user defined information that can be passed from the adaptor to the coprocessing pipelines. More...
virtual vtkFieldData *	GetUserData ()
	Set user defined information that can be passed from the adaptor to the coprocessing pipelines. More...
void	Copy (vtkCPDataDescription *)
	Copy of dataDescription. More...
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual vtkMTimeType	GetMTime ()
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
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 *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
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)
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 *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
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)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkCPDataDescription *	New ()
static int	IsTypeOf (const char *type)
static vtkCPDataDescription *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
static vtkObjectBase *	New ()
static vtkObjectBase *	New ()

Protected Member Functions
	vtkCPDataDescription ()
	~vtkCPDataDescription () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

This class provides the description of the data for the coprocessor pipelines.

Definition at line 15 of file vtkCPDataDescription.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkCPDataDescription::Superclass

Definition at line 19 of file vtkCPDataDescription.h.

Constructor & Destructor Documentation

vtkCPDataDescription()

vtkCPDataDescription::vtkCPDataDescription ( )

protected

~vtkCPDataDescription()

vtkCPDataDescription::~vtkCPDataDescription ( )

overrideprotected

Member Function Documentation

New()

static vtkCPDataDescription* vtkCPDataDescription::New ( )

static

GetClassName()

virtual const char* vtkCPDataDescription::GetClassName ( )

virtual

IsTypeOf()

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

static

IsA()

virtual int vtkCPDataDescription::IsA ( const char *  type )

virtual

Reimplemented from vtkObjectBase.

SafeDownCast()

static vtkCPDataDescription* vtkCPDataDescription::SafeDownCast ( vtkObject *  o )

static

PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

SetTimeData()

void vtkCPDataDescription::SetTimeData	(	double	time,
		vtkIdType	timeStep
	)

Set the time step and current simulation time.

GetTimeStep()

virtual vtkIdType vtkCPDataDescription::GetTimeStep ( )

virtual

Get the current time step that should be set in the adaptor.

GetTime()

virtual double vtkCPDataDescription::GetTime ( )

virtual

Get the current time that should be set in the adaptor.

SetForceOutput()

virtual void vtkCPDataDescription::SetForceOutput ( bool  )

virtual

Specify whether or not to force output of all coprocessing pipelines.

This is meant to be set in the adaptor and used in the coprocessing pipeline. Default is false. If this is true then GetIsGridNecessary() and GetIfAnyGridIsNecessary() will return true.

ForceOutputOn()

virtual void vtkCPDataDescription::ForceOutputOn ( )

virtual

Specify whether or not to force output of all coprocessing pipelines.

This is meant to be set in the adaptor and used in the coprocessing pipeline. Default is false. If this is true then GetIsGridNecessary() and GetIfAnyGridIsNecessary() will return true.

ForceOutputOff()

virtual void vtkCPDataDescription::ForceOutputOff ( )

virtual

GetForceOutput()

virtual bool vtkCPDataDescription::GetForceOutput ( )

virtual

Return whether or not output is forced for all coprocessing pipelines.

AddInput()

void vtkCPDataDescription::AddInput

(

const char *

gridName

)

Add names for grids produced by the simulation.

This allocates a new vtkCPInputDataDescription for that grid, if a grid by that name does not already exist.

GetNumberOfInputDescriptions()

unsigned int vtkCPDataDescription::GetNumberOfInputDescriptions

(

)

Returns the number of input descriptions.

ResetInputDescriptions()

void vtkCPDataDescription::ResetInputDescriptions

(

)

Reset the names of the fields that are needed, the required meshes, etc.

that are stored in the vtkCPInputDescriptions.

ResetAll()

void vtkCPDataDescription::ResetAll

(

)

Reset the names of the fields that are needed, the required meshes, etc.

that are stored in the vtkCPInputDescriptions as well as the time information and output forcing. Automatically called after vtkCPProcessor::CoProcess() is called.

GetInputDescription()

vtkCPInputDataDescription* vtkCPDataDescription::GetInputDescription

(

unsigned

int

)

Provides access to a grid description using the index.

GetInputDescriptionName()

const char* vtkCPDataDescription::GetInputDescriptionName

(

unsigned

int

)

Provides the name for the input description at the given index.

GetInputDescriptionByName()

vtkCPInputDataDescription* vtkCPDataDescription::GetInputDescriptionByName

(

const char *

)

Provides access to a grid description using the grid name.

GetIfGridIsNecessary()

bool vtkCPDataDescription::GetIfGridIsNecessary

(

const char *

)

Returns true if the grid is necessary, given the grid's name.

GetIfAnyGridNecessary()

bool vtkCPDataDescription::GetIfAnyGridNecessary

(

)

Returns true if any of the grids is necessary.

SetUserData()

void vtkCPDataDescription::SetUserData

(

vtkFieldData *

UserData

)

Set user defined information that can be passed from the adaptor to the coprocessing pipelines.

GetUserData()

virtual vtkFieldData* vtkCPDataDescription::GetUserData ( )

virtual

Set user defined information that can be passed from the adaptor to the coprocessing pipelines.

Copy()

void vtkCPDataDescription::Copy

(

vtkCPDataDescription *

)

Copy of dataDescription.

Does a deep copy of the data members but a shallow copy of the vtkDataObjects.

---

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

• /builds/gitlab-kitware-sciviz-ci/Clients/Catalyst/vtkCPDataDescription.h