CIccTagColorantOrder Class Reference

Class: CIccTagColorantOrder. More...

#include <IccTagBasic.h>

Inheritance diagram for CIccTagColorantOrder:

Collaboration diagram for CIccTagColorantOrder:

Public Member Functions
	CIccTagColorantOrder (const CIccTagColorantOrder &ITCO)
	Name: CIccTagColorantOrder::CIccTagColorantOrder.
	CIccTagColorantOrder (int nsize=1)
	Name: CIccTagColorantOrder::CIccTagColorantOrder.
virtual void	Describe (std::string &sDescription, int nVerboseness)
	Name: CIccTagColorantOrder::Describe.
virtual const icChar *	GetClassName () const
icUInt8Number *	GetData (int index)
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.
CIccTagColorantOrder &	operator= (const CIccTagColorantOrder &ColorantOrderTag)
	Name: CIccTagColorantOrder::operator=.
icUInt8Number &	operator[] (int index)
virtual bool	Read (icUInt32Number size, CIccIO *pIO)
	Name: CIccTagColorantOrder::Read.
bool	SetSize (icUInt16Number nsize, bool bZeronew=true)
	Name: CIccTagColorantOrder::SetSize.
virtual icValidateStatus	Validate (std::string sigPath, std::string &sReport, const CIccProfile *pProfile=NULL) const
	Name: CIccTagColorantOrder::Validate.
virtual bool	Write (CIccIO *pIO)
	Name: CIccTagColorantOrder::Write.
virtual	~CIccTagColorantOrder ()
	Name: CIccTagColorantOrder::~CIccTagColorantOrder.
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
icUInt8Number *	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: CIccTagColorantOrder.

Purpose: Colorant Order Tag

Definition at line 1352 of file IccTagBasic.h.

Constructor & Destructor Documentation

CIccTagColorantOrder() [1/2]

CIccTagColorantOrder::CIccTagColorantOrder

(

int

nsize = 1

)

Name: CIccTagColorantOrder::CIccTagColorantOrder.

Purpose: Constructor

Args: nSize = number of channels

Definition at line 8265 of file IccTagBasic.cpp.

{
  m_nCount = nsize;
  if (m_nCount <1)
    m_nCount = 1;
  m_pData = (icUInt8Number*)calloc(nsize, sizeof(icUInt8Number));
}

CIccTagColorantOrder() [2/2]

CIccTagColorantOrder::CIccTagColorantOrder

(

const CIccTagColorantOrder &

ITCO

)

Name: CIccTagColorantOrder::CIccTagColorantOrder.

Purpose: Copy Constructor

Args: ITCO = The CIccTagColorantOrder object to be copied

Definition at line 8285 of file IccTagBasic.cpp.

{
  m_nCount = ITCO.m_nCount;
 
  m_pData = (icUInt8Number*)calloc(m_nCount, sizeof(icUInt8Number));
  memcpy(m_pData, ITCO.m_pData, sizeof(icUInt8Number)*m_nCount);
}

References m_nCount, and m_pData.

~CIccTagColorantOrder()

CIccTagColorantOrder::~CIccTagColorantOrder ( )

virtual

Name: CIccTagColorantOrder::~CIccTagColorantOrder.

Purpose: Destructor

Definition at line 8328 of file IccTagBasic.cpp.

{
  if (m_pData)
    free(m_pData);
}

Member Function Documentation

Describe()

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

virtual

Name: CIccTagColorantOrder::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 8436 of file IccTagBasic.cpp.

{
  icChar buf[128];
 
  sprintf(buf, "Colorant Count : %u\n", m_nCount);
  sDescription += buf;
  sDescription += "Order of Colorants:\n";
  
  for (int i=0; i<(int)m_nCount; i++) {
    sprintf(buf, "%u\n", m_pData[i]);
    sDescription += buf;
  }
}

GetClassName()

virtual const icChar * CIccTagColorantOrder::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTag.

Reimplemented in CIccTagXmlColorantOrder.

Definition at line 1362 of file IccTagBasic.h.

{ return "CIccTagColorantOrder"; }

GetData()

icUInt8Number * CIccTagColorantOrder::GetData ( int index )

inline

Definition at line 1369 of file IccTagBasic.h.

{ return &m_pData[index]; }

GetSize()

icUInt32Number CIccTagColorantOrder::GetSize ( ) const

inline

Definition at line 1371 of file IccTagBasic.h.

{return m_nCount;}

GetType()

virtual icTagTypeSignature CIccTagColorantOrder::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 1361 of file IccTagBasic.h.

{ return icSigColorantOrderType; }

References icSigColorantOrderType.

NewCopy()

virtual CIccTag * CIccTagColorantOrder::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 1358 of file IccTagBasic.h.

{return new CIccTagColorantOrder(*this);}

operator=()

CIccTagColorantOrder & CIccTagColorantOrder::operator=

(

const CIccTagColorantOrder &

ColorantOrderTag

)

Name: CIccTagColorantOrder::operator=.

Purpose: Copy Operator

Args: ColorantOrderTag = The CIccTagColorantOrder object to be copied

Definition at line 8304 of file IccTagBasic.cpp.

{
  if (&ColorantOrderTag == this)
    return *this;
 
  m_nCount = ColorantOrderTag.m_nCount;
 
  if (m_pData)
    free(m_pData);
  m_pData = (icUInt8Number*)calloc(m_nCount, sizeof(icUInt8Number));
  memcpy(m_pData, ColorantOrderTag.m_pData, sizeof(icUInt8Number)*m_nCount);
 
  return *this;
}

References m_nCount, and m_pData.

operator[]()

icUInt8Number & CIccTagColorantOrder::operator[] ( int index )

inline

Definition at line 1368 of file IccTagBasic.h.

{ return m_pData[index]; }

Read()

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

virtual

Name: CIccTagColorantOrder::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 8350 of file IccTagBasic.cpp.

{
  icTagTypeSignature sig;
  icUInt32Number nCount;
 
  if (sizeof(icTagTypeSignature) + 
      sizeof(icUInt32Number) + 
      sizeof(icUInt32Number) > 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(icUInt8Number);
 
  if (nNum < nCount)
    return false;
 
  if (!SetSize((icUInt16Number)nCount))
    return false;
 
  if (pIO->Read8(&m_pData[0], m_nCount) != (icInt32Number)m_nCount)
    return false;
 
  return true;
}

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

Here is the call graph for this function:

SetSize()

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

Name: CIccTagColorantOrder::SetSize.

Purpose: Sets the size of the data array.

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

Definition at line 8462 of file IccTagBasic.cpp.

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

References icRealloc().

Here is the call graph for this function:

Validate()

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

virtual

Name: CIccTagColorantOrder::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 8498 of file IccTagBasic.cpp.

{
  icValidateStatus rv = CIccTag::Validate(sigPath, sReport, pProfile);
 
  CIccInfo Info;
  std::string sSigPathName = Info.GetSigPathName(sigPath);
 
  if (!pProfile) {
    sReport += icMsgValidateWarning;
    sReport += sSigPathName;
    sReport += " - Tag validation incomplete: Pointer to profile unavailable.\n";
    rv = icMaxStatus(rv, icValidateWarning);
    return rv;
  }
 
  if (sigPath==icGetSigPath(icSigColorantTableTag)) {
    if (m_nCount != icGetSpaceSamples(pProfile->m_Header.colorSpace)) {
      sReport += icMsgValidateNonCompliant;
      sReport += sSigPathName;
      sReport += " - Incorrect number of colorants.\n";
      rv = icMaxStatus(rv, icValidateNonCompliant);
    }
  }
  else if (sigPath==icGetSigPath(icSigColorantTableOutTag)) {
    if (m_nCount != icGetSpaceSamples(pProfile->m_Header.pcs)) {
      sReport += icMsgValidateNonCompliant;
      sReport += sSigPathName;
      sReport += " - Incorrect number of colorants.\n";
      rv = icMaxStatus(rv, icValidateNonCompliant);
    }
  }
  else {
    sReport += icMsgValidateWarning;
    sReport += sSigPathName;
    sReport += " - Unknown number of required colorants.\n";
    rv = icMaxStatus(rv, icValidateWarning);
  }
 
  return rv;
}

References CIccInfo::GetSigPathName(), icGetSigPath(), icGetSpaceSamples(), icMaxStatus(), icMsgValidateNonCompliant, icMsgValidateWarning, icSigColorantTableOutTag, icSigColorantTableTag, icValidateNonCompliant, icValidateWarning, and CIccTag::Validate().

Here is the call graph for this function:

Write()

bool CIccTagColorantOrder::Write ( CIccIO * pIO )

virtual

Name: CIccTagColorantOrder::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 8402 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;
 
  if (pIO->Write8(&m_pData[0], m_nCount) != (icInt32Number)m_nCount)
    return false;
  
  return true;
}

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

Here is the call graph for this function:

Member Data Documentation

m_nCount

icUInt32Number CIccTagColorantOrder::m_nCount

protected

Definition at line 1375 of file IccTagBasic.h.

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

m_pData

icUInt8Number* CIccTagColorantOrder::m_pData

protected

Definition at line 1376 of file IccTagBasic.h.

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

---

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

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