CIccTagViewingConditions Class Reference

Class: CIccTagViewingConditions. More...

#include <IccTagBasic.h>

Inheritance diagram for CIccTagViewingConditions:

Collaboration diagram for CIccTagViewingConditions:

Public Member Functions
	CIccTagViewingConditions ()
	Name: CIccTagViewingConditions::CIccTagViewingConditions.
	CIccTagViewingConditions (const CIccTagViewingConditions &ITVC)
	Name: CIccTagViewingConditions::CIccTagViewingConditions.
virtual void	Describe (std::string &sDescription, int nVerboseness)
	Name: CIccTagViewingConditions::Describe.
virtual const icChar *	GetClassName () const
virtual icTagTypeSignature	GetType () const
	Function: GetType()
virtual CIccTag *	NewCopy () const
	Function: NewCopy(sDescription) Each derived tag will implement it's own NewCopy() function.
CIccTagViewingConditions &	operator= (const CIccTagViewingConditions &ViewCondTag)
	Name: CIccTagViewingConditions::operator=.
virtual bool	Read (icUInt32Number size, CIccIO *pIO)
	Name: CIccTagViewingConditions::Read.
virtual icValidateStatus	Validate (std::string sigPath, std::string &sReport, const CIccProfile *pProfile=NULL) const
	Name: CIccTagViewingConditions::Validate.
virtual bool	Write (CIccIO *pIO)
	Name: CIccTagViewingConditions::Write.
virtual	~CIccTagViewingConditions ()
	Name: CIccTagViewingConditions::~CIccTagViewingConditions.
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.

Public Attributes
icIlluminant	m_illumType
icXYZNumber	m_XYZIllum
icXYZNumber	m_XYZSurround
Public Attributes inherited from CIccTag
icUInt32Number	m_nReserved

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

Detailed Description

Class: CIccTagViewingConditions.

Purpose: Viewing conditions tag type

Definition at line 1425 of file IccTagBasic.h.

Constructor & Destructor Documentation

CIccTagViewingConditions() [1/2]

CIccTagViewingConditions::CIccTagViewingConditions

(

)

Name: CIccTagViewingConditions::CIccTagViewingConditions.

Purpose: Constructor

Definition at line 8884 of file IccTagBasic.cpp.

{
  m_XYZIllum.X = 0;
  m_XYZIllum.Y = 0;
  m_XYZIllum.Z = 0;
 
  m_XYZSurround.X = 0;
  m_XYZSurround.Y = 0;
  m_XYZSurround.Z = 0;
 
  m_illumType = icIlluminantUnknown;
}

References icIlluminantUnknown.

CIccTagViewingConditions() [2/2]

CIccTagViewingConditions::CIccTagViewingConditions

(

const CIccTagViewingConditions &

ITVC

)

Name: CIccTagViewingConditions::CIccTagViewingConditions.

Purpose: Copy Constructor

Args: ITVC = The CIccTagViewingConditions object to be copied

Definition at line 8908 of file IccTagBasic.cpp.

{
  m_illumType = ITVC.m_illumType;
 
  memcpy(&m_XYZIllum, &ITVC.m_XYZIllum, sizeof(icXYZNumber));
  memcpy(&m_XYZSurround, &ITVC.m_XYZSurround, sizeof(icXYZNumber));
}

References m_illumType, m_XYZIllum, and m_XYZSurround.

~CIccTagViewingConditions()

CIccTagViewingConditions::~CIccTagViewingConditions ( )

virtual

Name: CIccTagViewingConditions::~CIccTagViewingConditions.

Purpose: Destructor

Definition at line 8949 of file IccTagBasic.cpp.

{
}

Member Function Documentation

Describe()

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

virtual

Name: CIccTagViewingConditions::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 9049 of file IccTagBasic.cpp.

{
  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(), and icFtoD().

Here is the call graph for this function:

GetClassName()

virtual const icChar * CIccTagViewingConditions::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTag.

Reimplemented in CIccTagXmlViewingConditions.

Definition at line 1435 of file IccTagBasic.h.

{ return "CIccTagViewingConditions"; }

GetType()

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

{ return icSigViewingConditionsType; }

References icSigViewingConditionsType.

NewCopy()

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

{return new CIccTagViewingConditions(*this);}

operator=()

CIccTagViewingConditions & CIccTagViewingConditions::operator=

(

const CIccTagViewingConditions &

ViewCondTag

)

Name: CIccTagViewingConditions::operator=.

Purpose: Copy Operator

Args: ViewCondTag = The CIccTagViewingConditions object to be copied

Definition at line 8927 of file IccTagBasic.cpp.

{
  if (&ViewCondTag == this)
    return *this;
 
  m_illumType = ViewCondTag.m_illumType;
 
  memcpy(&m_XYZIllum, &ViewCondTag.m_XYZIllum, sizeof(icXYZNumber));
  memcpy(&m_XYZSurround, &ViewCondTag.m_XYZSurround, sizeof(icXYZNumber));
 
  return *this;
}

References m_illumType, m_XYZIllum, and m_XYZSurround.

Read()

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

virtual

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.

Definition at line 8968 of file IccTagBasic.cpp.

{
  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 CIccIO::Read32(), and sig.

Here is the call graph for this function:

Validate()

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

virtual

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.

Definition at line 9088 of file IccTagBasic.cpp.

{
  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(), and CIccTag::Validate().

Here is the call graph for this function:

Write()

bool CIccTagViewingConditions::Write ( CIccIO * pIO )

virtual

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.

Definition at line 9013 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_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 sig, and CIccIO::Write32().

Here is the call graph for this function:

Member Data Documentation

m_illumType

icIlluminant CIccTagViewingConditions::m_illumType

Definition at line 1445 of file IccTagBasic.h.

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

m_XYZIllum

icXYZNumber CIccTagViewingConditions::m_XYZIllum

Definition at line 1443 of file IccTagBasic.h.

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

m_XYZSurround

icXYZNumber CIccTagViewingConditions::m_XYZSurround

Definition at line 1444 of file IccTagBasic.h.

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

---

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

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