CUDPPPlanManager Class Reference

Singleton manager class for CUDPPPlan objects. More...

#include <cudpp_plan_manager.h>

List of all members.

Static Public Member Functions
static CUDPPHandle	AddPlan (CUDPPPlan *plan)
	Add a plan to the plan manager.
static bool	RemovePlan (CUDPPHandle handle)
	Remove a plan from the plan manager.
static CUDPPPlan *	GetPlan (CUDPPHandle handle)
	Get a plan from the plan manager by handle.
Static Protected Member Functions
static void	Instantiate ()
static void	Destroy ()

---

Detailed Description

Singleton manager class for CUDPPPlan objects.

This class manages all active plans in CUDPP. It is a singleton class, meaning that only one instance can exist. It is created automatically the first time AddPlan() is called, and destroyed when the last plan is removed using RemovePlan().

---

Member Function Documentation

CUDPPHandle CUDPPPlanManager::AddPlan

(

CUDPPPlan *

plan

)

[static]

Add a plan to the plan manager.

Returns:

a valid CUDPPHandle if the plan was successfully added, or CUDPP_INVALID_HANDLE otherwise

Parameters:

[in]

plan

The plan to add

bool CUDPPPlanManager::RemovePlan

(

CUDPPHandle

handle

)

[static]

Remove a plan from the plan manager.

Returns:

true if the plan was successfully removed, false otherwise

Parameters:

[in]

handle

The handle to the plan to remove

CUDPPPlan * CUDPPPlanManager::GetPlan

(

CUDPPHandle

handle

)

[static]

Get a plan from the plan manager by handle.

Returns:

A pointer to the plan if found, or NULL otherwise

Parameters:

handle

The handle to the requested plan

static void CUDPPPlanManager::Instantiate

(

)

[inline, static, protected]

For internal use only.

Instantiate the plan manager singleton object

static void CUDPPPlanManager::Destroy

(

)

[inline, static, protected]

For internal use only.

Destroy the plan manager singleton object

---

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

• cudpp_plan_manager.h
• cudpp_plan.cpp