CIccTagXmlColorantOrder Class Reference

#include <IccTagXml.h>

Inheritance diagram for CIccTagXmlColorantOrder:

Collaboration diagram for CIccTagXmlColorantOrder:

Public Member Functions
virtual	~CIccTagXmlColorantOrder ()
virtual void	Describe (std::string &sDescription, int nVerboseness)
virtual void	DetachIO ()
virtual const char *	GetClassName () const
icUInt8Number *	GetData (int index)
virtual const char *	GetExtClassName () const
virtual const char *	GetExtDerivedClassName () const
virtual IIccExtensionTag *	GetExtension ()
icUInt32Number	GetSize () const
virtual icArraySignature	GetTagArrayType () const
virtual icStructSignature	GetTagStructType () const
virtual icTagTypeSignature	GetType () const
virtual bool	IsArrayType ()
virtual bool	IsMBBType ()
virtual bool	IsNumArrayType () const
virtual bool	IsSupported ()
virtual CIccTag *	NewCopy () const
icUInt8Number &	operator[] (int index)
virtual bool	ParseXml (xmlNode *pNode, std::string &parseStr)
virtual bool	Read (icUInt32Number size, CIccIO *pIO)
virtual bool	Read (icUInt32Number size, CIccIO *pIO, CIccProfile *pProfile)
virtual bool	ReadAll ()
bool	SetSize (icUInt16Number nsize, bool bZeronew=true)
virtual bool	ToXml (std::string &xml, std::string blanks="")
virtual icValidateStatus	Validate (std::string sigPath, std::string &sReport, const CIccProfile *pProfile=NULL) const
virtual bool	Write (CIccIO *pIO)

Static Public Member Functions
static CIccTag *	Create (icTagTypeSignature sig)

Data Fields
icUInt32Number	m_nReserved

Protected Attributes
icUInt32Number	m_nCount
icUInt8Number *	m_pData

Detailed Description

Constructor & Destructor Documentation

~CIccTagXmlColorantOrder()

virtual CIccTagXmlColorantOrder::~CIccTagXmlColorantOrder ( )

inlinevirtual

{}

Member Function Documentation

Create()

CIccTag * CIccTag::Create ( icTagTypeSignature  sig )

staticinherited

Name: CIccTag::Create

Purpose: This is a static tag creator based upon tag signature type

Args: sig = tag type signature

Return: Pointer to Allocated tag

{
  return CIccTagCreator::CreateTag(sig);
}

References CIccTagCreator::CreateTag().

Referenced by CIccDefaultEncProfileConverter::ConvertFromParams(), CIccTagStruct::LoadElem(), CIccProfileXml::ParseTag(), CIccTagXmlStruct::ParseTag(), CIccMpeXmlTintArray::ParseXml(), CIccTagXmlArray::ParseXml(), CIccMpeTintArray::Read(), CIccTagLutAtoB::Read(), CIccTagLut8::Read(), CIccTagLut16::Read(), CIccTagLut8::SetColorSpaces(), CIccTagLut16::SetColorSpaces(), and CIccProfileDescText::SetType().

Here is the call graph for this function:

Here is the caller graph for this function:

Describe()

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

virtualinherited

Name: CIccTagColorantOrder::Describe

Purpose: Dump data associated with the tag to a string

Args: sDescription - string to concatenate tag dump to

Reimplemented from CIccTag.

{
  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;
  }
}

References CIccTagColorantOrder::m_nCount, and CIccTagColorantOrder::m_pData.

DetachIO()

virtual void CIccTag::DetachIO ( )

inlinevirtualinherited

Function: ReadAll() - Read All sub data for tag from file. Called by CIccProfile::ReadAll() to read all sub data for tag

Returns true if ReadAll is successful.

{}

GetClassName()

virtual const char * CIccTagXmlColorantOrder::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTagColorantOrder.

{return "CIccTagXmlColorantOrder"; }

GetData()

icUInt8Number * CIccTagColorantOrder::GetData ( int  index )

inlineinherited

{ return &m_pData[index]; }

References CIccTagColorantOrder::m_pData.

GetExtClassName()

virtual const char * CIccTagXml::GetExtClassName ( ) const

inlinevirtualinherited

Implements IIccExtensionTag.

{ return "CIccTagXml"; }

Referenced by icProfDescToXml(), and icXmlParseProfDesc().

Here is the caller graph for this function:

GetExtDerivedClassName()

virtual const char * CIccTagXml::GetExtDerivedClassName ( ) const

inlinevirtualinherited

Implements IIccExtensionTag.

Reimplemented in CIccCurveXml.

{ return ""; }

GetExtension()

virtual IIccExtensionTag * CIccTagXmlColorantOrder::GetExtension ( )

inlinevirtual

Reimplemented from CIccTag.

{return this; }

GetSize()

icUInt32Number CIccTagColorantOrder::GetSize ( ) const

inlineinherited

{return m_nCount;}

References CIccTagColorantOrder::m_nCount.

GetTagArrayType()

virtual icArraySignature CIccTag::GetTagArrayType ( ) const

inlinevirtualinherited

Reimplemented in CIccTagArray.

{ return icSigUndefinedArray; }

References icSigUndefinedArray.

Referenced by icGetTagArrayHandlerOfType(), and CIccProfileXml::ParseTag().

Here is the caller graph for this function:

GetTagStructType()

virtual icStructSignature CIccTag::GetTagStructType ( ) const

inlinevirtualinherited

Reimplemented in CIccTagStruct.

{ return icSigUndefinedStruct; }

References icSigUndefinedStruct.

Referenced by icGetTagStructHandlerOfType(), CIccArrayColorantInfo::Validate(), and CIccArrayNamedColor::Validate().

Here is the caller graph for this function:

GetType()

virtual icTagTypeSignature CIccTagColorantOrder::GetType ( ) const

inlinevirtualinherited

Function: GetType()

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

Reimplemented from CIccTag.

{ return icSigColorantOrderType; }

References icSigColorantOrderType.

Referenced by CIccTagColorantOrder::Write().

Here is the caller graph for this function:

IsArrayType()

virtual bool CIccTag::IsArrayType ( )

inlinevirtualinherited

Reimplemented in CIccTagXYZ, CIccTagChromaticity, CIccTagSparseMatrixArray, CIccTagFixedNum< T, Tsig >, CIccTagNum< T, Tsig >, CIccTagFloatNum< T, Tsig >, and CIccTagData.

{ return false; }

Referenced by MyTagDialog::MyTagDialog(), and DumpTag().

Here is the caller graph for this function:

IsMBBType()

virtual bool CIccTag::IsMBBType ( )

inlinevirtualinherited

Reimplemented in CIccMBB.

{ return false; } //If true then CIccTag can be cast as an CIccMBB 

Referenced by CIccProfileXml::ParseTag().

Here is the caller graph for this function:

IsNumArrayType()

virtual bool CIccTag::IsNumArrayType ( ) const

inlinevirtualinherited

Reimplemented in CIccTagSparseMatrixArray, CIccTagFixedNum< T, Tsig >, CIccTagNum< T, Tsig >, and CIccTagFloatNum< T, Tsig >.

{ return false;} //If true then CIccTag can be cast as a CIccTagNumArray

Referenced by CIccArrayNamedColor::FindDeviceColor(), CIccArrayNamedColor::FindPcsColor(), CIccArrayNamedColor::FindSpectralColor(), CIccTagStruct::GetElemNumberValue(), CIccStructNamedColor::GetNumArray(), CIccMpeXmlTintArray::ParseXml(), and CIccMpeTintArray::Read().

Here is the caller graph for this function:

IsSupported()

virtual bool CIccTag::IsSupported ( )

inlinevirtualinherited

Function: IsSupported(size, pIO) - Check if tag fully supported for apply purposes. By Default inherited classes are supported. Unknown tag types are not supported.

Returns true if tag type is supported.

Reimplemented in CIccTagUnknown, CIccTagEmbeddedProfile, and CIccTagMultiProcessElement.

{ return true; }

NewCopy()

virtual CIccTag * CIccTagColorantOrder::NewCopy ( ) const

inlinevirtualinherited

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.

{return new CIccTagColorantOrder(*this);}

References CIccTagColorantOrder::CIccTagColorantOrder().

Here is the call graph for this function:

operator[]()

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

inlineinherited

{ return m_pData[index]; }

References CIccTagColorantOrder::m_pData.

ParseXml()

bool CIccTagXmlColorantOrder::ParseXml ( xmlNode *  pNode, std::string &  parseStr  )

virtual

Implements CIccTagXml.

{  
  pNode = icXmlFindNode(pNode, "ColorantOrder");
 
  if (pNode) {
    int n = icXmlNodeCount(pNode->children, "n");
 
    if (n) {
      SetSize(n);
 
      if (m_pData) {
        if (CIccUInt8Array::ParseArray(m_pData, n, pNode->children))
          return true;
      }
    }
  }  
  return false;
}

References icXmlFindNode(), icXmlNodeCount(), CIccTagColorantOrder::m_pData, CIccXmlArrayType< T, Tsig >::ParseArray(), and CIccTagColorantOrder::SetSize().

Here is the call graph for this function:

Read() [1/2]

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

virtualinherited

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.

{
  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 CIccTagColorantOrder::m_nCount, CIccTag::m_nReserved, CIccTagColorantOrder::m_pData, CIccIO::Read32(), CIccIO::Read8(), and CIccTagColorantOrder::SetSize().

Here is the call graph for this function:

Read() [2/2]

virtual bool CIccTag::Read ( icUInt32Number  size, CIccIO *  pIO, CIccProfile *  pProfile  )

inlinevirtualinherited

Function: Read(size, pIO) - Read tag from file. Each derived tag will implement it's own Read() function.

Parameter(s): size - number of bytes in tag including the type signature. pIO - IO object used to read in tag. The IO object should already be initialized to point to the begining of the tag.

Returns true if Read is successful.

Reimplemented in CIccTagEmbeddedProfile.

{ return Read(size, pIO); }

References CIccTag::Read().

Here is the call graph for this function:

ReadAll()

virtual bool CIccTag::ReadAll ( )

inlinevirtualinherited

Function: ReadAll() - Read All sub data for tag from file. Called by CIccProfile::ReadAll() to read all sub data for tag

Returns true if ReadAll is successful.

Reimplemented in CIccTagEmbeddedProfile.

{ return true; }

SetSize()

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

inherited

Name: CIccTagColorantOrder::SetSize

Purpose: Sets the size of the data array.

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

{
  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(), CIccTagColorantOrder::m_nCount, and CIccTagColorantOrder::m_pData.

Referenced by ParseXml(), and CIccTagColorantOrder::Read().

Here is the call graph for this function:

Here is the caller graph for this function:

ToXml()

bool CIccTagXmlColorantOrder::ToXml ( std::string &  xml, std::string  blanks = ""  )

virtual

Implements CIccTagXml.

{
  char buf[40];
  int i;
 
  xml += blanks + "<ColorantOrder>\n"; //+ blanks + "  ";
  for (i=0; i<(int)m_nCount; i++) {
    sprintf(buf, "  <n>%d</n>\n", m_pData[i]);
    xml += blanks + buf;
  }
 
  xml += blanks + "</ColorantOrder>\n";
 
  return true;
}

References CIccTagColorantOrder::m_nCount, and CIccTagColorantOrder::m_pData.

Validate()

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

virtualinherited

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.

{
  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 icHeader::colorSpace, CIccInfo::GetSigPathName(), icGetSigPath(), icGetSpaceSamples(), icMaxStatus(), icMsgValidateNonCompliant, icMsgValidateWarning, icSigColorantTableOutTag, icSigColorantTableTag, icValidateNonCompliant, icValidateWarning, CIccTagColorantOrder::m_nCount, icHeader::pcs, and CIccTag::Validate().

Here is the call graph for this function:

Write()

bool CIccTagColorantOrder::Write ( CIccIO *  pIO )

virtualinherited

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.

{
  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 CIccTagColorantOrder::GetType(), CIccTagColorantOrder::m_nCount, CIccTag::m_nReserved, CIccTagColorantOrder::m_pData, CIccIO::Write32(), and CIccIO::Write8().

Here is the call graph for this function:

Field Documentation

m_nCount

icUInt32Number CIccTagColorantOrder::m_nCount

protectedinherited

Referenced by CIccTagColorantOrder::CIccTagColorantOrder(), CIccTagColorantOrder::CIccTagColorantOrder(), CIccTagColorantOrder::Describe(), CIccTagColorantOrder::GetSize(), CIccTagColorantOrder::operator=(), CIccTagColorantOrder::Read(), CIccTagColorantOrder::SetSize(), ToXml(), CIccTagColorantOrder::Validate(), and CIccTagColorantOrder::Write().

m_nReserved

icUInt32Number CIccTag::m_nReserved

inherited

Referenced by CIccTag::CIccTag(), CIccTagMultiProcessElement::CIccTagMultiProcessElement(), CIccTagMultiProcessElement::CIccTagMultiProcessElement(), CIccTagMultiProcessElement::operator=(), CIccProfileXml::ParseTag(), CIccTagXmlStruct::ParseTag(), CIccMpeXmlTintArray::ParseXml(), CIccTagXmlArray::ParseXml(), CIccTagText::Read(), CIccTagUtf8Text::Read(), CIccTagZipUtf8Text::Read(), CIccTagUtf16Text::Read(), CIccTagTextDescription::Read(), CIccTagSignature::Read(), CIccTagNamedColor2::Read(), CIccTagXYZ::Read(), CIccTagChromaticity::Read(), CIccTagCicp::Read(), CIccTagSparseMatrixArray::Read(), CIccTagFixedNum< T, Tsig >::Read(), CIccTagNum< T, Tsig >::Read(), CIccTagFloatNum< T, Tsig >::Read(), CIccTagMeasurement::Read(), CIccTagMultiLocalizedUnicode::Read(), CIccTagData::Read(), CIccTagDateTime::Read(), CIccTagColorantOrder::Read(), CIccTagColorantTable::Read(), CIccTagViewingConditions::Read(), CIccTagProfileSeqDesc::Read(), CIccTagResponseCurveSet16::Read(), CIccTagSpectralDataInfo::Read(), CIccTagSpectralViewingConditions::Read(), CIccTagEmbeddedHeightImage::Read(), CIccTagEmbeddedNormalImage::Read(), CIccTagStruct::Read(), CIccTagArray::Read(), CIccTagDict::Read(), CIccTagCurve::Read(), CIccTagParametricCurve::Read(), CIccTagLutAtoB::Read(), CIccTagLut8::Read(), CIccTagLut16::Read(), CIccTagGamutBoundaryDesc::Read(), CIccTagMultiProcessElement::Read(), CIccTagProfileSequenceId::Read(), CIccTagEmbeddedProfile::Read(), CIccTag::Validate(), CIccTagText::Write(), CIccTagUtf8Text::Write(), CIccTagZipUtf8Text::Write(), CIccTagUtf16Text::Write(), CIccTagTextDescription::Write(), CIccTagSignature::Write(), CIccTagNamedColor2::Write(), CIccTagXYZ::Write(), CIccTagChromaticity::Write(), CIccTagCicp::Write(), CIccTagSparseMatrixArray::Write(), CIccTagFixedNum< T, Tsig >::Write(), CIccTagNum< T, Tsig >::Write(), CIccTagFloatNum< T, Tsig >::Write(), CIccTagMeasurement::Write(), CIccTagMultiLocalizedUnicode::Write(), CIccTagData::Write(), CIccTagDateTime::Write(), CIccTagColorantOrder::Write(), CIccTagColorantTable::Write(), CIccTagViewingConditions::Write(), CIccTagProfileSeqDesc::Write(), CIccTagResponseCurveSet16::Write(), CIccTagSpectralDataInfo::Write(), CIccTagSpectralViewingConditions::Write(), CIccTagEmbeddedHeightImage::Write(), CIccTagEmbeddedNormalImage::Write(), CIccTagStruct::Write(), CIccTagArray::Write(), CIccTagDict::Write(), CIccTagEmbeddedProfile::Write(), CIccTagCurve::Write(), CIccTagParametricCurve::Write(), CIccTagLutAtoB::Write(), CIccTagLut8::Write(), CIccTagLut16::Write(), CIccTagGamutBoundaryDesc::Write(), CIccTagMultiProcessElement::Write(), and CIccTagProfileSequenceId::Write().

m_pData

icUInt8Number* CIccTagColorantOrder::m_pData

protectedinherited

Referenced by CIccTagColorantOrder::CIccTagColorantOrder(), CIccTagColorantOrder::CIccTagColorantOrder(), CIccTagColorantOrder::~CIccTagColorantOrder(), CIccTagColorantOrder::Describe(), CIccTagColorantOrder::GetData(), CIccTagColorantOrder::operator=(), CIccTagColorantOrder::operator[](), ParseXml(), CIccTagColorantOrder::Read(), CIccTagColorantOrder::SetSize(), ToXml(), and CIccTagColorantOrder::Write().

---

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

• IccXML/IccLibXML/IccTagXml.h
• IccXML/IccLibXML/IccTagXml.cpp