CIccTagXmlViewingConditions Class Reference

#include <IccTagXml.h>

Inheritance diagram for CIccTagXmlViewingConditions:

Collaboration diagram for CIccTagXmlViewingConditions:

Public Member Functions
virtual	~CIccTagXmlViewingConditions ()
virtual void	Describe (std::string &sDescription, int nVerboseness)
virtual void	DetachIO ()
virtual const char *	GetClassName () const
virtual const char *	GetExtClassName () const
virtual const char *	GetExtDerivedClassName () const
virtual IIccExtensionTag *	GetExtension ()
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
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 ()
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
icIlluminant	m_illumType
icUInt32Number	m_nReserved
icXYZNumber	m_XYZIllum
icXYZNumber	m_XYZSurround

Detailed Description

Constructor & Destructor Documentation

~CIccTagXmlViewingConditions()

virtual CIccTagXmlViewingConditions::~CIccTagXmlViewingConditions ( )

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

virtualinherited

Name: CIccTagViewingConditions::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];
  CIccInfo Fmt;
 
  sprintf(buf, "Illuminant Tristimulus values: X = %.4lf, Y = %.4lf, Z = %.4lf\n", 
               icFtoD(m_XYZIllum.X), 
               icFtoD(m_XYZIllum.Y),
               icFtoD(m_XYZIllum.Z));
  sDescription += buf;
 
  sprintf(buf, "Surround Tristimulus values: X = %.4lf, Y = %.4lf, Z = %.4lf\n",
               icFtoD(m_XYZSurround.X),
               icFtoD(m_XYZSurround.Y),
               icFtoD(m_XYZSurround.Z));
  sDescription += buf;
 
  sDescription += "Illuminant Type: ";
 
  sDescription += Fmt.GetIlluminantName(m_illumType);
  sDescription += "\n";
 
}

References CIccInfo::GetIlluminantName(), icFtoD(), CIccTagViewingConditions::m_illumType, CIccTagViewingConditions::m_XYZIllum, CIccTagViewingConditions::m_XYZSurround, 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 char * CIccTagXmlViewingConditions::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTagViewingConditions.

{return "CIccTagXmlViewingConditions"; }

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 * CIccTagXmlViewingConditions::GetExtension ( )

inlinevirtual

Reimplemented from CIccTag.

{return this; }

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

inlinevirtualinherited

Function: GetType()

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

Reimplemented from CIccTag.

{ return icSigViewingConditionsType; }

References icSigViewingConditionsType.

Referenced by CIccTagViewingConditions::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 * CIccTagViewingConditions::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 CIccTagViewingConditions(*this);}

References CIccTagViewingConditions::CIccTagViewingConditions().

Here is the call graph for this function:

ParseXml()

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

virtual

Implements CIccTagXml.

{
  xmlAttr *attr;
  xmlNode *pChild;
 
  memset(&m_XYZIllum, 0, sizeof(m_XYZIllum));
  memset(&m_XYZSurround, 0, sizeof(m_XYZSurround));
  m_illumType = (icIlluminant)0;
 
  pChild = icXmlFindNode(pNode, "IlluminantXYZ");
  if (pChild) {
 
    attr = icXmlFindAttr(pChild, "X");
    if (attr) {
      m_XYZIllum.X = icDtoF((icFloatNumber)atof(icXmlAttrValue(attr)));
    }
 
    attr = icXmlFindAttr(pChild, "Y");
    if (attr) {
      m_XYZIllum.Y = icDtoF((icFloatNumber)atof(icXmlAttrValue(attr)));
    }
 
    attr = icXmlFindAttr(pChild, "Z");
    if (attr) {
      m_XYZIllum.Z = icDtoF((icFloatNumber)atof(icXmlAttrValue(attr)));
    }
  }
 
  pChild = icXmlFindNode(pNode, "SurroundXYZ");
  if (pChild) {
    attr = icXmlFindAttr(pChild, "X");
    if (attr) {
      m_XYZSurround.X = icDtoF((icFloatNumber)atof(icXmlAttrValue(attr)));
    }
 
    attr = icXmlFindAttr(pChild, "Y");
    if (attr) {
      m_XYZSurround.Y = icDtoF((icFloatNumber)atof(icXmlAttrValue(attr)));
    }
 
    attr = icXmlFindAttr(pChild, "Z");
    if (attr) {
      m_XYZSurround.Z = icDtoF((icFloatNumber)atof(icXmlAttrValue(attr)));
    }
  }
 
  pChild = icXmlFindNode(pNode, "IllumType");
  if (pChild && pChild->children && pChild->children->content) {
    m_illumType = icGetIlluminantValue((icChar*)pChild->children->content);
  }
 
  return true;
}

References icDtoF(), icGetIlluminantValue(), icXmlAttrValue(), icXmlFindAttr(), icXmlFindNode(), CIccTagViewingConditions::m_illumType, CIccTagViewingConditions::m_XYZIllum, CIccTagViewingConditions::m_XYZSurround, icXYZNumber::X, icXYZNumber::Y, and icXYZNumber::Z.

Here is the call graph for this function:

Read() [1/2]

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

virtualinherited

Name: CIccTagViewingConditions::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) + 
      2*sizeof(icUInt32Number) + 
      2*sizeof(icXYZNumber) > size)
    return false;
 
  if (!pIO) {
    return false;
  }
 
  if (!pIO->Read32(&sig))
    return false;
 
  if (!pIO->Read32(&m_nReserved))
    return false;
 
  if (pIO->Read32(&m_XYZIllum.X, 3) != 3)
    return false;
 
  if (pIO->Read32(&m_XYZSurround.X, 3) != 3)
    return false;
 
  if (!pIO->Read32(&m_illumType))
    return false;
 
  return true;
}

References CIccTagViewingConditions::m_illumType, CIccTag::m_nReserved, CIccTagViewingConditions::m_XYZIllum, CIccTagViewingConditions::m_XYZSurround, CIccIO::Read32(), and icXYZNumber::X.

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

ToXml()

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

virtual

Implements CIccTagXml.

{
  char buf[256];
 
  sprintf(buf, "<IlluminantXYZ X=\"" icXmlFloatFmt "\" Y=\"" icXmlFloatFmt "\" Z=\"" icXmlFloatFmt "\"/>\n",
    icFtoD(m_XYZIllum.X), icFtoD(m_XYZIllum.Y), icFtoD(m_XYZIllum.Z));
  xml += blanks + buf;
 
  sprintf(buf, "<SurroundXYZ X=\"" icXmlFloatFmt "\" Y=\"" icXmlFloatFmt "\" Z=\"" icXmlFloatFmt "\"/>\n",
    icFtoD(m_XYZSurround.X), icFtoD(m_XYZSurround.Y), icFtoD(m_XYZSurround.Z));
  xml += blanks + buf;
 
  CIccInfo info;
  sprintf(buf, "<IllumType>%s</IllumType>\n", info.GetIlluminantName(m_illumType));
  xml += blanks + buf;
 
  return true;
}

References CIccInfo::GetIlluminantName(), icFtoD(), CIccTagViewingConditions::m_illumType, CIccTagViewingConditions::m_XYZIllum, CIccTagViewingConditions::m_XYZSurround, icXYZNumber::X, icXYZNumber::Y, and icXYZNumber::Z.

Here is the call graph for this function:

Validate()

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

virtualinherited

Name: CIccTagViewingConditions::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);
 
  rv = icMaxStatus(rv, Info.CheckData(sReport, m_XYZIllum, "XYZ Illuminant"));
  rv = icMaxStatus(rv, Info.CheckData(sReport, m_XYZSurround, "XYZ Surround"));
 
  return rv;
}

References CIccInfo::CheckData(), CIccInfo::GetSigPathName(), icMaxStatus(), CIccTagViewingConditions::m_XYZIllum, CIccTagViewingConditions::m_XYZSurround, and CIccTag::Validate().

Here is the call graph for this function:

Write()

bool CIccTagViewingConditions::Write ( CIccIO *  pIO )

virtualinherited

Name: CIccTagViewingConditions::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_XYZIllum.X, 3) !=3)
    return false;
 
  if (pIO->Write32(&m_XYZSurround.X, 3) !=3)
    return false;
 
  if (!pIO->Write32(&m_illumType))
    return false;
 
  return true;
}

References CIccTagViewingConditions::GetType(), CIccTagViewingConditions::m_illumType, CIccTag::m_nReserved, CIccTagViewingConditions::m_XYZIllum, CIccTagViewingConditions::m_XYZSurround, CIccIO::Write32(), and icXYZNumber::X.

Here is the call graph for this function:

Field Documentation

m_illumType

icIlluminant CIccTagViewingConditions::m_illumType

inherited

Referenced by CIccTagViewingConditions::CIccTagViewingConditions(), CIccTagViewingConditions::CIccTagViewingConditions(), CIccTagViewingConditions::Describe(), CIccTagViewingConditions::operator=(), ParseXml(), CIccTagViewingConditions::Read(), ToXml(), and CIccTagViewingConditions::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_XYZIllum

icXYZNumber CIccTagViewingConditions::m_XYZIllum

inherited

Referenced by CIccTagViewingConditions::CIccTagViewingConditions(), CIccTagViewingConditions::CIccTagViewingConditions(), CIccTagViewingConditions::Describe(), CIccTagViewingConditions::operator=(), ParseXml(), CIccTagViewingConditions::Read(), ToXml(), CIccTagViewingConditions::Validate(), and CIccTagViewingConditions::Write().

m_XYZSurround

icXYZNumber CIccTagViewingConditions::m_XYZSurround

inherited

Referenced by CIccTagViewingConditions::CIccTagViewingConditions(), CIccTagViewingConditions::CIccTagViewingConditions(), CIccTagViewingConditions::Describe(), CIccTagViewingConditions::operator=(), ParseXml(), CIccTagViewingConditions::Read(), ToXml(), CIccTagViewingConditions::Validate(), and CIccTagViewingConditions::Write().

---

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

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