< LynkeosFileReader > Protocol Reference
[Graphic files access]

Common protocol for all file readers. More...

#import <LynkeosFileReader.h>

Inheritance diagram for < LynkeosFileReader >:

[legend]

Collaboration diagram for < LynkeosFileReader >:

[legend]

List of all members.

Public Member Functions
(id)	- initWithURL:
	Initializes an instance for reading an URL.
(void)	- imageWidth:height:
	Get the pixel size of the image or movie.
(u_short)	- numberOfPlanes
	Get the number of color planes in this file.
(void)	- getMinLevel:maxLevel:
(NSDictionary *)	- getMetaData
	Get the metadata of this file.
(BOOL)	- canBeCalibratedBy:
	Can image/movie data be calibrated by another reader instance data.
Static Public Member Functions
(void)	+ lynkeosFileTypes:
	Returns the file types handled by that class.
(BOOL)	+ hasCustomImageBuffer
	Does this reader provides some custom image buffer class(es) ?

---

Detailed Description

Common protocol for all file readers.

These protocols will be conformed to by the classes which implements the read of some image or movie file format. This protocol is not meant to be directly implemented. It is the common part of more specialized protocols.

---

Member Function Documentation

+ (void) lynkeosFileTypes:

(NSArray **)

fileTypes

Returns the file types handled by that class.

Parameters:

fileTypes

The file types (as NSString coded for use by NSOpenPanel) that this class knows how to read. If a file type is preceded in the array by a NSNumber, the higher the number, the higher this class has priority for opening that kind of file (otherwise, the priority is set to zero). The priority option shall be implemented only if you provide a specialized reader which overrides a generic one for some particular implementation of a file type (ex: the 16 bits TIFF reader overrides the Cocoa TIFF reader for 16 bits files)

- (id) initWithURL:

(NSURL *)

url

Initializes an instance for reading an URL.

Parameters:

url

The URL of the file to read.

Returns:

The initialized instance. If this URL cannot be read by this class, the instance deallocates itself and returns nil.

- (void) imageWidth:		(u_short *)	w
height:		(u_short *)	h

Get the pixel size of the image or movie.

Returns:

The image or movie size.

- (u_short) numberOfPlanes

Get the number of color planes in this file.

Returns:

The number of color planes

- (NSDictionary*) getMetaData

Get the metadata of this file.

This method is reserved for future use. Current implementations shall return nil.

Returns:

A Property list containing the metadata.

+ (BOOL) hasCustomImageBuffer

Does this reader provides some custom image buffer class(es) ?

This method return YES if the image data is better represented by a custom kind of LynkeosImageBuffer class. In which case, the main app will use this class for calibration purpose.

Returns:

Wether the reader has a custom image buffer class

- (BOOL) canBeCalibratedBy:

(id< LynkeosFileReader >)

reader

Can image/movie data be calibrated by another reader instance data.

This method will be called if and only if the reader has a custom image buffer. It shall return YES if the other reader custom image data can be used to calibrate this instance data.
In other words : "does the data from the two readers comes from the same representation of the same sensor ?".

In a typical implementation, it tests if the readers are instances of the same class.
Actual implementations will for sure do something different.

Parameters:

reader

The reader instance from which data should be used to calibrate ours.

---

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

• LynkeosFileReader.h

---