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

CIccTagCurve Class Reference

#include <IccTagLut.h>

Inheritance diagram for CIccTagCurve:

CIccCurve CIccTag List of all members.

Public Member Functions

 CIccTagCurve (int nSize=0)
 CIccTagCurve (const CIccTagCurve &ITCurve)
CIccTagCurveoperator= (const CIccTagCurve &CurveTag)
virtual CIccTagNewCopy () const
virtual ~CIccTagCurve ()
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)
icFloatNumberoperator[] (icUInt32Number index)
icFloatNumberGetData (icUInt32Number index)
icUInt32Number GetSize () const
void SetSize (icUInt32Number nSize, icTagCurveSizeInit nSizeOpt=icInitZero)
void SetGamma (icFloatNumber gamma)
virtual void Begin ()
virtual icFloatNumber Apply (icFloatNumber v)
virtual icValidateStatus Validate (icTagSignature sig, std::string &sReport, const CIccProfile *pProfile=NULL) const
virtual bool IsIdentity ()

Protected Attributes

icUInt32Number m_nSize
icUInt16Number m_nMaxIndex

Detailed Description

Class: CIccTagCurve

Purpose: The curveType tag

Constructor & Destructor Documentation

CIccTagCurve::CIccTagCurve int  nSize = 0  ) 

Name: CIccTagCurve::CIccTagCurve

Purpose: Constructor

CIccTagCurve::CIccTagCurve const CIccTagCurve ITCurve  ) 

Name: CIccTagCurve::CIccTagCurve

Purpose: Copy Constructor

Args: ITCurve = The CIccTagCurve object to be copied

CIccTagCurve::~CIccTagCurve  )  [virtual]

Name: CIccTagCurve::~CIccTagCurve

Purpose: Destructor

Member Function Documentation

icFloatNumber CIccTagCurve::Apply icFloatNumber  v  )  [virtual]

Name: CIccTagCurve::Apply

Purpose: Applies the curve to the value passed.

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

Return: The value modified by the curve.

Reimplemented from CIccCurve.

virtual void CIccTagCurve::Begin  )  [inline, virtual]

Reimplemented from CIccCurve.

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

Name: CIccTagCurve::Describe

Purpose: Dump data associated with the tag to a string

Args: sDescription - string to concatenate tag dump to

Reimplemented from CIccTag.

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

Name: CIccTagCurve::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 LUT data, nIndex = the channel number of color space

Reimplemented from CIccCurve.

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

Reimplemented from CIccTag.

icFloatNumber* CIccTagCurve::GetData icUInt32Number  index  )  [inline]

icUInt32Number CIccTagCurve::GetSize  )  const [inline]

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

Function: GetType()

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

Reimplemented from CIccTag.

bool CIccTagCurve::IsIdentity  )  [virtual]

Name: CIccTagCurve::IsIdentity

Purpose: Checks if this is an identity curve.

Return: true if the curve is an identity

Reimplemented from CIccCurve.

virtual CIccTag* CIccTagCurve::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.

CIccTagCurve & CIccTagCurve::operator= const CIccTagCurve CurveTag  ) 

Name: CIccTagCurve::operator=

Purpose: Copy Operator

Args: CurveTag = The CIccTagCurve object to be copied

icFloatNumber& CIccTagCurve::operator[] icUInt32Number  index  )  [inline]

bool CIccTagCurve::Read icUInt32Number  size,

Name: CIccTagCurve::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.

void CIccTagCurve::SetGamma icFloatNumber  gamma  ) 

Name: sampleICC::CIccTagCurve::SetGamma

Purpose: Set the curve with a single gamma value.

Args: gamma - gamma value to use

void CIccTagCurve::SetSize icUInt32Number  nSize,
icTagCurveSizeInit  nSizeOpt = icInitZero

Name: CIccTagCurve::SetSize

Purpose: Sets the size of the curve array.

Args: nSize - number of entries in the curve, nSizeOpt - flag to zero newly formed values

icValidateStatus CIccTagCurve::Validate icTagSignature  sig,
std::string &  sReport,
const CIccProfile pProfile = NULL
const [virtual]

Name: CIccTagCurve::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.

Reimplemented from CIccTag.

bool CIccTagCurve::Write CIccIO pIO  )  [virtual]

Name: CIccTagCurve::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* CIccTagCurve::m_Curve [protected]

icUInt16Number CIccTagCurve::m_nMaxIndex [protected]

icUInt32Number CIccTagCurve::m_nSize [protected]

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