CIccTagColorantTable Class Reference

Class: CIccTagColorantTable. More...

#include <IccTagBasic.h>

Inheritance diagram for CIccTagColorantTable:

Collaboration diagram for CIccTagColorantTable:

Public Member Functions
	CIccTagColorantTable (const CIccTagColorantTable &ITCT)
	Name: CIccTagColorantTable::CIccTagColorantTable.
	CIccTagColorantTable (int nsize=1)
	Name: CIccTagColorantTable::CIccTagColorantTable.
virtual void	Describe (std::string &sDescription, int nVerboseness)
	Name: CIccTagColorantTable::Describe.
virtual const icChar *	GetClassName () const
icColorantTableEntry *	GetEntry (icUInt32Number index)
icColorSpaceSignature	GetPCS () const
icUInt32Number	GetSize () const
virtual icTagTypeSignature	GetType () const
	Function: GetType()
virtual CIccTag *	NewCopy () const
	Function: NewCopy(sDescription) Each derived tag will implement it's own NewCopy() function.
CIccTagColorantTable &	operator= (const CIccTagColorantTable &ColorantTableTag)
	Name: CIccTagColorantTable::operator=.
icColorantTableEntry &	operator[] (icUInt32Number index)
virtual bool	Read (icUInt32Number size, CIccIO *pIO)
	Name: CIccTagColorantTable::Read.
void	SetPCS (icColorSpaceSignature sig)
bool	SetSize (icUInt16Number nSize, bool bZeroNew=true)
	Name: CIccTagColorantTable::SetSize.
virtual icValidateStatus	Validate (std::string sigPath, std::string &sReport, const CIccProfile *pProfile=NULL) const
	Name: CIccTagColorantTable::Validate.
virtual bool	Write (CIccIO *pIO)
	Name: CIccTagColorantTable::Write.
virtual	~CIccTagColorantTable ()
	Name: CIccTagColorantTable::~CIccTagColorantTable.
Public Member Functions inherited from CIccTag
	CIccTag ()
	Name: CIccTag::CIccTag.
virtual void	DetachIO ()
	Function: ReadAll() - Read All sub data for tag from file.
virtual IIccExtensionTag *	GetExtension ()
virtual icArraySignature	GetTagArrayType () const
virtual icStructSignature	GetTagStructType () const
virtual bool	IsArrayType ()
virtual bool	IsMBBType ()
virtual bool	IsNumArrayType () const
virtual bool	IsSupported ()
	Function: IsSupported(size, pIO) - Check if tag fully supported for apply purposes.
virtual bool	Read (icUInt32Number size, CIccIO *pIO, CIccProfile *pProfile)
	Function: Read(size, pIO) - Read tag from file.
virtual bool	ReadAll ()
	Function: ReadAll() - Read All sub data for tag from file.
virtual	~CIccTag ()
	Name: CIccTag::CIccTag.

Protected Attributes
icUInt32Number	m_nCount
icColorSpaceSignature	m_PCS
icColorantTableEntry *	m_pData

Additional Inherited Members
Static Public Member Functions inherited from CIccTag
static CIccTag *	Create (icTagTypeSignature sig)
	Name: CIccTag::Create.
Public Attributes inherited from CIccTag
icUInt32Number	m_nReserved

Detailed Description

Class: CIccTagColorantTable.

Purpose: Colorant Table Tag

Definition at line 1386 of file IccTagBasic.h.

Constructor & Destructor Documentation

CIccTagColorantTable() [1/2]

CIccTagColorantTable::CIccTagColorantTable

(

int

nSize = 1

)

Name: CIccTagColorantTable::CIccTagColorantTable.

Purpose: Constructor

Args: nSize = number of entries

Definition at line 8552 of file IccTagBasic.cpp.

{
  m_nCount = nSize;
  if (m_nCount<1)
    m_nCount = 1;
 
  m_pData = (icColorantTableEntry*)calloc(nSize, sizeof(icColorantTableEntry));
}

CIccTagColorantTable() [2/2]

CIccTagColorantTable::CIccTagColorantTable

(

const CIccTagColorantTable &

ITCT

)

Name: CIccTagColorantTable::CIccTagColorantTable.

Purpose: Copy Constructor

Args: ITCT = The CIccTagUnknown object to be copied

Definition at line 8572 of file IccTagBasic.cpp.

{
  m_PCS = ITCT.m_PCS;
  m_nCount = ITCT.m_nCount;
 
  m_pData = (icColorantTableEntry*)calloc(m_nCount, sizeof(icColorantTableEntry));
  memcpy(m_pData, ITCT.m_pData, m_nCount*sizeof(icColorantTableEntry));
}

References m_nCount, m_PCS, and m_pData.

~CIccTagColorantTable()

CIccTagColorantTable::~CIccTagColorantTable ( )

virtual

Name: CIccTagColorantTable::~CIccTagColorantTable.

Purpose: Destructor

Definition at line 8617 of file IccTagBasic.cpp.

{
  if (m_pData)
    free(m_pData);
}

Member Function Documentation

Describe()

void CIccTagColorantTable::Describe ( std::string & sDescription, int nVerboseness )

virtual

Name: CIccTagColorantTable::Describe.

Purpose: Dump data associated with the tag to a string

Args: sDescription - string to concatenate tag dump to

Reimplemented from CIccTag.

Definition at line 8738 of file IccTagBasic.cpp.

{
  icChar buf[128];
 
  icUInt32Number i, nLen, nMaxLen=0;
  icFloatNumber Lab[3] = {0};
 
  sprintf(buf, "BEGIN_COLORANTS %u\n", m_nCount);
  sDescription += buf;
 
  for (i=0; i<m_nCount; i++) {
    nLen = (icUInt32Number)strlen(m_pData[i].name);
    if (nLen>nMaxLen)
      nMaxLen =nLen;
  }
  sDescription += "# NAME ";
 
  if (m_PCS == icSigXYZData) {
    sprintf(buf, "XYZ_X XYZ_Y XYZ_Z\n");
    sDescription += buf;
  }
  else {
    sprintf(buf, "Lab_L Lab_a Lab_b\n");
    sDescription += buf;
  }
  for (i=0; i<m_nCount; i++) {
    sprintf(buf, "%2u \"%s\"", i, m_pData[i].name);
    sDescription += buf;
    memset(buf, ' ', 128);
    buf[nMaxLen + 1 - strlen(m_pData[i].name)] ='\0';
    sDescription += buf;
 
    if (m_PCS == icSigXYZData) {
      sprintf(buf, "%7.4lf %7.4lf %7.4lf\n", icUSFtoD(m_pData[i].data[0]), icUSFtoD(m_pData[i].data[1]), icUSFtoD(m_pData[i].data[2]));
      sDescription += buf;
    }
    else {
      Lab[0] = icU16toF(m_pData[i].data[0]);
      Lab[1] = icU16toF(m_pData[i].data[1]);
      Lab[2] = icU16toF(m_pData[i].data[2]);
      icLabFromPcs(Lab);
      sprintf(buf, "%7.4lf %8.4lf %8.4lf\n", Lab[0], Lab[1], Lab[2]);
      sDescription += buf;
    }
  }
 
}

References icLabFromPcs(), icSigXYZData, icU16toF(), and icUSFtoD().

Here is the call graph for this function:

GetClassName()

virtual const icChar * CIccTagColorantTable::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTag.

Reimplemented in CIccTagXmlColorantTable.

Definition at line 1396 of file IccTagBasic.h.

{ return "CIccTagColorantTable"; }

GetEntry()

icColorantTableEntry * CIccTagColorantTable::GetEntry ( icUInt32Number index )

inline

Definition at line 1404 of file IccTagBasic.h.

{return &m_pData[index];}

GetPCS()

icColorSpaceSignature CIccTagColorantTable::GetPCS ( ) const

inline

Definition at line 1409 of file IccTagBasic.h.

{return m_PCS;};

GetSize()

icUInt32Number CIccTagColorantTable::GetSize ( ) const

inline

Definition at line 1405 of file IccTagBasic.h.

{ return m_nCount; }

GetType()

virtual icTagTypeSignature CIccTagColorantTable::GetType ( ) const

inlinevirtual

Function: GetType()

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

Reimplemented from CIccTag.

Definition at line 1395 of file IccTagBasic.h.

{ return icSigColorantTableType; }

References icSigColorantTableType.

NewCopy()

virtual CIccTag * CIccTagColorantTable::NewCopy ( ) const

inlinevirtual

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 CIccTag.

Definition at line 1392 of file IccTagBasic.h.

{return new CIccTagColorantTable(*this);}

operator=()

CIccTagColorantTable & CIccTagColorantTable::operator=

(

const CIccTagColorantTable &

ColorantTableTag

)

Name: CIccTagColorantTable::operator=.

Purpose: Copy Operator

Args: ColorantTableTag = The CIccTagColorantTable object to be copied

Definition at line 8592 of file IccTagBasic.cpp.

{
  if (&ColorantTableTag == this)
    return *this;
 
  m_PCS = ColorantTableTag.m_PCS;
  m_nCount = ColorantTableTag.m_nCount;
 
  if (m_pData)
    free(m_pData);
  m_pData = (icColorantTableEntry*)calloc(m_nCount, sizeof(icColorantTableEntry));
  memcpy(m_pData, ColorantTableTag.m_pData, m_nCount*sizeof(icColorantTableEntry));
 
  return *this;
}

References m_nCount, m_PCS, and m_pData.

operator[]()

icColorantTableEntry & CIccTagColorantTable::operator[] ( icUInt32Number index )

inline

Definition at line 1403 of file IccTagBasic.h.

{return m_pData[index];}

Read()

bool CIccTagColorantTable::Read ( icUInt32Number size, CIccIO * pIO )

virtual

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

Definition at line 8638 of file IccTagBasic.cpp.

{
  icTagTypeSignature sig;
  icUInt32Number nCount;
 
  if (sizeof(icTagTypeSignature) + 
      sizeof(icUInt32Number) + 
      sizeof(icUInt32Number) +
      sizeof(icColorantTableEntry) > size)
    return false;
 
  if (!pIO) {
    return false;
  }
 
  if (!pIO->Read32(&sig))
    return false;
 
  if (!pIO->Read32(&m_nReserved))
    return false;
 
  if (!pIO->Read32(&nCount))
    return false;
 
  icUInt32Number nNum = (size - 3*sizeof(icUInt32Number))/sizeof(icColorantTableEntry);
  icUInt32Number nNum8 = sizeof(m_pData->name);
  icUInt32Number nNum16 = sizeof(m_pData->data)/sizeof(icUInt16Number);
 
  if (nNum < nCount || nCount > 0xffff)
    return false;
  
  if (!SetSize((icUInt16Number)nCount))
    return false;
 
  for (icUInt32Number i=0; i<nCount; i++) {
    if (pIO->Read8(&m_pData[i].name[0], nNum8) != (icInt32Number)nNum8)
      return false;
 
    if (pIO->Read16(&m_pData[i].data[0], nNum16) != (icInt32Number)nNum16)
      return false;
  }
 
  return true;
}

References CIccIO::Read16(), CIccIO::Read32(), CIccIO::Read8(), and sig.

Here is the call graph for this function:

SetPCS()

void CIccTagColorantTable::SetPCS ( icColorSpaceSignature sig )

inline

Definition at line 1408 of file IccTagBasic.h.

{m_PCS = sig;}

References sig.

SetSize()

bool CIccTagColorantTable::SetSize	(	icUInt16Number	nSize,
		bool	bZeroNew = true )

Name: CIccTagColorantTable::SetSize.

Purpose: Sets the size of the data array.

Args: nSize - number of entries, bZeroNew - flag to zero newly formed values

Definition at line 8797 of file IccTagBasic.cpp.

{
  if (m_nCount == nSize)
    return true;
 
  m_pData = (icColorantTableEntry*)icRealloc(m_pData, nSize*sizeof(icColorantTableEntry));
 
  if (!m_pData) {
    m_nCount = 0;
    return false;
  }
 
  if (bZeroNew && nSize > m_nCount) {
    memset(&m_pData[m_nCount], 0, (nSize-m_nCount)*sizeof(icColorantTableEntry));
  }
  m_nCount = nSize;
 
  return true;
}

References icRealloc().

Here is the call graph for this function:

Validate()

icValidateStatus CIccTagColorantTable::Validate ( std::string sigPath, std::string & sReport, const CIccProfile * pProfile = NULL ) const

virtual

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

Definition at line 8832 of file IccTagBasic.cpp.

{
  icValidateStatus rv = CIccTag::Validate(sigPath, sReport, pProfile);
 
  CIccInfo Info;
  std::string sSigPathName = Info.GetSigPathName(sigPath);
  icSignature sig = icGetFirstSigPathSig(sigPath);
 
  if (!pProfile) {
    sReport += icMsgValidateWarning;
    sReport += sSigPathName;
    sReport += " - Tag validation incomplete: Pointer to profile unavailable.\n";
    rv = icMaxStatus(rv, icValidateWarning);
    return rv;
  }
 
 
  if (sig==icSigColorantTableOutTag) {
    if (pProfile->m_Header.deviceClass!=icSigLinkClass) {
      sReport += icMsgValidateNonCompliant;
      sReport += sSigPathName;
      sReport += " - Use of this tag is allowed only in DeviceLink Profiles.\n";
      rv = icMaxStatus(rv, icValidateNonCompliant);
    }
    if (m_nCount != icGetSpaceSamples(pProfile->m_Header.pcs)) {
      sReport += icMsgValidateNonCompliant;
      sReport += sSigPathName;
      sReport += " - Incorrect number of colorants.\n";
      rv = icMaxStatus(rv, icValidateNonCompliant);
    }
  }
  else {
    if (m_nCount != icGetSpaceSamples(pProfile->m_Header.colorSpace)) {
      sReport += icMsgValidateNonCompliant;
      sReport += sSigPathName;
      sReport += " - Incorrect number of colorants.\n";
      rv = icMaxStatus(rv, icValidateNonCompliant);
    }
  }
 
  return rv;
}

References CIccInfo::GetSigPathName(), icGetFirstSigPathSig(), icGetSpaceSamples(), icMaxStatus(), icMsgValidateNonCompliant, icMsgValidateWarning, icSigColorantTableOutTag, icSigLinkClass, icValidateNonCompliant, icValidateWarning, sig, and CIccTag::Validate().

Here is the call graph for this function:

Write()

bool CIccTagColorantTable::Write ( CIccIO * pIO )

virtual

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

Definition at line 8697 of file IccTagBasic.cpp.

{
  icTagTypeSignature sig = GetType();
 
  if (!pIO)
   return false;
 
  if (!pIO->Write32(&sig))
   return false;
 
  if (!pIO->Write32(&m_nReserved))
    return false;
 
  if (!pIO->Write32(&m_nCount))
    return false;
 
  icUInt32Number nNum8 = sizeof(m_pData->name);
  icUInt32Number nNum16 = sizeof(m_pData->data)/sizeof(icUInt16Number);
 
  for (icUInt32Number i=0; i<m_nCount; i++) {
    if (pIO->Write8(&m_pData[i].name[0],nNum8) != (icInt32Number)nNum8)
      return false;
 
    if (pIO->Write16(&m_pData[i].data[0],nNum16) != (icInt32Number)nNum16)
      return false;
  }
 
  return true;
}

References sig, CIccIO::Write16(), CIccIO::Write32(), and CIccIO::Write8().

Here is the call graph for this function:

Member Data Documentation

m_nCount

icUInt32Number CIccTagColorantTable::m_nCount

protected

Definition at line 1413 of file IccTagBasic.h.

Referenced by CIccTagColorantTable(), and operator=().

m_PCS

icColorSpaceSignature CIccTagColorantTable::m_PCS

protected

Definition at line 1415 of file IccTagBasic.h.

Referenced by CIccTagColorantTable(), and operator=().

m_pData

icColorantTableEntry* CIccTagColorantTable::m_pData

protected

Definition at line 1414 of file IccTagBasic.h.

Referenced by CIccTagColorantTable(), and operator=().

---

The documentation for this class was generated from the following files:

• IccProfLib/IccTagBasic.h
• IccProfLib/IccTagBasic.cpp