CIccTagXYZ Class Reference

#include <IccTagBasic.h>

Inheritance diagram for CIccTagXYZ:

Collaboration diagram for CIccTagXYZ:

Public Member Functions
	CIccTagXYZ (const CIccTagXYZ &ITXYZ)
	CIccTagXYZ (int nSize=1)
virtual	~CIccTagXYZ ()
virtual void	Describe (std::string &sDescription, int nVerboseness)
virtual void	DetachIO ()
virtual const icChar *	GetClassName () const
virtual IIccExtensionTag *	GetExtension ()
icUInt32Number	GetSize () const
virtual icArraySignature	GetTagArrayType () const
virtual icStructSignature	GetTagStructType () const
virtual icTagTypeSignature	GetType () const
icXYZNumber *	GetXYZ (icUInt32Number index)
virtual bool	IsArrayType ()
virtual bool	IsMBBType ()
virtual bool	IsNumArrayType () const
virtual bool	IsSupported ()
virtual CIccTag *	NewCopy () const
CIccTagXYZ &	operator= (const CIccTagXYZ &XYZTag)
icXYZNumber &	operator[] (icUInt32Number index) const
virtual bool	Read (icUInt32Number size, CIccIO *pIO)
virtual bool	Read (icUInt32Number size, CIccIO *pIO, CIccProfile *pProfile)
virtual bool	ReadAll ()
bool	SetSize (icUInt32Number nSize, bool bZeroNew=true)
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_nSize
icXYZNumber *	m_XYZ

Detailed Description

Class: CIccTagXYZ

Purpose: the XYZType tag - an array of XYZ values

Constructor & Destructor Documentation

CIccTagXYZ() [1/2]

CIccTagXYZ::CIccTagXYZ

(

int

nSize = 1

)

Name: CIccTagXYZ::CIccTagXYZ

Purpose: Constructor

Args: nSize = number of XYZ entries

{
  m_nSize = nSize;
  if (m_nSize <1)
    m_nSize = 1;
  m_XYZ = (icXYZNumber*)calloc(nSize, sizeof(icXYZNumber));
}

References m_nSize, and m_XYZ.

Referenced by CIccDefaultEncProfileConverter::ConvertFromParams().

Here is the caller graph for this function:

CIccTagXYZ() [2/2]

CIccTagXYZ::CIccTagXYZ

(

const CIccTagXYZ &

ITXYZ

)

Name: CIccTagXYZ::CIccTagXYZ

Purpose: Copy Constructor

Args: ITXYZ = The CIccTagXYZ object to be copied

{
  m_nSize = ITXYZ.m_nSize;
 
  m_XYZ = (icXYZNumber*)calloc(m_nSize, sizeof(icXYZNumber));
  memcpy(m_XYZ, ITXYZ.m_XYZ, sizeof(icXYZNumber)*m_nSize);
}

References m_nSize, and m_XYZ.

Referenced by NewCopy().

Here is the caller graph for this function:

~CIccTagXYZ()

CIccTagXYZ::~CIccTagXYZ ( )

virtual

Name: CIccTagXYZ::~CIccTagXYZ

Purpose: Destructor

{
  if (m_XYZ)
    free(m_XYZ);
}

References m_XYZ.

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 CIccTagXYZ::Describe ( std::string &  sDescription, int  nVerboseness  )

virtual

Name: CIccTagXYZ::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];
 
  if (m_nSize == 1 ) {
    sprintf(buf, "X=%.4lf, Y=%.4lf, Z=%.4lf\n", icFtoD(m_XYZ[0].X), icFtoD(m_XYZ[0].Y), icFtoD(m_XYZ[0].Z));
    sDescription += buf;
  }
  else {
    icUInt32Number i;
    sDescription.reserve(sDescription.size() + m_nSize*79);
 
    for (i=0; i<m_nSize; i++) {
      sprintf(buf, "value[%u]: X=%.4lf, Y=%.4lf, Z=%.4lf\n", i, icFtoD(m_XYZ[i].X), icFtoD(m_XYZ[i].Y), icFtoD(m_XYZ[i].Z));
      sDescription += buf;
    }
  }
}

References icFtoD(), m_nSize, m_XYZ, icXYZNumber::X, icXYZNumber::Y, and icXYZNumber::Z.

Here is the call graph for this function:

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 icChar * CIccTagXYZ::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTag.

Reimplemented in CIccTagXmlXYZ.

{ return "CIccTagXYZ"; }

GetExtension()

virtual IIccExtensionTag * CIccTag::GetExtension ( )

inlinevirtualinherited

Reimplemented in CIccTagXmlUnknown, CIccTagXmlText, CIccTagXmlUtf8Text, CIccTagXmlZipUtf8Text, CIccTagXmlZipXml, CIccTagXmlUtf16Text, CIccTagXmlTextDescription, CIccTagXmlSignature, CIccTagXmlNamedColor2, CIccTagXmlXYZ, CIccTagXmlChromaticity, CIccTagXmlCicp, CIccTagXmlSparseMatrixArray, CIccTagXmlFixedNum< T, Tsig >, CIccTagXmlNum< T, A, Tsig >, CIccTagXmlFloatNum< T, A, Tsig >, CIccTagXmlMeasurement, CIccTagXmlMultiLocalizedUnicode, CIccTagXmlTagData, CIccTagXmlDateTime, CIccTagXmlColorantOrder, CIccTagXmlColorantTable, CIccTagXmlViewingConditions, CIccTagXmlSpectralDataInfo, CIccTagXmlSpectralViewingConditions, CIccTagXmlProfileSeqDesc, CIccTagXmlResponseCurveSet16, CIccTagXmlCurve, CIccTagXmlParametricCurve, CIccTagXmlSegmentedCurve, CIccTagXmlLutAtoB, CIccTagXmlLutBtoA, CIccTagXmlLut8, CIccTagXmlLut16, CIccTagXmlMultiProcessElement, CIccTagXmlProfileSequenceId, CIccTagXmlDict, CIccTagXmlStruct, CIccTagXmlArray, CIccTagXmlGamutBoundaryDesc, CIccTagXmlEmbeddedHeightImage, CIccTagXmlEmbeddedNormalImage, and CIccTagXmlEmbeddedProfile.

{return NULL;}

Referenced by icCurvesFromXml(), icCurvesToXml(), icProfDescToXml(), icXmlParseProfDesc(), CIccProfileXml::ParseTag(), CIccTagXmlStruct::ParseTag(), CIccMpeXmlTintArray::ParseXml(), CIccTagXmlArray::ParseXml(), CIccMpeXmlTintArray::ToXml(), CIccTagXmlStruct::ToXml(), CIccTagXmlArray::ToXml(), and CIccProfileXml::ToXmlWithBlanks().

Here is the caller graph for this function:

GetSize()

icUInt32Number CIccTagXYZ::GetSize ( ) const

inline

{ return m_nSize; }

References m_nSize.

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 CIccTagXYZ::GetType ( ) const

inlinevirtual

Function: GetType()

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

Reimplemented from CIccTag.

{ return icSigXYZType; }

References icSigXYZType.

Referenced by Write().

Here is the caller graph for this function:

GetXYZ()

icXYZNumber * CIccTagXYZ::GetXYZ ( icUInt32Number  index )

inline

{return &m_XYZ[index];}

References m_XYZ.

IsArrayType()

virtual bool CIccTagXYZ::IsArrayType ( )

inlinevirtual

Reimplemented from CIccTag.

{ return m_nSize > 1; }

References m_nSize.

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 * CIccTagXYZ::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.

{return new CIccTagXYZ(*this);}

References CIccTagXYZ().

Here is the call graph for this function:

operator=()

CIccTagXYZ & CIccTagXYZ::operator=

(

const CIccTagXYZ &

XYZTag

)

Name: CIccTagXYZ::operator=

Purpose: Copy Operator

Args: XYZTag = The CIccTagXYZ object to be copied

{
  if (&XYZTag == this)
    return *this;
 
  m_nSize = XYZTag.m_nSize;
 
  if (m_XYZ)
    free(m_XYZ);
  m_XYZ = (icXYZNumber*)calloc(m_nSize, sizeof(icXYZNumber));
  memcpy(m_XYZ, XYZTag.m_XYZ, sizeof(icXYZNumber)*m_nSize);
 
  return *this;
}

References m_nSize, and m_XYZ.

operator[]()

icXYZNumber & CIccTagXYZ::operator[] ( icUInt32Number  index ) const

inline

{return m_XYZ[index];}

References m_XYZ.

Referenced by CIccDefaultEncProfileConverter::ConvertFromParams().

Here is the caller graph for this function:

Read() [1/2]

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

virtual

Name: CIccTagXYZ::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;
 
  if (sizeof(icTagTypeSignature) + 
      sizeof(icUInt32Number) + 
      sizeof(icXYZNumber) > size)
    return false;
 
  if (!pIO) {
    return false;
  }
 
  if (!pIO->Read32(&sig))
    return false;
 
  if (!pIO->Read32(&m_nReserved))
    return false;
 
  icUInt32Number nNum=((size-2*sizeof(icUInt32Number)) / sizeof(icXYZNumber));
  icUInt32Number nNum32 = nNum*sizeof(icXYZNumber)/sizeof(icUInt32Number);
 
  if (!SetSize(nNum))
    return false;
 
  if (pIO->Read32(m_XYZ, nNum32) != (icInt32Number)nNum32 )
    return false;
 
  return true;
}

References CIccTag::m_nReserved, m_XYZ, CIccIO::Read32(), and 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 CIccTagXYZ::SetSize	(	icUInt32Number	nSize,
		bool	bZeroNew = true
	)

Name: CIccTagXYZ::SetSize

Purpose: Sets the size of the XYZ array.

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

{
  if (nSize==m_nSize)
    return true;
 
  m_XYZ = (icXYZNumber*)icRealloc(m_XYZ, nSize*sizeof(icXYZNumber));
 
  if (!m_XYZ) {
    m_nSize = 0;
    return false;
  }
 
  if (bZeroNew && m_nSize < nSize) {
    memset(&m_XYZ[m_nSize], 0, (nSize-m_nSize)*sizeof(icXYZNumber));
  }
  m_nSize = nSize;
 
  return true;
}

References icRealloc(), m_nSize, and m_XYZ.

Referenced by CIccDefaultEncProfileConverter::ConvertFromParams(), CIccTagXmlXYZ::ParseXml(), and Read().

Here is the call graph for this function:

Here is the caller graph for this function:

Validate()

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

virtual

Name: CIccTagXYZ::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 (!m_nSize) {
    sReport += icMsgValidateWarning;
    sReport += sSigPathName;
    sReport += " - Empty tag.\n";
 
    rv = icMaxStatus(rv, icValidateWarning);
    return rv;
  }
 
  for (int i=0; i<(int)m_nSize; i++) {
    rv = icMaxStatus(rv, Info.CheckData(sReport, m_XYZ[i], sSigPathName + ":XYZ"));
  }
 
  return rv;
}

References CIccInfo::CheckData(), CIccInfo::GetSigPathName(), icMaxStatus(), icMsgValidateWarning, icValidateWarning, m_nSize, m_XYZ, and CIccTag::Validate().

Here is the call graph for this function:

Write()

bool CIccTagXYZ::Write ( CIccIO *  pIO )

virtual

Name: CIccTagXYZ::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;
 
  icUInt32Number nNum32 = m_nSize * sizeof(icXYZNumber)/sizeof(icUInt32Number);
 
  if (
    pIO->Write32(m_XYZ, nNum32) != (icInt32Number)nNum32)
    return false;
 
  return true;
}

References GetType(), CIccTag::m_nReserved, m_nSize, m_XYZ, and CIccIO::Write32().

Here is the call graph for this function:

Field Documentation

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(), 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(), 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_nSize

icUInt32Number CIccTagXYZ::m_nSize

protected

Referenced by CIccTagXYZ(), CIccTagXYZ(), Describe(), GetSize(), IsArrayType(), operator=(), SetSize(), CIccTagXmlXYZ::ToXml(), Validate(), and Write().

m_XYZ

icXYZNumber* CIccTagXYZ::m_XYZ

protected

Referenced by CIccTagXYZ(), CIccTagXYZ(), ~CIccTagXYZ(), Describe(), GetXYZ(), operator=(), operator[](), CIccTagXmlXYZ::ParseXml(), Read(), SetSize(), CIccTagXmlXYZ::ToXml(), Validate(), and Write().

---

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

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