iflFileConfig(3)

NAME
     iflFileConfig - iflFile configuration descriptor

INHERITS FROM
     This is a base class

HEADER FILE
     #include <ifl/iflFileConfig.h>

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 parameters are always expressed with conventional (x ==
     width, y == height) orientation, regardless of the value of the
     orientation parameter.

CLASS MEMBER FUNCTION SUMMARY
     Constructor

          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)

     Get/set input methods

          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)
          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)

     Query methods
          int areDimensionsDefaulted()
          int isDataTypeDefaulted()
          int isOrderDefaulted()
          int isColorModelDefaulted()
          int isOrientationDefaulted()
          int isCompressionDefaulted()
          int arePageDimensionsDefaulted()


FUNCTION 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)


          This constructor creates a fully initialized iflFile configuration
          descriptor.  Defaulted attributes can be set later with 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 parameter.

     getCompression()

          iflCompression getCompression()


          This method returns the value of the compression parameter.

     getDataType()

          iflDataType getDataType()


          This method returns the value of the data type parameter.

     getDimensions()

          void getDimensions(iflSize& imagedims)


          This method returns the value of the image dimensions parameter.

     getOrder()

          iflOrder getOrder()


          This method returns the value of the dimension order parameter.

     getOrientation()

          iflOrientation getOrientation()


          This method returns the value of the orientation parameter.

     getPageDimensions()

          void getPageDimensions(iflSize& pagedims)


          This method returns the value of the page dimensions parameter.

     getPageSize()

          void getPageSize(iflSize& pagesize)


          This method returns the value of the page dimensions parameter.

     getSize()

          void getSize(iflSize& imagesize)
          This method returns the image dimensions, transposing them if the
          orientation is transposed.

     isColorModelDefaulted()

          int isColorModelDefaulted()


          This method returns true if the color model parameter is defaulted.

     isCompressionDefaulted()

          int isCompressionDefaulted()


          This method returns true if the compression parameter is defaulted.

     isDataTypeDefaulted()

          int isDataTypeDefaulted()


          This method returns true if the data type parameter is defaulted.

     isOrderDefaulted()

          int isOrderDefaulted()


          This method returns true if the dimension order parameter is
          defaulted.

     isOrientationDefaulted()

          int isOrientationDefaulted()


          This method returns true if the orientation parameter is defaulted.

     setColorModel()

          void setColorModel(iflColorModel colormodel)


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

     setCompression()

          void setCompression(iflCompression compression)
          This method sets the value of the compression parameter to
          compression.

     setDataType()

          void setDataType(iflDataType datatype)


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

     setDimensions()

          void setDimensions(const iflSize& imagedims)


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

     setOrder()

          void setOrder(iflOrder dimensionorder)


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

     setOrientation()

          void setOrientation(iflOrientation orientation)


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

     setPageDimensions()

          void setPageDimensions(const iflSize& pagedims)


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

SEE ALSO
     iflFile(3), iflFormat(3)