CIccTagEmbeddedHeightImage Class Reference

Class: CIccTagEmbeddedHeightImage. More...

#include <IccTagBasic.h>

Inheritance diagram for CIccTagEmbeddedHeightImage:

Collaboration diagram for CIccTagEmbeddedHeightImage:

Public Member Functions
	CIccTagEmbeddedHeightImage (const CIccTagEmbeddedHeightImage &IEHI)
	Name: CIccTagEmbeddedHeightImage::CIccTagEmbeddedHeightImage.
	CIccTagEmbeddedHeightImage (int nSize=1)
	Name: CIccEmbeddedHeightImage::CIccEmbeddedHeightImage.
virtual void	Describe (std::string &sDescription, int nVerboseness)
	Name: CIccTagEmbeddedHeightImage::Describe.
virtual const icChar *	GetClassName () const
icUInt8Number *	GetData (icUInt32Number index=0)
icUInt32Number	GetSize () const
virtual icTagTypeSignature	GetType () const
	Function: GetType()
virtual CIccTag *	NewCopy () const
	Function: NewCopy(sDescription) Each derived tag will implement it's own NewCopy() function.
CIccTagEmbeddedHeightImage &	operator= (const CIccTagEmbeddedHeightImage &HeightTag)
	Name: CIccTagEmbeddedHeightImage::operator=.
icUInt8Number &	operator[] (icUInt32Number index)
virtual bool	Read (icUInt32Number size, CIccIO *pIO)
	Name: CIccTagEmbeddedHeightImage::Read.
bool	SetSize (icUInt32Number nSize, bool bZeroNew=true)
	Name: CIccTagEmbeddedHeightImage::SetSize.
virtual icValidateStatus	Validate (std::string sigPath, std::string &sReport, const CIccProfile *pProfile=NULL) const
	Name: CIccTagEmbeddedHeightImage::Validate.
virtual bool	Write (CIccIO *pIO)
	Name: CIccTagEmbeddedHeightImage::Write.
virtual	~CIccTagEmbeddedHeightImage ()
	Name: CIccTagEmbeddedHeightImage::~CIccTagEmbeddedHeightImage.
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
icFloatNumber	m_fMetersMaxPixelValue
icFloatNumber	m_fMetersMinPixelValue
icImageEncodingType	m_nEncodingFormat
icUInt32Number	m_nSeamlesIndicator
Public Attributes inherited from CIccTag
icUInt32Number	m_nReserved

Protected Attributes
icUInt32Number	m_nSize
icUInt8Number *	m_pData

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

Detailed Description

Class: CIccTagEmbeddedHeightImage.

Purpose: The Embedded Height map tag

Definition at line 1751 of file IccTagBasic.h.

Constructor & Destructor Documentation

CIccTagEmbeddedHeightImage() [1/2]

CIccTagEmbeddedHeightImage::CIccTagEmbeddedHeightImage

(

int

nSize = 1

)

Name: CIccEmbeddedHeightImage::CIccEmbeddedHeightImage.

Purpose: Constructor

Args: nSize =size of embedded image

Definition at line 11639 of file IccTagBasic.cpp.

{
  m_nSize = nSize;
  if (m_nSize <1)
    m_nSize = 1;
  m_pData = (icUInt8Number*)calloc(nSize, sizeof(icUInt8Number));
  m_nSeamlesIndicator = 0;
  m_nEncodingFormat = icPngImageType;
  m_fMetersMinPixelValue = 0;
  m_fMetersMaxPixelValue = 0;
}

References icPngImageType.

CIccTagEmbeddedHeightImage() [2/2]

CIccTagEmbeddedHeightImage::CIccTagEmbeddedHeightImage

(

const CIccTagEmbeddedHeightImage &

IEHI

)

Name: CIccTagEmbeddedHeightImage::CIccTagEmbeddedHeightImage.

Purpose: Copy Constructor

Args: ITD = The CIccEmbeddedHeightImage object to be copied

Definition at line 11662 of file IccTagBasic.cpp.

{
  m_nSeamlesIndicator = IEHI.m_nSeamlesIndicator;
  m_nEncodingFormat = IEHI.m_nEncodingFormat;
  m_fMetersMinPixelValue = IEHI.m_fMetersMinPixelValue;
  m_fMetersMaxPixelValue = IEHI.m_fMetersMaxPixelValue;
  m_nSize = IEHI.m_nSize;
 
  m_pData = (icUInt8Number*)calloc(m_nSize, sizeof(icUInt8Number));
  memcpy(m_pData, IEHI.m_pData, sizeof(icUInt8Number)*m_nSize);
}

References m_fMetersMaxPixelValue, m_fMetersMinPixelValue, m_nEncodingFormat, m_nSeamlesIndicator, m_nSize, and m_pData.

~CIccTagEmbeddedHeightImage()

CIccTagEmbeddedHeightImage::~CIccTagEmbeddedHeightImage ( )

virtual

Name: CIccTagEmbeddedHeightImage::~CIccTagEmbeddedHeightImage.

Purpose: Destructor

Definition at line 11713 of file IccTagBasic.cpp.

{
  if (m_pData)
    free(m_pData);
}

Member Function Documentation

Describe()

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

virtual

Name: CIccTagEmbeddedHeightImage::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 11836 of file IccTagBasic.cpp.

{
  icChar buf[128];
 
  sprintf(buf, "\nSeamlessIndicater: %d\n", m_nSeamlesIndicator);
  sDescription += buf;
 
  switch (m_nEncodingFormat) {
  case icPngImageType:
    strcpy(buf, "EncodingFormat: PNG\n");
    break;
  case icTiffImageType:
    strcpy(buf, "EncodingFormat: TIFF\n");
    break;
  default:
    sprintf(buf, "EncodingFormat: %d", m_nEncodingFormat);
    break;
  }
  sDescription += buf;
 
  sprintf(buf, "Height minimum pixel: %.4fmeters\n", m_fMetersMinPixelValue);
  sprintf(buf, "Height maximum pixel: %.4fmeters\n", m_fMetersMaxPixelValue);
 
  sDescription += "\nImage Data:\n";
 
  for (int i = 0; i<(int)m_nSize; i++) {
    if (!(i & 0x1f))
      sDescription += "\n";
    sprintf(buf, "%02X", m_pData[i]);
    sDescription += buf;
  }
  sDescription += "\n";
}

References icPngImageType, and icTiffImageType.

GetClassName()

virtual const icChar * CIccTagEmbeddedHeightImage::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTag.

Definition at line 1761 of file IccTagBasic.h.

{ return "CIccTagEmbeddedHeightImage"; }

GetData()

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

inline

Definition at line 1771 of file IccTagBasic.h.

{ return &m_pData[index]; }

GetSize()

icUInt32Number CIccTagEmbeddedHeightImage::GetSize ( ) const

inline

Definition at line 1768 of file IccTagBasic.h.

{ return m_nSize; }

GetType()

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

{ return icSigEmbeddedHeightImageType; }

References icSigEmbeddedHeightImageType.

NewCopy()

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

{ return new CIccTagEmbeddedHeightImage(*this); }

operator=()

CIccTagEmbeddedHeightImage & CIccTagEmbeddedHeightImage::operator=

(

const CIccTagEmbeddedHeightImage &

HeightImageTag

)

Name: CIccTagEmbeddedHeightImage::operator=.

Purpose: Copy Operator

Args: DataTag = The CIccTagData object to be copied

Definition at line 11685 of file IccTagBasic.cpp.

{
  if (&HeightImageTag == this)
    return *this;
 
  m_nSeamlesIndicator = HeightImageTag.m_nSeamlesIndicator;
  m_nEncodingFormat = HeightImageTag.m_nEncodingFormat;
  m_fMetersMinPixelValue = HeightImageTag.m_fMetersMinPixelValue;
  m_fMetersMaxPixelValue = HeightImageTag.m_fMetersMaxPixelValue;
  m_nSize = HeightImageTag.m_nSize;
 
  if (m_pData)
    free(m_pData);
  m_pData = (icUInt8Number*)calloc(m_nSize, sizeof(icUInt8Number));
  memcpy(m_pData, HeightImageTag.m_pData, sizeof(icUInt8Number)*m_nSize);
 
  return *this;
}

References m_fMetersMaxPixelValue, m_fMetersMinPixelValue, m_nEncodingFormat, m_nSeamlesIndicator, m_nSize, and m_pData.

operator[]()

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

inline

Definition at line 1770 of file IccTagBasic.h.

{ return m_pData[index]; }

Read()

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

virtual

Name: CIccTagEmbeddedHeightImage::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 11734 of file IccTagBasic.cpp.

{
  icTagTypeSignature sig;
 
  if (sizeof(icTagTypeSignature) +
    sizeof(icUInt32Number) +
    sizeof(icUInt32Number) +
    sizeof(icUInt32Number) +
    sizeof(icFloat32Number) +
    sizeof(icFloat32Number) +
    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_nSeamlesIndicator))
    return false;
 
  if (!pIO->Read32(&m_nEncodingFormat))
    return false;
 
  if (!pIO->ReadFloat32Float(&m_fMetersMinPixelValue))
    return false;
 
  if (!pIO->ReadFloat32Float(&m_fMetersMaxPixelValue))
    return false;
 
  icUInt32Number nNum = size - 6 * sizeof(icUInt32Number);
 
  if (!SetSize(nNum))
    return false;
 
  if (pIO->Read8(m_pData, nNum) != (icInt32Number)nNum)
    return false;
 
  return true;
}

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

Here is the call graph for this function:

SetSize()

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

Name: CIccTagEmbeddedHeightImage::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 11881 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 CIccTagEmbeddedHeightImage::Validate ( std::string sigPath, std::string & sReport, const CIccProfile * pProfile = NULL ) const

virtual

Name: CIccTagEmbeddedHeightImage::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 11916 of file IccTagBasic.cpp.

{
  icValidateStatus rv = CIccTag::Validate(sigPath, sReport, pProfile);
 
  CIccInfo Info;
  std::string sSigPathName = Info.GetSigPathName(sigPath);
 
  switch (m_nSeamlesIndicator) {
  case 0:
  case 1:
    break;
  default:
    sReport += icMsgValidateNonCompliant;
    sReport += sSigPathName;
    sReport += " - Invalid data flag Seamless Indicator.\n";
    rv = icMaxStatus(rv, icValidateNonCompliant);
  }
 
  switch (m_nEncodingFormat) {
  case icPngImageType:
  case icTiffImageType:
    break;
  default:
    sReport += icMsgValidateNonCompliant;
    sReport += sSigPathName;
    sReport += " - Invalid data flag Encoding Image Type.\n";
    rv = icMaxStatus(rv, icValidateNonCompliant);
  }
 
  return rv;
}

References CIccInfo::GetSigPathName(), icMaxStatus(), icMsgValidateNonCompliant, icPngImageType, icTiffImageType, icValidateNonCompliant, and CIccTag::Validate().

Here is the call graph for this function:

Write()

bool CIccTagEmbeddedHeightImage::Write ( CIccIO * pIO )

virtual

Name: CIccTagEmbeddedHeightImage::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 11794 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_nSeamlesIndicator))
    return false;
 
  if (!pIO->Write32(&m_nEncodingFormat))
    return false;
 
  if (!pIO->WriteFloat32Float(&m_fMetersMinPixelValue))
    return false;
 
  if (!pIO->WriteFloat32Float(&m_fMetersMaxPixelValue))
    return false;
 
  if (pIO->Write8(m_pData, m_nSize) != (icInt32Number)m_nSize)
    return false;
 
  return true;
}

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

Here is the call graph for this function:

Member Data Documentation

m_fMetersMaxPixelValue

icFloatNumber CIccTagEmbeddedHeightImage::m_fMetersMaxPixelValue

Definition at line 1778 of file IccTagBasic.h.

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

m_fMetersMinPixelValue

icFloatNumber CIccTagEmbeddedHeightImage::m_fMetersMinPixelValue

Definition at line 1777 of file IccTagBasic.h.

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

m_nEncodingFormat

icImageEncodingType CIccTagEmbeddedHeightImage::m_nEncodingFormat

Definition at line 1776 of file IccTagBasic.h.

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

m_nSeamlesIndicator

icUInt32Number CIccTagEmbeddedHeightImage::m_nSeamlesIndicator

Definition at line 1775 of file IccTagBasic.h.

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

m_nSize

icUInt32Number CIccTagEmbeddedHeightImage::m_nSize

protected

Definition at line 1782 of file IccTagBasic.h.

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

m_pData

icUInt8Number* CIccTagEmbeddedHeightImage::m_pData

protected

Definition at line 1781 of file IccTagBasic.h.

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

---

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

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