VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkGPUInfoList Class Reference

Stores the list of GPUs VRAM information. More...

#include <vtkGPUInfoList.h>

Inheritance diagram for vtkGPUInfoList:
Inheritance graph
[legend]
Collaboration diagram for vtkGPUInfoList:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkGPUInfoListNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Probe ()=0
virtual bool IsProbed ()
virtual int GetNumberOfGPUs ()
virtual vtkGPUInfoGetGPUInfo (int i)

Static Public Member Functions

static vtkGPUInfoListNew ()
static int IsTypeOf (const char *type)
static vtkGPUInfoListSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkGPUInfoList ()
virtual ~vtkGPUInfoList ()

Protected Attributes

bool Probed
vtkGPUInfoListArrayArray

Detailed Description

Stores the list of GPUs VRAM information.

vtkGPUInfoList stores a list of vtkGPUInfo. An host can have several GPUs. It creates and sets the list by probing the host with system calls. This an abstract class. Concrete classes are OS specific.

See also:
vtkGPUInfo vtkDirectXGPUInfoList vtkCoreGraphicsGPUInfoList
Tests:
vtkGPUInfoList (Tests)

Definition at line 38 of file vtkGPUInfoList.h.


Member Typedef Documentation

Reimplemented from vtkObject.

Reimplemented in vtkDirectXGPUInfoList, vtkCoreGraphicsGPUInfoList, vtkXGPUInfoList, and vtkDummyGPUInfoList.

Definition at line 42 of file vtkGPUInfoList.h.


Constructor & Destructor Documentation

Default constructor. Set Probed to false. Set Array to NULL.

virtual vtkGPUInfoList::~vtkGPUInfoList ( ) [protected, virtual]

Default constructor. Set Probed to false. Set Array to NULL.


Member Function Documentation

static vtkGPUInfoList* vtkGPUInfoList::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

Reimplemented in vtkDirectXGPUInfoList, vtkCoreGraphicsGPUInfoList, vtkXGPUInfoList, and vtkDummyGPUInfoList.

static int vtkGPUInfoList::IsTypeOf ( const char *  name) [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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkDirectXGPUInfoList, vtkCoreGraphicsGPUInfoList, vtkXGPUInfoList, and vtkDummyGPUInfoList.

virtual int vtkGPUInfoList::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 vtkObject.

Reimplemented in vtkDirectXGPUInfoList, vtkCoreGraphicsGPUInfoList, vtkXGPUInfoList, and vtkDummyGPUInfoList.

virtual vtkObjectBase* vtkGPUInfoList::NewInstanceInternal ( ) const [protected, virtual]
void vtkGPUInfoList::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 vtkObject.

Reimplemented in vtkDirectXGPUInfoList, vtkCoreGraphicsGPUInfoList, vtkXGPUInfoList, and vtkDummyGPUInfoList.

virtual void vtkGPUInfoList::Probe ( ) [pure virtual]

Build the list of vtkInfoGPU if not done yet. Default implementation created an empty list. Useful if there is no implementation available for a given architecture yet.

Postcondition:
probed: IsProbed()

Implemented in vtkDirectXGPUInfoList, vtkCoreGraphicsGPUInfoList, vtkXGPUInfoList, and vtkDummyGPUInfoList.

virtual bool vtkGPUInfoList::IsProbed ( ) [virtual]

Tells if the operating system has been probed. Initial value is false.

virtual int vtkGPUInfoList::GetNumberOfGPUs ( ) [virtual]

Return the number of GPUs.

Precondition:
probed: IsProbed()
virtual vtkGPUInfo* vtkGPUInfoList::GetGPUInfo ( int  i) [virtual]

Return information about GPU i.

Precondition:
probed: IsProbed()
valid_index: i>=0 && i<GetNumberOfGPUs()
Postcondition:
result_exists: result!=0

Member Data Documentation

bool vtkGPUInfoList::Probed [protected]

Definition at line 69 of file vtkGPUInfoList.h.

Definition at line 70 of file vtkGPUInfoList.h.


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