MyImageList Class Reference
[Model classes]

Base model of a list of images to process. More...

#import <MyImageList.h>

Inheritance diagram for MyImageList:

Inheritance graph
[legend]
Collaboration diagram for MyImageList:

Collaboration graph
[legend]

List of all members.

Initializers and constructors

(id) - initWithArray:
 Initialize an instance with a given initial image list.
(id) + imageListWithArray:
 Convenience creator with a given initial image list.

Public Member Functions

Read accessors
(NSMutableArray *) - imageArray
 Get direct access to the array of images.
(MyImageListItem *) - firstItem
 Get the first item selected for processing in the list.
(MyImageListItem *) - lastItem
 Get the last item selected for processing in the list.
(MyImageListEnumerator *) - imageEnumerator
 Get an enumerator over all the images in the list.
(MyImageListEnumerator *) - imageEnumeratorStartAt:directSense:skipUnselected:
 Get an enumerator in the given direction over the list's images starting at the given item.
Actions
(BOOL) - addItem:
 Add a new item to the list.
(BOOL) - deleteItem:
 Deletes the given item from the list.
(BOOL) - changeItemSelection:value:
 Change the selection state of the given item.
(void) - setParametersParent:
 Set the parent object for parameters chain.

Protected Attributes

NSMutableArray_list
 The list of images.


Detailed Description

Base model of a list of images to process.

The images in the list share a common goal (dark frame, flat field or object images).


Member Function Documentation

- (NSMutableArray *) imageArray  

Get direct access to the array of images.

Returns:
The image array

- (MyImageListItem *) firstItem  

Get the first item selected for processing in the list.

Returns:
The first selected item

- (MyImageListItem *) lastItem  

Get the last item selected for processing in the list.

Returns:
The last selected item

- (MyImageListEnumerator *) imageEnumerator  

Get an enumerator over all the images in the list.

Returns:
The list's images enumerator

- (MyImageListEnumerator *) imageEnumeratorStartAt: (id)  item
directSense: (BOOL)  direct
skipUnselected: (BOOL)  skip 

Get an enumerator in the given direction over the list's images starting at the given item.

Parameters:
item The starting item
direct The sense (direct=YES, reverse=NO)
skip Whether to skip unselected images
Returns:
The list's images enumerator

- (BOOL) addItem: (MyImageListItem*)  item  

Add a new item to the list.

Parameters:
item A new image or movie
Returns:
Wether the document content has changed

- (BOOL) deleteItem: (MyImageListItem*)  item  

Deletes the given item from the list.

Parameters:
item The item to delete
Returns:
Wether the document content has changed

- (BOOL) changeItemSelection: (MyImageListItem*)  item
value: (BOOL)  v 

Change the selection state of the given item.

Parameters:
item The item for which to change the selection state
v The new selection state
Returns:
Wether the document content has changed

- (void) setParametersParent: (MyProcessingParameter*)  parent  

Set the parent object for parameters chain.

Parameters:
parent The parent of this item in the parameter chain

- (id) initWithArray: (NSArray*)  list  

Initialize an instance with a given initial image list.

Parameters:
list An existing image list
Returns:
The initialized instance

+ (id) imageListWithArray: (NSArray*)  list  

Convenience creator with a given initial image list.

Parameters:
list An existing image list
Returns:
The allocated and initialized instance


The documentation for this class was generated from the following files:
Generated on Sat Mar 22 17:44:51 2008 for Lynkeos by  doxygen 1.5.4