performance/
mgcoarraylist__define.pro
An MGcoArrayList implements the same interface as IDL_Container, but can contain any IDL type.
Class description for mgcoarraylist
Inheritance
All ancestor classes: mgcoabstractlist idl_object
Properties
Properties in mgcoabstractlist
- version get
Properties in mgcoarraylist
- _ref_extra get
- blockSize get set
- block_size init
- count get
- example get init
- type get set init
Fields
Fields in mgcoabstractlist
- version 0L
Fields in idl_object
- __obj__ obj_new()
- idl_object_bottom 0LL
- idl_object_top 0LL
Fields in mgcoarraylist
- blockSize 0L
size of the data array
- nUsed 0L
number of elements of the list actually in use
- pData ptr_new()
pointer to the data array
- pExample ptr_new()
used if list of structures to specify the structure
- type 0L
SIZE type code of the data array
Routines
Methods inherited from idl_object
Methods inherited from mgcoabstractlist
mgcoabstractlist::add, elements [, position=integer]
result = mgcoabstractlist::isContained(elements [, position=long])
result = mgcoabstractlist::init()
mgcoabstractlist::move, source, destination
result = mgcoabstractlist::iterator()
result = mgcoabstractlist::count()
result = mgcoabstractlist::get( [/all] [, position=integer] [, count=integer] [, isa=string or strarr])
mgcoabstractlist::getProperty [, version=long]
mgcoabstractlist::remove [, elements] [, position=long] [, /all]
mgcoabstractlist::cleanup
Routines from mgcoarraylist__define.pro
mgcoarraylist::getProperty [, type=long] [, blockSize=long] [, example=structure] [, count=long] [, _ref_extra=keywords]
Get properties of the list.
mgcoarraylist::setProperty [, type=long] [, blockSize=long]
Set properties of the list.
mgcoarraylist::remove [, elements] [, position=long] [, /all]
Remove specified elements from the list.
mgcoarraylist::move, source, destination
Move an element of the list to another position.
result = mgcoarraylist::isContained(elements [, position=long])
Determines whether a list contains specified elements.
mgcoarraylist::add, elements [, position=long/lonarr]
Add elements to the list.
result = mgcoarraylist::isaGet( [position=lonarr], isa=string/strarr [, /all] [, count=long])
Private method to screen for given class(es).
result = mgcoarraylist::get( [/all] [, position=long/lonarr] [, count=integer] [, isa=string or strarr])
Get elements of the list.
result = mgcoarraylist::count()
Returns the number of elements in the list.
result = mgcoarraylist::iterator()
Creates an iterator to iterate through the elements of the ArrayList.
mgcoarraylist::cleanup
Cleanup list resources.
result = mgcoarraylist::init( [type=integer] [, example=any] [, block_size=integer])
Create a list.
mgcoarraylist__define
Define member variables.
Routine details
top source mgcoarraylist::getProperty
mgcoarraylist::getProperty [, type=long] [, blockSize=long] [, example=structure] [, count=long] [, _ref_extra=keywords]
Get properties of the list.
Keywords
- type out optional type=long
set to a named variable to get SIZE type code of list
- blockSize out optional type=long
set to a named variable to get the size of the
- example out optional type=structure
set to a named variable to get the example of structure type; undefined if list is not of type structure
- count out optional type=long
set to a named variable to get the number of elements in the list
- _ref_extra out optional type=keywords
keyword to MGcoAbstractList::getProperty
top source mgcoarraylist::setProperty
mgcoarraylist::setProperty [, type=long] [, blockSize=long]
Set properties of the list.
Keywords
- type in optional type=long
SIZE type code to convert list to
- blockSize in optional type=long
size of the data array
top source mgcoarraylist::remove
mgcoarraylist::remove [, elements] [, position=long] [, /all]
Remove specified elements from the list.
Parameters
- elements in optional type=type of list
elements of the list to remove
Keywords
- position in optional type=long
set to a scalar or vector array of indices to remove from the list
- all in optional type=boolean
set to remove all elements of the list
top source mgcoarraylist::move
mgcoarraylist::move, source, destination
Move an element of the list to another position.
Parameters
- source in required type=long
index of the element to move
- destination in required type=long
index of position to move element
top source mgcoarraylist::isContained
result = mgcoarraylist::isContained(elements [, position=long])
Determines whether a list contains specified elements.
Return value
1B if contained or 0B if otherwise
Parameters
- elements in required type=type of list
scalar or vector of elements of the same type as the list
Keywords
- position out optional type=long
set to a named variable that will return the position of the first instance of the corresponding element of the specified elements
top source mgcoarraylist::add
mgcoarraylist::add, elements [, position=long/lonarr]
Add elements to the list.
Parameters
- elements in required type=list type
scalar or vector array of the same type as the list
Keywords
- position in optional type=long/lonarr default=end of list
index or index array to insert elements at; if array, must match number of elements
top source mgcoarraylist::isaGetprivate
result = mgcoarraylist::isaGet( [position=lonarr], isa=string/strarr [, /all] [, count=long])
Private method to screen for given class(es). Indices returned are indices POSITION (or data array if ALL is set).
Return value
index array or -1L if none
Keywords
- position in optional type=lonarr
indices of elements to check
- isa in required type=string/strarr
classes to check objects for
- all in optional type=boolean
screen from all elements
- count out optional type=long
number of matched items
top source mgcoarraylist::get
result = mgcoarraylist::get( [/all] [, position=long/lonarr] [, count=integer] [, isa=string or strarr])
Get elements of the list.
Return value
element(s) of the list or -1L if no elements to return
Keywords
- all in optional type=boolean
set to return all elements
- position in optional type=long/lonarr
set to an index or an index array of elements to return; defaults to 0 if ALL keyword not set
- count out optional type=integer
set to a named variable to get the number of elements returned by this function
- isa in optional type=string or strarr
classname(s) of objects to return; only allowable if list type is object
top source mgcoarraylist::count
result = mgcoarraylist::count()
Returns the number of elements in the list.
Return value
long integer
top source mgcoarraylist::iterator
result = mgcoarraylist::iterator()
Creates an iterator to iterate through the elements of the ArrayList. The destruction of the iterator is the responsibility of the caller of this method.
Return value
MGcoArrayListIterator object
top source mgcoarraylist::init
result = mgcoarraylist::init( [type=integer] [, example=any] [, block_size=integer])
Create a list.
Return value
1B for succes, 0B otherwise
Keywords
- type in optional type=integer
type code as in SIZE function to specify the type of elements in the list; TYPE or EXAMPLE keyword must be used
- example in optional type=any
used to specify the type of the list by example; necessary if defining a list of structures
- block_size in optional type=integer default=1000L
initial size of data array
File attributes
Modification date: | Tue Apr 22 00:03:18 2008 |
Lines: | 235 |
Docformat: | rst rst |