SampleICC Main srcforge
Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

CIccTagParametricCurve Class Reference

#include <IccTagLut.h>

Inheritance diagram for CIccTagParametricCurve:

CIccCurve CIccTag List of all members.

Public Member Functions

 CIccTagParametricCurve ()
 CIccTagParametricCurve (const CIccTagParametricCurve &ITPC)
CIccTagParametricCurveoperator= (const CIccTagParametricCurve &ParamCurveTag)
virtual CIccTagNewCopy () const
virtual ~CIccTagParametricCurve ()
virtual icTagTypeSignature GetType ()
virtual const icCharGetClassName ()
virtual void Describe (std::string &sDescription)
virtual void DumpLut (std::string &sDescription, const icChar *szName, icColorSpaceSignature csSig, int nIndex)
virtual bool Read (icUInt32Number size, CIccIO *pIO)
virtual bool Write (CIccIO *pIO)
bool SetFunctionType (icUInt16Number nFunctionType)
icUInt16Number GetFunctionType () const
icUInt16Number GetNumParam () const
icS15Fixed16NumberGetParams () const
icS15Fixed16Number Param (int index) const
icS15Fixed16Numberoperator[] (int index)
virtual void Begin ()
virtual icFloatNumber Apply (icFloatNumber v)
virtual icValidateStatus Validate (icTagSignature sig, std::string &sReport, const CIccProfile *pProfile=NULL)
virtual bool IsIdentity ()

Protected Attributes

icUInt16Number m_nReserved2
icUInt16Number m_nFunctionType
icUInt16Number m_nNumParam

Detailed Description

Class: CIccTagParametricCurve

Purpose: The parametric curve type tag

Constructor & Destructor Documentation

CIccTagParametricCurve::CIccTagParametricCurve  ) 

Name: CIccTagParametricCurve::CIccTagParametricCurve

Purpose: Constructor

CIccTagParametricCurve::CIccTagParametricCurve const CIccTagParametricCurve ITPC  ) 

Name: CIccTagParametricCurve::CIccTagParametricCurve

Purpose: Copy Constructor

Args: ITPC = The CIccTagParametricCurve object to be copied

CIccTagParametricCurve::~CIccTagParametricCurve  )  [virtual]

Name: CIccTagParametricCurve::~CIccTagParametricCurve

Purpose: Destructor

Member Function Documentation

icFloatNumber CIccTagParametricCurve::Apply icFloatNumber  X  )  [virtual]

Name: CIccTagParametricCurve::Apply

Purpose: Applies the curve to the value passed.

Args: x = value to be passed through the curve.

Return: The value modified by the curve.

Reimplemented from CIccCurve.

void CIccTagParametricCurve::Begin  )  [virtual]

Name: CIccTagParametricCurve::Begin

Purpose: Initializes the curve. Must be called before Apply().

Reimplemented from CIccCurve.

void CIccTagParametricCurve::Describe std::string &  sDescription  )  [virtual]

Name: CIccTagParametricCurve::Describe

Purpose: Dump data associated with the tag to a string

Args: sDescription - string to concatenate tag dump to

Reimplemented from CIccTag.

void CIccTagParametricCurve::DumpLut std::string &  sDescription,
const icChar szName,
icColorSpaceSignature  csSig,
int  nIndex

Name: CIccTagParametricCurve::DumpLut

Purpose: Dump data associated with the tag to a string. Basically has the same function as Describe()

Args: sDescription = string to concatenate tag dump to, szName = name of the curve to be printed, csSig = color space signature of the curve data, nIndex = the channel number of color space

Reimplemented from CIccCurve.

virtual const icChar* CIccTagParametricCurve::GetClassName  )  [inline, virtual]

Reimplemented from CIccTag.

icUInt16Number CIccTagParametricCurve::GetFunctionType  )  const [inline]

icUInt16Number CIccTagParametricCurve::GetNumParam  )  const [inline]

icS15Fixed16Number* CIccTagParametricCurve::GetParams  )  const [inline]

virtual icTagTypeSignature CIccTagParametricCurve::GetType  )  [inline, virtual]

Function: GetType()

Purpose: Get Tag Type. Each derived tag will implement it's own GetType() function.

Reimplemented from CIccTag.

bool CIccTagParametricCurve::IsIdentity  )  [virtual]

Name: CIccTagParametricCurve::IsIdentity

Purpose: Checks if this is an identity curve.

Return: true if the curve is an identity

Reimplemented from CIccCurve.

virtual CIccTag* CIccTagParametricCurve::NewCopy  )  const [inline, virtual]

Function: NewCopy(sDescription) Each derived tag will implement it's own NewCopy() function.

Parameter(s): none

Returns a new CIccTag object that is a copy of this object.

Reimplemented from CIccCurve.

CIccTagParametricCurve & CIccTagParametricCurve::operator= const CIccTagParametricCurve ParamCurveTag  ) 

Name: CIccTagParametricCurve::operator=

Purpose: Copy Operator

Args: ParamCurveTag = The CIccTagParametricCurve object to be copied

icS15Fixed16Number& CIccTagParametricCurve::operator[] int  index  )  [inline]

icS15Fixed16Number CIccTagParametricCurve::Param int  index  )  const [inline]

bool CIccTagParametricCurve::Read icUInt32Number  size,

Name: CIccTagParametricCurve::Read

Purpose: Read in the tag contents into a data block

Args: size - # of bytes in tag, pIO - IO object to read tag from

Return: true = successful, false = failure

Reimplemented from CIccTag.

bool CIccTagParametricCurve::SetFunctionType icUInt16Number  nFunctionType  ) 

Name: CIccTagParametricCurve::SetFunctionType

Purpose: Sets the type of the function the Parametric curve represents

Args: nFunctionType = the type of the function encoded as 0-4

Return: always true!!

icValidateStatus CIccTagParametricCurve::Validate icTagSignature  sig,
std::string &  sReport,
const CIccProfile pProfile = NULL

Name: CIccTagParametricCurve::Validate

Purpose: Check tag data validity.

Args: sig = signature of tag being validated, sReport = String to add report information to

Return: icValidateStatusOK if valid, or other error status.

bool CIccTagParametricCurve::Write CIccIO pIO  )  [virtual]

Name: CIccTagParametricCurve::Write

Purpose: Write the tag to a file

Args: pIO - The IO object to write tag to.

Return: true = succesful, false = failure

Reimplemented from CIccTag.

Member Data Documentation

icFloatNumber* CIccTagParametricCurve::m_dParam [protected]

icUInt16Number CIccTagParametricCurve::m_nFunctionType [protected]

icUInt16Number CIccTagParametricCurve::m_nNumParam [protected]

icUInt16Number CIccTagParametricCurve::m_nReserved2 [protected]

icS15Fixed16Number* CIccTagParametricCurve::m_Param [protected]

The documentation for this class was generated from the following files:
Generated on Tue Jun 26 17:51:46 2007 for IccProfLib by  doxygen