This class define the processor level interface. More...

#include <Processor.h>

Classes
struct	Config
	This structure contains the configuration of a Processor. More...

struct	Info
	This structure contains the information about a Processor. More...

Public Member Functions
virtual Status	GetConfig (Config *aOut) const =0
	Retrieve configuration. More...

virtual void *	GetContext ()=0
	Retrieve the OpenCL context. More...

virtual void *	GetDevice ()=0
	Retrieve the OpenCL device id. More...

virtual Status	GetInfo (Info *aOut) const =0
	Retrieve the Info. More...

virtual const char *	GetName () const =0
	Retrieve the instance's name. More...

virtual Status	SetConfig (const Config &aConfig)=0
	Modify the configuration. More...

virtual UserBuffer *	AllocateUserBuffer (unsigned int aSize_byte)=0
	Allocate a user buffer in the processor memory. More...

virtual Status	Display (FILE *aOut) const =0
	Display. More...

Static Public Member Functions
static OPEN_NET_PUBLIC Status	Display (const Info &aIn, FILE *aOut)
	Display. More...

Detailed Description

This class define the processor level interface.

Member Function Documentation

virtual UserBuffer* OpenNet::Processor::AllocateUserBuffer ( unsigned int aSize_byte )

pure virtual

Allocate a user buffer in the processor memory.

Parameters

aSize_byte The size of the buffer

Return values

NULL	Error
Other	The UserBuffer instance

See also: Kernel::SetStaticUserArgument, UserBuffer::Delete

static OPEN_NET_PUBLIC Status OpenNet::Processor::Display	(	const Info &	aIn,
		FILE *	aOut
	)

static

Display.

Parameters

aIn	The Info instance to Display
aOut	The output stream

Return values

STATUS_OK
STATUS_INVALID_REFERENCE
STATUS_NOT_ALLOWER_NULL_ARGUMENT

virtual Status OpenNet::Processor::Display ( FILE * aOut ) const

pure virtual

Display.

Parameters

aOut	The output stream

Return values

STATUS_OK
STATUS_NOT_ALLOWED_NULL_ARGUMENT

virtual Status OpenNet::Processor::GetConfig ( Config * aOut ) const

pure virtual

Retrieve configuration.

Parameters

aOut	The configuration

Return values

STATUS_OK
STATUS_NOT_ALLOWER_NULL_ARGUMENT

See also: SetConfig

virtual void* OpenNet::Processor::GetContext ( )

pure virtual

Retrieve the OpenCL context.

Returns: This method returns a valid cl_context

virtual void* OpenNet::Processor::GetDevice ( )

pure virtual

Retrieve the OpenCL device id.

Returns: This method returns a valid cl_device_id or CUdevice

virtual Status OpenNet::Processor::GetInfo ( Info * aOut ) const

pure virtual

Retrieve the Info.

Parameters

aOut	The Info instance

Return values

STATUS_OK
STATUS_NOT_ALLOWER_NULL_ARGUMENT

virtual const char* OpenNet::Processor::GetName ( ) const

pure virtual

Retrieve the instance's name.

Return values

This	method returns the address of an internal buffer.

virtual Status OpenNet::Processor::SetConfig ( const Config & aConfig )

pure virtual

Modify the configuration.

Parameters

aConfig The configuration

Return values

STATUS_OK
STATUS_INVALID_REFERENCE

See also: GetConfig

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

Includes/OpenNet/Processor.h

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation