VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
vtkGPUInfoList Class Reference

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

#include <vtkGPUInfoList.h>

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

Public Types

typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Probe ()=0
virtual bool IsProbed ()
virtual int GetNumberOfGPUs ()
virtual vtkGPUInfoGetGPUInfo (int i)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (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 *)
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)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- 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)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkGPUInfoListNew ()
static int IsTypeOf (const char *type)
static vtkGPUInfoListSafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkObject
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

Protected Member Functions

 vtkGPUInfoList ()
virtual ~vtkGPUInfoList ()
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

bool Probed
vtkGPUInfoListArrayArray
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

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 37 of file vtkGPUInfoList.h.

Member Typedef Documentation

Definition at line 41 of file vtkGPUInfoList.h.

Constructor & Destructor Documentation

vtkGPUInfoList::vtkGPUInfoList ( )
protected

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

virtual vtkGPUInfoList::~vtkGPUInfoList ( )
protectedvirtual

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.

virtual const char* vtkGPUInfoList::GetClassName ( )
virtual
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.

static vtkGPUInfoList* vtkGPUInfoList::SafeDownCast ( vtkObject o)
static
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 68 of file vtkGPUInfoList.h.

vtkGPUInfoListArray* vtkGPUInfoList::Array
protected

Definition at line 69 of file vtkGPUInfoList.h.


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