iflFileConfig(3)

NAME
     iflFileConfig - iflFile configuration descriptor

INHERITS FROM
     This is a base class

HEADER FILE
     #include <ifl/iflCdefs.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* iflFileConfigCreate(const iflSize* imagedims,
                                             iflDataType datatype (0),
                                             iflOrder dimensionorder (0),
                                             iflColorModel colormodel (0),
                                             iflOrientation orientation (0),
                                             iflCompression compression (0),
                                             const iflSize* pagedims )
          iflFileConfig* iflFileConfigFile(iflFile* file)

     Get/set input methods

          void iflFileConfigSetDimensions(iflFileConfig *obj, const iflSize* imagedims)
          void iflFileConfigSetDataType(iflFileConfig *obj, iflDataType datatype)
          void iflFileConfigSetOrder(iflFileConfig *obj, iflOrder dimensionorder)
          void iflFileConfigSetColorModel(iflFileConfig *obj, iflColorModel colormodel)
          void iflFileConfigSetOrientation(iflFileConfig *obj, iflOrientation orientation)
          void iflFileConfigSetCompression(iflFileConfig *obj, iflCompression compression)
          void iflFileConfigSetPageDimensions(iflFileConfig *obj,
                                              const iflSize* pagedims)
          void iflFileConfigGetDimensions(iflFileConfig *obj, iflSize* imagedims)
          const iflSize& getDimensionsPtr()
          void iflFileConfigGetSize(iflFileConfig *obj, iflSize* imagesize)
          iflDataType iflFileConfigGetDataType(iflFileConfig *obj)
          iflOrder iflFileConfigGetOrder(iflFileConfig *obj)
          iflColorModel iflFileConfigGetColorModel(iflFileConfig *obj)
          iflOrientation iflFileConfigGetOrientation(iflFileConfig *obj)
          iflCompression iflFileConfigGetCompression(iflFileConfig *obj)
          iflFileConfig* getPageDimensionsPtr()
          void iflFileConfigGetPageDimensions(iflFileConfig *obj,
                                              iflSize* pagedims)

     Query methods
          int iflFileConfigAreDimensionsDefaulted(iflFileConfig *obj)
          int iflFileConfigIsDataTypeDefaulted(iflFileConfig *obj)
          int iflFileConfigIsOrderDefaulted(iflFileConfig *obj)
          int iflFileConfigIsColorModelDefaulted(iflFileConfig *obj)
          int iflFileConfigIsOrientationDefaulted(iflFileConfig *obj)
          int iflFileConfigIsCompressionDefaulted(iflFileConfig *obj)
          int iflFileConfigArePageDimensionsDefaulted(iflFileConfig *obj)


FUNCTION DESCRIPTIONS
     iflFileConfig()

          iflFileConfig* iflFileConfigCreate(const iflSize* imagedims,
                                             iflDataType datatype (0),
                                             iflOrder dimensionorder (0),
                                             iflColorModel colormodel (0),
                                             iflOrientation orientation (0),
                                             iflCompression compression (0),
                                             const iflSize* pagedims )


          This constructor creates a fully initialized iflFile configuration
          descriptor.  Defaulted attributes can be set later with the various
          set methods.

     areDimensionsDefaulted()

          int iflFileConfigAreDimensionsDefaulted(iflFileConfig *obj)


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

     arePageDimensionsDefaulted()

          int iflFileConfigArePageDimensionsDefaulted(iflFileConfig *obj)


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

     getColorModel()

          iflColorModel iflFileConfigGetColorModel(iflFileConfig *obj)


          This method returns the value of the color model parameter.

     getCompression()

          iflCompression iflFileConfigGetCompression(iflFileConfig *obj)


          This method returns the value of the compression parameter.

     getDataType()

          iflDataType iflFileConfigGetDataType(iflFileConfig *obj)


          This method returns the value of the data type parameter.

     getDimensions()

          void iflFileConfigGetDimensions(iflFileConfig *obj, iflSize* imagedims)


          This method returns the value of the image dimensions parameter.

     getOrder()

          iflOrder iflFileConfigGetOrder(iflFileConfig *obj)


          This method returns the value of the dimension order parameter.

     getOrientation()

          iflOrientation iflFileConfigGetOrientation(iflFileConfig *obj)


          This method returns the value of the orientation parameter.

     getPageDimensions()

          void iflFileConfigGetPageDimensions(iflFileConfig *obj,
                                              iflSize* pagedims)


          This method returns the value of the page dimensions parameter.

     getPageSize()

          This method returns the value of the page dimensions parameter.

     getSize()

          void iflFileConfigGetSize(iflFileConfig *obj, iflSize* imagesize)

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

     isColorModelDefaulted()

          int iflFileConfigIsColorModelDefaulted(iflFileConfig *obj)


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

     isCompressionDefaulted()

          int iflFileConfigIsCompressionDefaulted(iflFileConfig *obj)


          This method returns true if the compression parameter is defaulted.

     isDataTypeDefaulted()

          int iflFileConfigIsDataTypeDefaulted(iflFileConfig *obj)


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

     isOrderDefaulted()

          int iflFileConfigIsOrderDefaulted(iflFileConfig *obj)


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

     isOrientationDefaulted()

          int iflFileConfigIsOrientationDefaulted(iflFileConfig *obj)


          This method returns true if the orientation parameter is defaulted.

     setColorModel()

          void iflFileConfigSetColorModel(iflFileConfig *obj, iflColorModel colormodel)


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

     setCompression()

          void iflFileConfigSetCompression(iflFileConfig *obj, iflCompression compression)

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

     setDataType()

          void iflFileConfigSetDataType(iflFileConfig *obj, iflDataType datatype)


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

     setDimensions()

          void iflFileConfigSetDimensions(iflFileConfig *obj, const iflSize* imagedims)


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

     setOrder()

          void iflFileConfigSetOrder(iflFileConfig *obj, iflOrder dimensionorder)


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

     setOrientation()

          void iflFileConfigSetOrientation(iflFileConfig *obj, iflOrientation orientation)


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

     setPageDimensions()

          void iflFileConfigSetPageDimensions(iflFileConfig *obj,
                                              const iflSize* pagedims)


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

SEE ALSO
     iflFile(3), iflFormat(3)