VIPER REFERENCE MANUAL


NAME
iflFileConfig - iflFile configuration descriptor

HEADER FILE
#include <ifl/iflFileConfig.h>

PUBLIC METHOD SUMMARY

   Constructing and initializing
iflFileConfig ( const iflSize* imagedims=NULL, iflDataType datatype=iflDataType(0), iflOrder dimensionorder=iflOrder(0), iflColorModel colormodel=iflColorModel(0), iflOrientation orientation=iflOrientation(0), iflCompression compression=iflCompression(0), const iflSize* pagedims=NULL);
iflFileConfig ( iflFile* file);
void reset (  );

   Setting attributes
void setDimensions ( const iflSize& imagedims);
void setDataType ( iflDataType datatype);
void setOrder ( iflOrder dimensionorder);
void setColorModel ( iflColorModel colormodel);
void setOrientation ( iflOrientation orientation);
void setCompression ( iflCompression compression);
void setPageDimensions ( const iflSize& pagedims);

   Getting current attributes
void getDimensions ( iflSize& imagedims);
const iflSize& getDimensions (  );
void getSize ( iflSize& imagesize);
iflDataType getDataType (  );
iflOrder getOrder (  );
iflColorModel getColorModel (  );
iflOrientation getOrientation (  );
iflCompression getCompression (  );
void getPageDimensions ( iflSize& pagedims);
const iflSize& getPageDimensions (  );
void getPageSize ( iflSize& pagesize);

   Querying which attributes were defaulted
int areDimensionsDefaulted (  );
int isDataTypeDefaulted (  );
int isOrderDefaulted (  );
int isColorModelDefaulted (  );
int isOrientationDefaulted (  );
int isCompressionDefaulted (  );
int arePageDimensionsDefaulted (  );

CLASS DESCRIPTION
iflFileConfig describes the configuration of an iflFile; it is used with the iflFile::create() and iflFormat::applyDefaults() calls. The image and page size attributes are always expressed with conventional (x == width, y == height) orientation, regardless of the value of the orientation attribute.

METHOD DESCRIPTIONS

   iflFileConfig()
iflFileConfig ( const iflSize* imagedims=NULL, iflDataType datatype=iflDataType(0), iflOrder dimensionorder=iflOrder(0), iflColorModel colormodel=iflColorModel(0), iflOrientation orientation=iflOrientation(0), iflCompression compression=iflCompression(0), const iflSize* pagedims=NULL);
iflFileConfig ( iflFile* file);

These constructors create fully initialized iflFile configuration descriptors. The second form takes the attribute values from file. With either version attributes can be overridden later using the various set methods.

   areDimensionsDefaulted()
int areDimensionsDefaulted (  );

This method returns TRUE if any of the image dimensions have been defaulted.

   arePageDimensionsDefaulted()
int arePageDimensionsDefaulted (  );

This method returns TRUE if any of the page dimensions have been defaulted.

   getColorModel()
iflColorModel getColorModel (  );

This method returns the value of the color model attribute.

   getCompression()
iflCompression getCompression (  );

This method returns the value of the compression attribute.

   getDataType()
iflDataType getDataType (  );

This method returns the value of the data type attribute.

   getDimensions()
void getDimensions ( iflSize& imagedims);
const iflSize& getDimensions (  );

The first form of this method returns the value of the image dimensions attribute in imagedims. The second version returns it as a const reference.

   getOrder()
iflOrder getOrder (  );

This method returns the value of the dimension order attribute.

   getOrientation()
iflOrientation getOrientation (  );

This method returns the value of the orientation attribute.

   getPageDimensions()
void getPageDimensions ( iflSize& pagedims);
const iflSize& getPageDimensions (  );

The first form of this method returns the value of the page dimensions attribute in pagedims. The second version returns it as a const reference.

   getPageSize()
void getPageSize ( iflSize& pagesize);

This method returns the value of the page dimensions in pagesize, transposing them if the orientation is transposed.

   getSize()
void getSize ( iflSize& imagesize);

This method returns the image dimensions in imagesize, transposing them if the orientation is transposed.

   isColorModelDefaulted()
int isColorModelDefaulted (  );

This method returns TRUE if the color model attribute is defaulted.

   isCompressionDefaulted()
int isCompressionDefaulted (  );

This method returns TRUE if the compression attribute is defaulted.

   isDataTypeDefaulted()
int isDataTypeDefaulted (  );

This method returns TRUE if the data type attribute is defaulted.

   isOrderDefaulted()
int isOrderDefaulted (  );

This method returns TRUE if the dimension order attribute is defaulted.

   isOrientationDefaulted()
int isOrientationDefaulted (  );

This method returns TRUE if the orientation attribute is defaulted.

   reset()
void reset (  );

This method restores the configuration to the default state (no attributes given).

   setColorModel()
void setColorModel ( iflColorModel colormodel);

This method sets the value of the color model attribute to colormodel.

   setCompression()
void setCompression ( iflCompression compression);

This method sets the value of the compression attribute to compression.

   setDataType()
void setDataType ( iflDataType datatype);

This method sets the value of the data type attribute to datatype.

   setDimensions()
void setDimensions ( const iflSize& imagedims);

This method sets the value of the image dimension attribute to imagedims.

   setOrder()
void setOrder ( iflOrder dimensionorder);

This method sets the value of the dimension order attribute to dimensionorder.

   setOrientation()
void setOrientation ( iflOrientation orientation);

This method sets the value of the orientation attribute to orientation.

   setPageDimensions()
void setPageDimensions ( const iflSize& pagedims);

This method sets the value of the page dimension attribute to pagedims.

SEE ALSO
iflFile, iflFormat