CIccTagData Class Reference

Class: CIccTagData. More...

#include <IccTagBasic.h>

Inheritance diagram for CIccTagData:

Collaboration diagram for CIccTagData:

Public Member Functions
	CIccTagData (const CIccTagData &ITD)
	Name: CIccTagData::CIccTagData.
	CIccTagData (int nSize=1)
	Name: CIccTagData::CIccTagData.
virtual void	Describe (std::string &sDescription, int nVerboseness)
	Name: CIccTagData::Describe.
virtual const icChar *	GetClassName () const
icUInt8Number *	GetData (icUInt32Number index=0)
icUInt32Number	GetSize () const
virtual icTagTypeSignature	GetType () const
	Function: GetType()
virtual bool	IsArrayType ()
virtual bool	IsTypeAscii ()
virtual bool	IsTypeBinary ()
virtual bool	IsTypeCompressed ()
virtual bool	IsTypeUtf ()
virtual CIccTag *	NewCopy () const
	Function: NewCopy(sDescription) Each derived tag will implement it's own NewCopy() function.
CIccTagData &	operator= (const CIccTagData &DataTag)
	Name: CIccTagData::operator=.
icUInt8Number &	operator[] (icUInt32Number index)
virtual bool	Read (icUInt32Number size, CIccIO *pIO)
	Name: CIccTagData::Read.
virtual void	SetDataType (icDataBlockType dataType=icAsciiData)
bool	SetSize (icUInt32Number nSize, bool bZeroNew=true)
	Name: CIccTagData::SetSize.
virtual icValidateStatus	Validate (std::string sigPath, std::string &sReport, const CIccProfile *pProfile=NULL) const
	Name: CIccTagData::Validate.
virtual bool	Write (CIccIO *pIO)
	Name: CIccTagData::Write.
virtual	~CIccTagData ()
	Name: CIccTagData::~CIccTagData.
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
icDataBlockType	m_nDataFlag
icUInt32Number	m_nSize
icUInt8Number *	m_pData

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

Purpose: The data type tag

Definition at line 1275 of file IccTagBasic.h.

Constructor & Destructor Documentation

CIccTagData() [1/2]

CIccTagData::CIccTagData

(

int

nSize = 1

)

Name: CIccTagData::CIccTagData.

Purpose: Constructor

Args: nSize = number of data entries

Definition at line 7745 of file IccTagBasic.cpp.

{
  m_nSize = nSize;
  if (m_nSize <1)
    m_nSize = 1;
  m_pData = (icUInt8Number*)calloc(nSize, sizeof(icUInt8Number));
}

CIccTagData() [2/2]

CIccTagData::CIccTagData

(

const CIccTagData &

ITD

)

Name: CIccTagData::CIccTagData.

Purpose: Copy Constructor

Args: ITD = The CIccTagData object to be copied

Definition at line 7764 of file IccTagBasic.cpp.

{
  m_nDataFlag = ITD.m_nDataFlag;
  m_nSize = ITD.m_nSize;
 
  m_pData = (icUInt8Number*)calloc(m_nSize, sizeof(icUInt8Number));
  memcpy(m_pData, ITD.m_pData, sizeof(icUInt8Number)*m_nSize);
}

References m_nDataFlag, m_nSize, and m_pData.

~CIccTagData()

CIccTagData::~CIccTagData ( )

virtual

Name: CIccTagData::~CIccTagData.

Purpose: Destructor

Definition at line 7809 of file IccTagBasic.cpp.

{
  if (m_pData)
    free(m_pData);
}

Member Function Documentation

Describe()

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

virtual

Name: CIccTagData::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 7925 of file IccTagBasic.cpp.

{
  icChar buf[128];
 
  sDescription = "\n";
  if (IsTypeCompressed())
    sDescription += "Compressed ";  // If data is compressed, prepend appropriate text
 
  if (IsTypeAscii()) {
    sDescription = "Ascii Data:\n";
 
    for (int i=0; i<(int)m_nSize; i++)
      sDescription += (icChar)m_pData[i];
  }
  else if (IsTypeUtf()) {
    if (m_nSize>2 && 
        ((m_pData[0]==0xff && m_pData[1]==0xfe) ||  //UTF-16LE
         (m_pData[0]==0xfe && m_pData[1]==0xff))) { //UTF-16BE
      sprintf(buf, "UTF-16%s Data:", m_pData[0]==0xff ? "LE" : "BE" );
      sDescription = buf;
 
      icMemDump(sDescription, m_pData, m_nSize);
    }
    else { //UTF-8
      sDescription = "UTF-8 Data:\n";
 
      for (int i=0; i<(int)m_nSize; i++)
        sDescription += (icChar)m_pData[i];
    }
  }
  else {
    if (IsTypeBinary()) {
      sDescription = "Binary Data:\n";
    }
    else {
      sDescription = "Other Data:\n";
    }
 
    icMemDump(sDescription, m_pData, m_nSize);
  }
  sDescription += "\n";
}

References icMemDump().

Here is the call graph for this function:

GetClassName()

virtual const icChar * CIccTagData::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTag.

Reimplemented in CIccTagXmlTagData.

Definition at line 1285 of file IccTagBasic.h.

{ return "CIccTagData"; }

GetData()

icUInt8Number * CIccTagData::GetData ( icUInt32Number index = 0 )

inline

Definition at line 1297 of file IccTagBasic.h.

{ return &m_pData[index];}

GetSize()

icUInt32Number CIccTagData::GetSize ( ) const

inline

Definition at line 1294 of file IccTagBasic.h.

{ return m_nSize; }

GetType()

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

{ return icSigDataType; }

References icSigDataType.

IsArrayType()

virtual bool CIccTagData::IsArrayType ( )

inlinevirtual

Reimplemented from CIccTag.

Definition at line 1287 of file IccTagBasic.h.

{ return m_nSize > 1; }

IsTypeAscii()

virtual bool CIccTagData::IsTypeAscii ( )

inlinevirtual

Definition at line 1300 of file IccTagBasic.h.

{ return (m_nDataFlag&icDataTypeMask) == icAsciiData; }

References icAsciiData, and icDataTypeMask.

IsTypeBinary()

virtual bool CIccTagData::IsTypeBinary ( )

inlinevirtual

Definition at line 1301 of file IccTagBasic.h.

{ return (m_nDataFlag&icDataTypeMask) == icBinaryData; }

References icBinaryData, and icDataTypeMask.

IsTypeCompressed()

virtual bool CIccTagData::IsTypeCompressed ( )

inlinevirtual

Definition at line 1303 of file IccTagBasic.h.

{ return (m_nDataFlag & icCompressedData) != 0; }

References icCompressedData.

IsTypeUtf()

virtual bool CIccTagData::IsTypeUtf ( )

inlinevirtual

Definition at line 1302 of file IccTagBasic.h.

{ return (m_nDataFlag&icDataTypeMask) == icUtfData; }

References icDataTypeMask, and icUtfData.

NewCopy()

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

{return new CIccTagData(*this);}

operator=()

CIccTagData & CIccTagData::operator=

(

const CIccTagData &

DataTag

)

Name: CIccTagData::operator=.

Purpose: Copy Operator

Args: DataTag = The CIccTagData object to be copied

Definition at line 7784 of file IccTagBasic.cpp.

{
  if (&DataTag == this)
    return *this;
 
  m_nDataFlag = DataTag.m_nDataFlag;
  m_nSize = DataTag.m_nSize;
 
  if (m_pData)
    free(m_pData);
  m_pData = (icUInt8Number*)calloc(m_nSize, sizeof(icUInt8Number));
  memcpy(m_pData, DataTag.m_pData, sizeof(icUInt8Number)*m_nSize);
 
  return *this;
}

References m_nDataFlag, m_nSize, and m_pData.

operator[]()

icUInt8Number & CIccTagData::operator[] ( icUInt32Number index )

inline

Definition at line 1296 of file IccTagBasic.h.

{ return m_pData[index]; }

Read()

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

virtual

Name: CIccTagData::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 7830 of file IccTagBasic.cpp.

{
  icTagTypeSignature sig;
 
  if (sizeof(icTagTypeSignature) + 
      sizeof(icUInt32Number) + 
      sizeof(icUInt32Number) +
      sizeof(icUInt8Number) > size)
    return false;
 
  if (!pIO) {
    return false;
  }
 
  if (!pIO->Read32(&sig))
    return false;
 
  if (!pIO->Read32(&m_nReserved))
    return false;
 
  if (!pIO->Read32(&m_nDataFlag))
    return false;
 
  icUInt32Number nNum = size-3*sizeof(icUInt32Number);
 
  if (!SetSize(nNum))
    return false;
 
  if (pIO->Read8(m_pData, nNum) != (icInt32Number)nNum)
    return false;
 
  if (IsTypeCompressed()) {
    //Uncompress data here
  }
 
  return true;
}

References CIccIO::Read32(), CIccIO::Read8(), and sig.

Here is the call graph for this function:

SetDataType()

virtual void CIccTagData::SetDataType ( icDataBlockType dataType = icAsciiData )

inlinevirtual

Definition at line 1299 of file IccTagBasic.h.

{ m_nDataFlag = dataType; }

SetSize()

bool CIccTagData::SetSize	(	icUInt32Number	nSize,
		bool	bZeroNew = true )

Name: CIccTagData::SetSize.

Purpose: Sets the size of the data array.

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

Definition at line 7979 of file IccTagBasic.cpp.

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

References icRealloc().

Here is the call graph for this function:

Validate()

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

virtual

Name: CIccTagData::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 8014 of file IccTagBasic.cpp.

{
  icValidateStatus rv = CIccTag::Validate(sigPath, sReport, pProfile);
 
  CIccInfo Info;
  std::string sSigPathName = Info.GetSigPathName(sigPath);
 
  // Mask bits to match processing in Describe() so warnings are appropriate
  switch(m_nDataFlag&(icCompressedData|icDataTypeMask)) {
  case icAsciiData:
    for (int i = 0; i < (int)m_nSize; i++) {
      if (m_pData[i] & 0x80) {
        sReport += icMsgValidateWarning;
        sReport += sSigPathName;
        sReport += " - Ascii Data is not just 7-bit data.\n";
        rv = icMaxStatus(rv, icValidateWarning);
        break;
      }
    }
    break;
  case icBinaryData:
  case icUtfData:
  case icCompressedAsciiData:
  case icCompressedBinaryData:
  case icCompressedUtfData:
    break;
  default:
    sReport += icMsgValidateNonCompliant;
    sReport += sSigPathName;
    sReport += " - Invalid data flag encoding.\n";
    rv = icMaxStatus(rv, icValidateNonCompliant);
  }
  
  if (m_nDataFlag & ~(icCompressedData | icDataTypeMask)) {
      sReport += icMsgValidateNonCompliant;
      sReport += sSigPathName;
      sReport += " - Invalid data flag encoding (reserved high order bits).\n";
      rv = icMaxStatus(rv, icValidateNonCompliant);
  }
 
  return rv;
}

References CIccInfo::GetSigPathName(), icAsciiData, icBinaryData, icCompressedAsciiData, icCompressedBinaryData, icCompressedData, icCompressedUtfData, icDataTypeMask, icMaxStatus(), icMsgValidateNonCompliant, icMsgValidateWarning, icUtfData, icValidateNonCompliant, icValidateWarning, and CIccTag::Validate().

Here is the call graph for this function:

Write()

bool CIccTagData::Write ( CIccIO * pIO )

virtual

Name: CIccTagData::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 7882 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_nDataFlag))
    return false;
 
  if (IsTypeCompressed()) {
    icUInt32Number *pData = NULL;
    icInt32Number nSize = 0;
    //Compress data here
 
    if (pIO->Write8(pData, nSize) != (icInt32Number)nSize)
      return false;
  }
  else {
    if (pIO->Write8(m_pData, m_nSize) != (icInt32Number)m_nSize)
      return false;
  }
 
  return true;
}

References sig, CIccIO::Write32(), and CIccIO::Write8().

Here is the call graph for this function:

Member Data Documentation

m_nDataFlag

icDataBlockType CIccTagData::m_nDataFlag

protected

Definition at line 1308 of file IccTagBasic.h.

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

m_nSize

icUInt32Number CIccTagData::m_nSize

protected

Definition at line 1310 of file IccTagBasic.h.

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

m_pData

icUInt8Number* CIccTagData::m_pData

protected

Definition at line 1309 of file IccTagBasic.h.

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

---

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

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