/*
* CVS identifier:
*
* $Id: PktInfo.java,v 1.7 2001/02/14 10:54:49 grosbois Exp $
*
* Class:                   PktInfo
*
* Description:             Object containing packet informations.
* 
*
*
* COPYRIGHT:
* 
* This software module was originally developed by Raphaël Grosbois and
* Diego Santa Cruz (Swiss Federal Institute of Technology-EPFL); Joel
* Askelöf (Ericsson Radio Systems AB); and Bertrand Berthelot, David
* Bouchard, Félix Henry, Gerard Mozelle and Patrice Onno (Canon Research
* Centre France S.A) in the course of development of the JPEG2000
* standard as specified by ISO/IEC 15444 (JPEG 2000 Standard). This
* software module is an implementation of a part of the JPEG 2000
* Standard. Swiss Federal Institute of Technology-EPFL, Ericsson Radio
* Systems AB and Canon Research Centre France S.A (collectively JJ2000
* Partners) agree not to assert against ISO/IEC and users of the JPEG
* 2000 Standard (Users) any of their rights under the copyright, not
* including other intellectual property rights, for this software module
* with respect to the usage by ISO/IEC and Users of this software module
* or modifications thereof for use in hardware or software products
* claiming conformance to the JPEG 2000 Standard. Those intending to use
* this software module in hardware or software products are advised that
* their use may infringe existing patents. The original developers of
* this software module, JJ2000 Partners and ISO/IEC assume no liability
* for use of this software module or modifications thereof. No license
* or right to this software module is granted for non JPEG 2000 Standard
* conforming products. JJ2000 Partners have full right to use this
* software module for his/her own purpose, assign or donate this
* software module to any third party and to inhibit third parties from
* using this software module for non JPEG 2000 Standard conforming
* products. This copyright notice must be included in all copies or
* derivative works of this software module.
* 
* Copyright (c) 1999/2000 JJ2000 Partners.
* */
using System;
namespace CSJ2K.j2k.codestream.reader
{
	
	/// <summary> This class defines an object used to countain informations about a packet
	/// to which the current code-block belongs.
	/// 
	/// </summary>
	/// <seealso cref="CBlkInfo">
	/// 
	/// </seealso>
	public class PktInfo
	{
		
		/// <summary>Index of the packet </summary>
		public int packetIdx;
		
		/// <summary>The layer associated with the current code-block in this packet. </summary>
		public int layerIdx;
		
		/// <summary>The code-block offset in the codestream (for this packet) </summary>
		public int cbOff = 0;
		
		/// <summary>The length of the code-block in this packet (in bytes) </summary>
		public int cbLength;
		
		/// <summary> The length of each terminated segment in the packet. The total is the
		/// same as 'cbLength'. It can be null if there is only one terminated
		/// segment, in which case 'cbLength' holds the legth of that segment 
		/// 
		/// </summary>
		public int[] segLengths;
		
		/// <summary> The number of truncation points that appear in this packet, and all
		/// previous packets, for this code-block. This is the number of passes
		/// that can be decoded with the information in this packet and all
		/// previous ones. 
		/// 
		/// </summary>
		public int numTruncPnts;
		
		/// <summary> Classe's constructor.
		/// 
		/// </summary>
		/// <param name="lyIdx">The layer index for the code-block in this packet
		/// 
		/// </param>
		/// <param name="pckIdx">The packet index
		/// 
		/// </param>
		public PktInfo(int lyIdx, int pckIdx)
		{
			layerIdx = lyIdx;
			packetIdx = pckIdx;
		}
		
		/// <summary> Object information in a string.
		/// 
		/// </summary>
		/// <returns> Object information
		/// 
		/// </returns>
		public override System.String ToString()
		{
			return "packet " + packetIdx + " (lay:" + layerIdx + ", off:" + cbOff + ", len:" + cbLength + ", numTruncPnts:" + numTruncPnts + ")\n";
		}
	}
}