GPULib API

Tech-X Corporation

single page | use frames     summary     class     fields     routine details     file attributes

lib/

gpuvariableview__define.pro


Represents a GPU variable.

Class description for gpuvariableview

Inheritance

All ancestor classes: gpuvariable idl_object

Properties

n_elements get type=long

total number of elements in the variable

_handle get
n_dimensions get type=long

number of dimensions: 0, 1, 2

_data get
value type=scalar numeric

scalar to fill in the array with

dimensions get type=lonarr(2)

size of each dimension

ERROR init
_is_temporary get
type get type=long

IDL type code for variable

TEMPORARY init

Routines

result = gpuvariableview::_overloadBracketsRightSide(isRange, ss1, ss2, ss3, ss4, ss5, ss6, ss7, ss8)

Handle indexing GPU variables.

result = gpuvariableview::_overloadHelp(varname)

Overload output for HELP routine.

result = gpuvariableview::_overloadPrint()

Overload output for PRINT routine.

result = gpuvariableview::_overloadSize()

Overload output for SIZE routine.

gpuvariableview::getProperty, type=long, n_elements=long, n_dimensions=long, dimensions=lonarr(2), _is_temporary=_is_temporary, _handle=_handle, _data=_data

Get properties of the variable.

result = gpuvariableview::getNElements()
gpuvariableview::_setNElements, n_elements
result = gpuvariableview::_getData()
gpuvariableview::_setData, data
result = gpuvariableview::_getHandle()
gpuvariableview::_setHandle, handle
result = gpuvariableview::_isTemporary()
gpuvariableview::_setTemporary, temporary
gpuvariableview::putarr, value, ERROR=ERROR, CPU=CPU, STREAM=STREAM
result = gpuvariableview::getarr(LHS=LHS, ERROR=ERROR)
result = gpuvariableview::_createView(offset, nelements)

Create a view of this GPU variable.

gpuvariableview::cleanup

Free GPU variable resources.

result = gpuvariableview::init(var, offset, nelements, ERROR=ERROR, TEMPORARY=TEMPORARY)

Create a Gpuvariableview object.

gpuvariableview__define

Define GPU variable's fields.

Routine details

top gpuvariableview::_overloadBracketsRightSide

result = gpuvariableview::_overloadBracketsRightSide(isRange, ss1, ss2, ss3, ss4, ss5, ss6, ss7, ss8)

Handle indexing GPU variables.

Return value

GPU variable object

Parameters

isRange
ss1
ss2
ss3
ss4
ss5
ss6
ss7
ss8

top gpuvariableview::_overloadHelp

result = gpuvariableview::_overloadHelp(varname)

Overload output for HELP routine.

Parameters

varname in required type=string

variable name

top gpuvariableview::_overloadPrint

result = gpuvariableview::_overloadPrint()

Overload output for PRINT routine.

top gpuvariableview::_overloadSize

result = gpuvariableview::_overloadSize()

Overload output for SIZE routine.

top gpuvariableview::getProperty

gpuvariableview::getProperty, type=long, n_elements=long, n_dimensions=long, dimensions=lonarr(2), _is_temporary=_is_temporary, _handle=_handle, _data=_data

Get properties of the variable.

Keywords

type type=long

IDL type code for variable

n_elements type=long

total number of elements in the variable

n_dimensions type=long

number of dimensions: 0, 1, 2

dimensions type=lonarr(2)

size of each dimension

_is_temporary
_handle
_data

top gpuvariableview::getNElements

result = gpuvariableview::getNElements()

top gpuvariableview::_setNElements

gpuvariableview::_setNElements, n_elements

Parameters

n_elements

top gpuvariableview::_getData

result = gpuvariableview::_getData()

top gpuvariableview::_setData

gpuvariableview::_setData, data

Parameters

data

top gpuvariableview::_getHandle

result = gpuvariableview::_getHandle()

top gpuvariableview::_setHandle

gpuvariableview::_setHandle, handle

Parameters

handle

top gpuvariableview::_isTemporary

result = gpuvariableview::_isTemporary()

top gpuvariableview::_setTemporary

gpuvariableview::_setTemporary, temporary

Parameters

temporary

top gpuvariableview::putarr

gpuvariableview::putarr, value, ERROR=ERROR, CPU=CPU, STREAM=STREAM

Parameters

value

Keywords

ERROR
CPU
STREAM

top gpuvariableview::getarr

result = gpuvariableview::getarr(LHS=LHS, ERROR=ERROR)

Keywords

LHS
ERROR

top gpuvariableview::_createView

result = gpuvariableview::_createView(offset, nelements)

Create a view of this GPU variable.

Return value

GPU variable view;

Parameters

offset in required type=long

array element of origin of view

nelements in required type=long

number of elements in the view

top gpuvariableview::cleanup

gpuvariableview::cleanup

Free GPU variable resources.

top gpuvariableview::init

result = gpuvariableview::init(var, offset, nelements, ERROR=ERROR, TEMPORARY=TEMPORARY)

Create a Gpuvariableview object.

Return value

1 if successfully initialized, 0 if not

Parameters

var
offset
nelements

Keywords

ERROR
TEMPORARY

top gpuvariableview__define

gpuvariableview__define

Define GPU variable's fields.

File attributes

Modification date: Fri Nov 12 11:07:44 2010
Lines: 365
Docformat: rst rst