zxing/csharp/datamatrix/decoder/Version.cs

/*
* Copyright 2007 ZXing authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System;
using ReaderException = com.google.zxing.ReaderException;
namespace com.google.zxing.datamatrix.decoder
{
	
	/// <summary> The Version object encapsulates attributes about a particular
	/// size Data Matrix Code.
	/// 
	/// </summary>
	/// <author>  bbrown@google.com (Brian Brown)
	/// </author>
	/// <author>www.Redivivus.in (suraj.supekar@redivivus.in) - Ported from ZXING Java Source 
	/// </author>
	public sealed class Version
	{
		public int VersionNumber
		{
			get
			{
				return versionNumber;
			}
			
		}
		public int SymbolSizeRows
		{
			get
			{
				return symbolSizeRows;
			}
			
		}
		public int SymbolSizeColumns
		{
			get
			{
				return symbolSizeColumns;
			}
			
		}
		public int DataRegionSizeRows
		{
			get
			{
				return dataRegionSizeRows;
			}
			
		}
		public int DataRegionSizeColumns
		{
			get
			{
				return dataRegionSizeColumns;
			}
			
		}
		public int TotalCodewords
		{
			get
			{
				return totalCodewords;
			}
			
		}
		
		//UPGRADE_NOTE: Final was removed from the declaration of 'VERSIONS '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"
		private static readonly Version[] VERSIONS = buildVersions();
		
		//UPGRADE_NOTE: Final was removed from the declaration of 'versionNumber '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"
		private int versionNumber;
		//UPGRADE_NOTE: Final was removed from the declaration of 'symbolSizeRows '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"
		private int symbolSizeRows;
		//UPGRADE_NOTE: Final was removed from the declaration of 'symbolSizeColumns '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"
		private int symbolSizeColumns;
		//UPGRADE_NOTE: Final was removed from the declaration of 'dataRegionSizeRows '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"
		private int dataRegionSizeRows;
		//UPGRADE_NOTE: Final was removed from the declaration of 'dataRegionSizeColumns '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"
		private int dataRegionSizeColumns;
		//UPGRADE_NOTE: Final was removed from the declaration of 'ecBlocks '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"
		private ECBlocks ecBlocks;
		//UPGRADE_NOTE: Final was removed from the declaration of 'totalCodewords '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"
		private int totalCodewords;
		
		private Version(int versionNumber, int symbolSizeRows, int symbolSizeColumns, int dataRegionSizeRows, int dataRegionSizeColumns, ECBlocks ecBlocks)
		{
			this.versionNumber = versionNumber;
			this.symbolSizeRows = symbolSizeRows;
			this.symbolSizeColumns = symbolSizeColumns;
			this.dataRegionSizeRows = dataRegionSizeRows;
			this.dataRegionSizeColumns = dataRegionSizeColumns;
			this.ecBlocks = ecBlocks;
			
			// Calculate the total number of codewords
			int total = 0;
			int ecCodewords = ecBlocks.ECCodewords;
			ECB[] ecbArray = ecBlocks.getECBlocks();
			for (int i = 0; i < ecbArray.Length; i++)
			{
				ECB ecBlock = ecbArray[i];
				total += ecBlock.Count * (ecBlock.DataCodewords + ecCodewords);
			}
			this.totalCodewords = total;
		}
		
		internal ECBlocks getECBlocks()
		{
			return ecBlocks;
		}
		
		/// <summary> <p>Deduces version information from Data Matrix dimensions.</p>
		/// 
		/// </summary>
		/// <param name="numRows">Number of rows in modules
		/// </param>
		/// <param name="numColumns">Number of columns in modules
		/// </param>
		/// <returns> {@link Version} for a Data Matrix Code of those dimensions
		/// </returns>
		/// <throws>  ReaderException if dimensions do correspond to a valid Data Matrix size </throws>
		public static Version getVersionForDimensions(int numRows, int numColumns)
		{
			if ((numRows & 0x01) != 0 || (numColumns & 0x01) != 0)
			{
				throw ReaderException.Instance;
			}
			
			// TODO(bbrown): This is doing a linear search through the array of versions.
			// If we interleave the rectangular versions with the square versions we could
			// do a binary search.
			int numVersions = VERSIONS.Length;
			for (int i = 0; i < numVersions; ++i)
			{
				Version version = VERSIONS[i];
				if (version.symbolSizeRows == numRows && version.symbolSizeColumns == numColumns)
				{
					return version;
				}
			}
			
			throw ReaderException.Instance;
		}
		
		/// <summary> <p>Encapsulates a set of error-correction blocks in one symbol version. Most versions will
		/// use blocks of differing sizes within one version, so, this encapsulates the parameters for
		/// each set of blocks. It also holds the number of error-correction codewords per block since it
		/// will be the same across all blocks within one version.</p>
		/// </summary>
		internal sealed class ECBlocks
		{
			internal int ECCodewords
			{
				get
				{
					return ecCodewords;
				}
				
			}
			//UPGRADE_NOTE: Final was removed from the declaration of 'ecCodewords '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"
			private int ecCodewords;
			//UPGRADE_NOTE: Final was removed from the declaration of 'ecBlocks '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"
			private ECB[] ecBlocks;
			
			internal ECBlocks(int ecCodewords, ECB ecBlocks)
			{
				this.ecCodewords = ecCodewords;
				this.ecBlocks = new ECB[]{ecBlocks};
			}
			
			internal ECBlocks(int ecCodewords, ECB ecBlocks1, ECB ecBlocks2)
			{
				this.ecCodewords = ecCodewords;
				this.ecBlocks = new ECB[]{ecBlocks1, ecBlocks2};
			}
			
			internal ECB[] getECBlocks()
			{
				return ecBlocks;
			}
		}
		
		/// <summary> <p>Encapsualtes the parameters for one error-correction block in one symbol version.
		/// This includes the number of data codewords, and the number of times a block with these
		/// parameters is used consecutively in the Data Matrix code version's format.</p>
		/// </summary>
		internal sealed class ECB
		{
			internal int Count
			{
				get
				{
					return count;
				}
				
			}
			internal int DataCodewords
			{
				get
				{
					return dataCodewords;
				}
				
			}
			//UPGRADE_NOTE: Final was removed from the declaration of 'count '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"
			private int count;
			//UPGRADE_NOTE: Final was removed from the declaration of 'dataCodewords '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"
			private int dataCodewords;
			
			internal ECB(int count, int dataCodewords)
			{
				this.count = count;
				this.dataCodewords = dataCodewords;
			}
		}
		
		public override System.String ToString()
		{
			return System.Convert.ToString(versionNumber);
		}
		
		/// <summary> See ISO 16022:2006 5.5.1 Table 7</summary>
		private static Version[] buildVersions()
		{
			return new Version[]{new Version(1, 10, 10, 8, 8, new ECBlocks(5, new ECB(1, 3))), new Version(2, 12, 12, 10, 10, new ECBlocks(7, new ECB(1, 5))), new Version(3, 14, 14, 12, 12, new ECBlocks(10, new ECB(1, 8))), new Version(4, 16, 16, 14, 14, new ECBlocks(12, new ECB(1, 12))), new Version(5, 18, 18, 16, 16, new ECBlocks(14, new ECB(1, 18))), new Version(6, 20, 20, 18, 18, new ECBlocks(18, new ECB(1, 22))), new Version(7, 22, 22, 20, 20, new ECBlocks(20, new ECB(1, 30))), new Version(8, 24, 24, 22, 22, new ECBlocks(24, new ECB(1, 36))), new Version(9, 26, 26, 24, 24, new ECBlocks(28, new ECB(1, 44))), new Version(10, 32, 32, 14, 14, new ECBlocks(36, new ECB(1, 62))), new Version(11, 36, 36, 16, 16, new ECBlocks(42, new ECB(1, 86))), new Version(12, 40, 40, 18, 18, new ECBlocks(48, new ECB(1, 114))), new Version(13, 44, 44, 20, 20, new ECBlocks(56, new ECB(1, 144))), new Version(14, 48, 48, 22, 22, new ECBlocks(68, new ECB(1, 174))), new Version(15, 52, 52, 24, 24, new ECBlocks(42, new ECB(2, 102))), new Version(16, 64, 64, 14, 14, new ECBlocks(56, new ECB(2, 140))), new Version(17, 72, 72, 16, 16, new ECBlocks(36, new ECB(4, 92))), new Version(18, 80, 80, 18, 18, new ECBlocks(48, new ECB(4, 114))), new Version(19, 88, 88, 20, 20, new ECBlocks(56, new ECB(4, 144))), new Version(20, 96, 96, 22, 22, new ECBlocks(68, new ECB(4, 174))), new Version(21, 104, 104, 24, 24, new ECBlocks(56, new ECB(6, 136))), new Version(22, 120, 120, 18, 18, new ECBlocks(68, new ECB(6, 175))), new Version(23, 132, 132, 20, 20, new ECBlocks(62, new ECB(8, 163))), new Version(24, 144, 144, 22, 22, new ECBlocks(62, new ECB(8, 156), new ECB(2, 155))), new Version(25, 8, 18, 6, 16, new ECBlocks(7, new ECB(1, 5))), new Version(26, 8, 32, 6, 14, new ECBlocks(11, new ECB(1, 10))), new Version(27, 12, 26, 10, 24, new ECBlocks(14, new ECB(1, 16))), new Version(28, 12, 36, 10, 16, new ECBlocks(18, new ECB(1, 22))), new Version(29, 16, 36, 10, 16, new ECBlocks(24, new ECB(1, 32))), new Version(30, 16, 48, 14, 22, new ECBlocks(28, 
				new ECB(1, 49)))};
		}
	}
}