CIccTagXYZ Class Reference

Class: CIccTagXYZ. More...

#include <IccTagBasic.h>

Inheritance diagram for CIccTagXYZ:

Collaboration diagram for CIccTagXYZ:

Public Member Functions
	CIccTagXYZ (const CIccTagXYZ &ITXYZ)
	Name: CIccTagXYZ::CIccTagXYZ.
	CIccTagXYZ (int nSize=1)
	Name: CIccTagXYZ::CIccTagXYZ.
virtual void	Describe (std::string &sDescription, int nVerboseness)
	Name: CIccTagXYZ::Describe.
virtual const icChar *	GetClassName () const
icUInt32Number	GetSize () const
virtual icTagTypeSignature	GetType () const
	Function: GetType()
icXYZNumber *	GetXYZ (icUInt32Number index)
virtual bool	IsArrayType ()
virtual CIccTag *	NewCopy () const
	Function: NewCopy(sDescription) Each derived tag will implement it's own NewCopy() function.
CIccTagXYZ &	operator= (const CIccTagXYZ &XYZTag)
	Name: CIccTagXYZ::operator=.
icXYZNumber &	operator[] (icUInt32Number index) const
virtual bool	Read (icUInt32Number size, CIccIO *pIO)
	Name: CIccTagXYZ::Read.
bool	SetSize (icUInt32Number nSize, bool bZeroNew=true)
	Name: CIccTagXYZ::SetSize.
virtual icValidateStatus	Validate (std::string sigPath, std::string &sReport, const CIccProfile *pProfile=NULL) const
	Name: CIccTagXYZ::Validate.
virtual bool	Write (CIccIO *pIO)
	Name: CIccTagXYZ::Write.
virtual	~CIccTagXYZ ()
	Name: CIccTagXYZ::~CIccTagXYZ.
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	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_nSize
icXYZNumber *	m_XYZ

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

Purpose: the XYZType tag - an array of XYZ values

Definition at line 667 of file IccTagBasic.h.

Constructor & Destructor Documentation

CIccTagXYZ() [1/2]

CIccTagXYZ::CIccTagXYZ

(

int

nSize = 1

)

Name: CIccTagXYZ::CIccTagXYZ.

Purpose: Constructor

Args: nSize = number of XYZ entries

Definition at line 3491 of file IccTagBasic.cpp.

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

CIccTagXYZ() [2/2]

CIccTagXYZ::CIccTagXYZ

(

const CIccTagXYZ &

ITXYZ

)

Name: CIccTagXYZ::CIccTagXYZ.

Purpose: Copy Constructor

Args: ITXYZ = The CIccTagXYZ object to be copied

Definition at line 3510 of file IccTagBasic.cpp.

{
  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.

~CIccTagXYZ()

CIccTagXYZ::~CIccTagXYZ ( )

virtual

Name: CIccTagXYZ::~CIccTagXYZ.

Purpose: Destructor

Definition at line 3554 of file IccTagBasic.cpp.

{
  if (m_XYZ)
    free(m_XYZ);
}

Member Function Documentation

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.

Definition at line 3653 of file IccTagBasic.cpp.

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

Here is the call graph for this function:

GetClassName()

virtual const icChar * CIccTagXYZ::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTag.

Reimplemented in CIccTagXmlXYZ.

Definition at line 679 of file IccTagBasic.h.

{ return "CIccTagXYZ"; }

GetSize()

icUInt32Number CIccTagXYZ::GetSize ( ) const

inline

Definition at line 688 of file IccTagBasic.h.

{ return m_nSize; }

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.

Definition at line 678 of file IccTagBasic.h.

{ return icSigXYZType; }

References icSigXYZType.

GetXYZ()

icXYZNumber * CIccTagXYZ::GetXYZ ( icUInt32Number index )

inline

Definition at line 687 of file IccTagBasic.h.

{return &m_XYZ[index];}

IsArrayType()

virtual bool CIccTagXYZ::IsArrayType ( )

inlinevirtual

Reimplemented from CIccTag.

Definition at line 676 of file IccTagBasic.h.

{ return m_nSize > 1; }

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.

Definition at line 673 of file IccTagBasic.h.

{return new CIccTagXYZ(*this);}

operator=()

CIccTagXYZ & CIccTagXYZ::operator=

(

const CIccTagXYZ &

XYZTag

)

Name: CIccTagXYZ::operator=.

Purpose: Copy Operator

Args: XYZTag = The CIccTagXYZ object to be copied

Definition at line 3530 of file IccTagBasic.cpp.

{
  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

Definition at line 686 of file IccTagBasic.h.

{return m_XYZ[index];}

Read()

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.

Definition at line 3575 of file IccTagBasic.cpp.

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

Here is the call graph for this function:

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

Definition at line 3683 of file IccTagBasic.cpp.

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

Referenced by CIccDefaultEncProfileConverter::ConvertFromParams().

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.

Definition at line 3718 of file IccTagBasic.cpp.

{
  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, 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.

Definition at line 3620 of file IccTagBasic.cpp.

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

Here is the call graph for this function:

Member Data Documentation

m_nSize

icUInt32Number CIccTagXYZ::m_nSize

protected

Definition at line 694 of file IccTagBasic.h.

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

m_XYZ

icXYZNumber* CIccTagXYZ::m_XYZ

protected

Definition at line 693 of file IccTagBasic.h.

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

---

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

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