iflFileDesc(3) Image Format Library C++ Reference Manual iflFileDesc(3)NAMEiflFileDesc - IFL's image file descriptor
INHERITS FROM
This is a base class with no inheritance.
HEADER FILE
#include <ifl/ilCdefs.h>
CLASS DESCRIPTIONiflFileDesc is IFL's image file descriptor. It is created from a file
name and/or a Unix file descriptor. It can either parse apart the
components of a IFL file name (Unix file name, image index, format name,
format specific string) or be supplied with a pre-parsed name.
An iflFileDesc can be used to pre-parse an IFL file name, perhaps to
check if the Unix file already exists when saving to a file, and then
passed to iflFile::open() or iflFile::create() to avoid reparsing the
name. It can also be used to implement a different file name syntax by
passing the pre-parsed file name to the alternate constructors.
CLASS MEMBER FUNCTION SUMMARY
Constructors
iflFileDesc* iflFileDescCreate(const char* name, iflFormat* format)
iflFileDesc* iflFileDescPreParsed(const char* fileName,
int index, const char* formatName,
const char* formatSpecific)
iflFileDesc* iflFileDescFullyParsed(const char* fileName,
int index, iflFormat* format,
const char* formatSpecific)
Get and set methods
void iflFileDescSetFileDesc(iflFileDesc *obj, int filedesc)
iflStatus iflFileDescGetStatus(iflFileDesc *obj)
const char* iflFileDescGetFileName(iflFileDesc *obj)
int iflFileDescGetFileDesc(iflFileDesc *obj)
int iflFileDescGetIndex(iflFileDesc *obj)
const char* iflFileDescGetFormatName(iflFileDesc *obj)
iflFormat* iflFileDescGetFormat(iflFileDesc *obj)
const char* iflFileDescGetFormatSpecific(iflFileDesc *obj)
FUNCTION DESCRIPTIONSiflFileDesc()
Page 1
iflFileDesc(3) Image Format Library C++ Reference Manual iflFileDesc(3)
iflFileDesc* iflFileDescPreParsed(const char* fileName,
int index, const char* formatName,
const char* formatSpecific)
iflFileDesc* iflFileDescFullyParsed(const char* fileName,
int index, iflFormat* format,
const char* formatSpecific)
iflFileDesc* iflFileDescCreate(const char* name, iflFormat* format)
The first contructor creates a descriptor by parsing a IFL file name
into it's components: Unix file name, image index, format name and
format specifc string. The second contructor creates a descriptor
from an already parsed name, The third version is the same as the
second except it takes the format by pointer instead of by name.
getFileDesc()
int iflFileDescGetFileDesc(iflFileDesc *obj)
This method returns the Unix file descriptor.
getFileName()
const char* iflFileDescGetFileName(iflFileDesc *obj)
This method returns the Unix file name portion of the parsed name.
getFormat()
iflFormat* iflFileDescGetFormat(iflFileDesc *obj)
This method returns the iflFormat* for the format name portion of
the parsed name.
getFormatName()
const char* iflFileDescGetFormatName(iflFileDesc *obj)
This method returns the format name portion of the parsed name.
getFormatSpecific()
const char* iflFileDescGetFormatSpecific(iflFileDesc *obj)
This method returns the format specifc portion of the parsed name.
Page 2
iflFileDesc(3) Image Format Library C++ Reference Manual iflFileDesc(3)getIndex()
int iflFileDescGetIndex(iflFileDesc *obj)
This method returns the sub-image index portion of the parsed name.
getStatus()
iflStatus iflFileDescGetStatus(iflFileDesc *obj)
This method returns the status of parsing the file name (e.g. if an
unknown format name was encoutered).
setFileDesc()
void iflFileDescSetFileDesc(iflFileDesc *obj, int filedesc)
This method can be used to let IFL know that the file is already
opened and to used this file descriptor rather than re-opening it.
SEE ALSOiflFile(3), iflFormat(3)
Page 3
