Changeset 901

Timestamp:

10/06/08 03:41:13 (3 months ago)

Author:

MartinVales

Message:

 

Location:

trunk/csharp/dotnetLibLAS

Files:

• AssemblyInfo.cs (modified) (1 diff)
• LASException.cs (modified) (2 diffs)
• LASHeader.cs (modified) (3 diffs)
• LASPoint.cs (modified) (16 diffs)
• LASReader.cs (modified) (6 diffs)
• LASWriter.cs (modified) (4 diffs)
• LibLASCAPI.cs (modified) (8 diffs)
• dotnetLibLAS.csproj (modified) (3 diffs)

trunk/csharp/dotnetLibLAS/AssemblyInfo.cs

@@ -32 +32 @@
 // You can specify all the values or you can default the Revision and Build Numbers 
 // by using the '*' as shown below:
-[assembly: AssemblyVersion("0.2.0.0")]
-[assembly: AssemblyFileVersion("0.2.0.0")]
+[assembly: AssemblyVersion("0.3.0.0")]
+[assembly: AssemblyFileVersion("0.3.0.0")]

trunk/csharp/dotnetLibLAS/LASException.cs

@@ -65 +65 @@
     };
 
-
+    /// <summary>
+    /// LASException class
+    /// </summary>
     public class LASException :
         System.ApplicationException
 
     {
+        /// <summary>
+        /// Default constructor
+        /// </summary>
+        /// <param name="message">string to show</param>
         public LASException(string message)
             :
@@ -76 +82 @@
 
         }
-
+        /// <summary>
+        /// TODO
+        /// </summary>
+        /// <param name="value">TODO</param>
+        /// <returns>the string </returns>
         public static string GetString(Int32 value)
         

trunk/csharp/dotnetLibLAS/LASHeader.cs

@@ -1 +1 @@
 /******************************************************************************
-
  * 
-
  *
-
  * Project:  libLAS - http://liblas.org - A BSD library for LAS format data.
-
  * Purpose:  
-
  * Author:   Martin Vales, martin_gnu@mundo-r.com
-
  *
-
  ******************************************************************************
-
  * Copyright (c) 2008, Martin Vales
-
  *
-
  * All rights reserved.
-
  * 
-
  * Redistribution and use in source and binary forms, with or without 
-
  * modification, are permitted provided that the following 
-
  * conditions are met:
-
  * 
-
  *     * Redistributions of source code must retain the above copyright 
-
  *       notice, this list of conditions and the following disclaimer.
-
  *     * Redistributions in binary form must reproduce the above copyright 
-
  *       notice, this list of conditions and the following disclaimer in 
-
  *       the documentation and/or other materials provided 
-
  *       with the distribution.
-
  *     * Neither the name of the Martin Isenburg or Iowa Department 
-
  *       of Natural Resources nor the names of its contributors may be 
-
  *       used to endorse or promote products derived from this software 
-
  *       without specific prior written permission.
-
  * 
-
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
-
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
-
  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
-
  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
-
  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
-
  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
-
  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 
-
  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 
-
  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
-
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
-
  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
-
  * OF SUCH DAMAGE.
-
  ****************************************************************************/
 
-
-
 using System;
-
 using System.Collections.Generic;
-
 using System.Text;
-
 using LASError = System.Int32;
-
 using LASWriterH = System.IntPtr;
-
 using LASReaderH = System.IntPtr;
-
 using LASPointH = System.IntPtr;
-
 using LASGuidH = System.IntPtr;
-
 using LASVLRH = System.IntPtr;
-
 using LASHeaderH = System.IntPtr;
-
-
 
 namespace LibLAS
 {
-
+    /// <summary>
+    /// LASHeader class
+    /// </summary>
     public class LASHeader : IDisposable
     {
 
-
-
-        // The object user should call this method
-
-        // when they finished with the object.
-
+        /// <summary>
+        /// The object user should call this method when they finished with the object. In .NET is magaged by the GC.
+        /// </summary>
         public void Dispose()
         {
 
-
-
             CAPI.LASHeader_Destroy(hHeader);
-
             // Clean up unmanaged resources here.
-
             // Dispose other contained disposable objects.
-
-        }
-
-
-
-
+        }
 
 
@@ -136 +74 @@
         enum FormatVersion
         {
-
-            eVersionMajorMin = 1, ///< Minimum of major component
-
-            eVersionMajorMax = 1, ///< Maximum of major component
-
-            eVersionMinorMin = 0, ///< Minimum of minor component
-
-            eVersionMinorMax = 1 ///< Maximum of minor component
-
+            /// Minimum of major component
+            eVersionMajorMin = 1,
+            ///Maximum of major component        
+            eVersionMajorMax = 1, 
+            /// Minimum of minor component
+            eVersionMinorMin = 0, 
+            /// Maximum of minor component
+            eVersionMinorMax = 1 
         };
 
-
-
         /// Versions of point record format.
-
         enum PointFormat
         {
-
-            ePointFormat0 = 0, ///< Point Data Format \e 0
-
-            ePointFormat1 = 1  ///< Point Data Format \e 1
-
+            ///Point Data Format \e 0
+            ePointFormat0 = 0,
+            /// Point Data Format \e 1
+            ePointFormat1 = 1  
         };
 
-
-
         /// Number of bytes of point record storage in particular format.
-
         enum PointSize
         {
-
-            ePointSize0 = 20, ///< Size of point record in data format \e 0
-
-            ePointSize1 = 28  ///< Size of point record in data format \e 1
-
+            ///Size of point record in data format \e 0
+            ePointSize0 = 20,
+            /// Size of point record in data format \e 1
+            ePointSize1 = 28  
         };
 
 
-
-
-
-        // Official signature of ASPRS LAS file format, always \b "LASF".
-
-        public static readonly string FileSignature_;
-
-
-
-        // Default system identifier used by libLAS, always \b "libLAS".
-
-        public static readonly string SystemIdentifier;
-
-
-
-        //Default software identifier used by libLAS, always \b "libLAS X.Y".
-
-        public static readonly string SoftwareIdentifier;
-
-
-
+        //// Official signature of ASPRS LAS file format, always \b "LASF".
+        //public static readonly string FileSignature_;
+
+        //// Default system identifier used by libLAS, always \b "libLAS".
+        //public static readonly string SystemIdentifier;
+
+        ////Default software identifier used by libLAS, always \b "libLAS X.Y".
+        //public static readonly string SoftwareIdentifier;
 
 
         private LASHeaderH hHeader;
 
-
-
+        /// <summary>
+        /// gets the opaque pointer to the LASHeaderH instance.
+        /// </summary>
+        /// <returns>opaque pointer to the LASHeaderH instance.</returns>
         public LASHeaderH GetPointer()
         {
-
             return hHeader;
-
-        }
-
-
-
-        //Default constructor.
-
-        //The default constructed header is configured according to the ASPRS
-
-        //LAS 1.1 Specification, point data format set to 0.
-
-        //Other fields filled with 0.
-
-        public LASHeader(LASHeaderH hHeader_)
-        {
-
-            hHeader = hHeader_;
-
-        }
-
-
-
+        }
+
+
+        /// <summary>
+        /// LASHeader constructor using the LASHeaderH opaque pointer.
+        /// </summary>
+        /// <param name="hLASHeader"></param>
+        public LASHeader(LASHeaderH hLASHeader)
+        {
+            hHeader = hLASHeader;
+        }
+
+        /// <summary>
+        /// Default constructor.
+        /// </summary>
+        /// <remarks>The default constructed header is configured according to the ASPRS LAS 1.1 Specification, point data format set to 0. Other fields filled with 0.</remarks>
         public LASHeader()
         {
-
             hHeader = CAPI.LASHeader_Create();
-
-        }
-
-
-
+        }
+
+
+        /// <summary>
+        /// Copy the LASHeader in a new instance
+        /// </summary>
+        /// <returns>new LASHeader instance.</returns>
         public LASHeader Copy()
         {
-
             return new LASHeader(CAPI.LASHeader_Copy(hHeader));
-
-        }
-
-
-
+        }
+
+        /// <summary>
+        /// Destroy the unmanaged resources to the instance.
+        /// </summary>
+        /// <remarks>The user could call this method when they finished with the object.</remarks>
         public void Destroy()
         {
-
             CAPI.LASHeader_Destroy(hHeader);
-
-        }
-
-
-
-        //    /// Assignment operator.
-
-        //    LASHeader& operator=(LASHeader const& rhs);
-
-
-
-        //    /// Comparison operator.
-
-        //    bool operator==(const LASHeader& other) const;
-
-
-
-
-
-
-
-
-
-        //Set ASPRS LAS file signature.
-
-        //The only value allowed as file signature is \b "LASF",
-
-        //defined as FileSignature constant.
-
-        //\exception std::invalid_argument - if invalid signature given.
-
-        //\param v - string contains file signature, at least 4-bytes long
-
-        //with "LASF" as first four bytes.
-
-
-
-        //Get ASPRS LAS file signature.
-
-        //\return 4-characters long string - \b "LASF".
-
+        }
+
+        /// <summary>
+        /// Comparison overload to the LASHeader
+        /// </summary>
+        /// <param name="lasHeader1">LASHeader instance to be compared</param>
+        /// <param name="lasHeader2">LASHeader instance to be compared</param>
+        /// <returns>true if lasHeader1==lasHeader2</returns>
+        public static bool operator ==(LASHeader lasHeader1, LASHeader lasHeader2)
+        {
+            return lasHeader1.Equals(lasHeader2);
+        }
+
+        /// <summary>
+        /// Comparison overload to the LASHeader
+        /// </summary>
+        /// <param name="lasHeader1">LASHeader instance to be compared</param>
+        /// <param name="lasHeader2">LASHeader instance to be compared</param>
+        /// <returns></returns>
+        public static bool operator !=(LASHeader lasHeader1, LASHeader lasHeader2)
+        {
+            return !(lasHeader1 == lasHeader2);
+        }
+
+
+        /// <summary>
+        /// Get ASPRS LAS file signature.
+        /// </summary>
+        /// <remarks>The only value allowed as file signature is "LASF",</remarks>
         public string FileSignature
         {
-
-            get
-            {
-
+            get
+            {
                 return CAPI.LASHeader_GetFileSignature(hHeader);
-
-            }
-
-        }
-
-
-
-        //Get file source identifier.
-
-        //\exception No throw
-
-        //    /// Set file source identifier.
-
-        //    /// \param v - should be set to a value between 1 and 65535.
-
-        //    /// \exception No throw
-
+            }
+        }
+
+
+        /// <summary>
+        /// file source identifier.
+        /// </summary>
+        /// <remarks> should be set to a value between 1 and 65535.</remarks>
         public UInt16 FileSourceId
         {
-
-            get
-            {
-
+            get
+            {
                 return CAPI.LASHeader_GetFileSourceId(hHeader);
-
-            }
-
-
-
-        }
-
-
-
-
-
-
-
-        //    /// Get value field reserved by the ASPRS LAS Specification.
-
-        //    /// \note This field is always filled with 0.
-
-
-
+            }
+            set
+            {
+
+                LASError error = CAPI.LASHeader_SetFileSourceId(hHeader, value);
+                if ((Int32)error != 0)
+                {
+                    LASException e = new LASException("Exception in Set Header SetFileSourceId.");
+                    throw e;
+                }
+
+            }
+
+        }
+
+        /// <summary>
+        /// Get value field reserved by the ASPRS LAS Specification.
+        /// </summary>
+        /// <remarks>This field is always filled with 0.</remarks>
         public Int16 Reserved
         {
-
-            get
-            {
-
+            get
+            {
                 return CAPI.LASHeader_GetReserved(hHeader);
-
-            }
-
-            //set
-
-            //{
-
-
-
-            //}
-
-        }
-
-
-
-
-
-        //Get project identifier.
-
-        //\return Global Unique Identifier as an instance of liblas::guid class.
-
+            }
+
+        }
+
+
+        /// <summary>
+        /// Get project identifier.
+        /// </summary>
+        /// <remarks>return Global Unique Identifier.</remarks>
         public String ProjectId
         {
-
-            get
-            {
-
+            get
+            {
                 return CAPI.LASHeader_GetProjectId(hHeader);
-
-            }
-
-            //set
-
-            //{
-
-            //    //    void SetProjectId(guid const& v);
-
-            //    //status = value;
-
-            //}
-
-        }
-
-
-
-
-
-
-
-
-
+            }
+        }
+
+
+
+        /// <summary>
+        /// major component of version of LAS format.
+        /// </summary>
+        /// <remarks>Always 1  as the only valid value. value between eVersionMajorMin and eVersionMajorMax (always 1).</remarks>
         public byte VersionMajor
         {
-
-            get
-            {
-
-                //Get major component of version of LAS format.
-
-                //\return Always 1 is returned as the only valid value.
-
+            get
+            {
                 return CAPI.LASHeader_GetVersionMajor(hHeader);
-
-            }
-
-            set
-            {
-
-
-
-                //Set major component of version of LAS format.
-
-                //\exception std::out_of_range - invalid value given.
-
-                //\param v - value between eVersionMajorMin and eVersionMajorMax.
+            }
+            set
+            {
 
                 LASError error = CAPI.LASHeader_SetVersionMajor(hHeader, value);
-
                 if ((Int32)error != 0)
                 {
                     LASException e = new LASException("Exception in Set Header VersionMajor.");
-
-                    throw e;
-                }
-
-
-
-            }
-
-        }
-
-
-
-
-
-
-
+                    throw e;
+                }
+
+            }
+        }
+
+
+        /// <summary>
+        /// minor component of version of LAS format.
+        /// </summary>
+        /// <remarks>Valid values are 1 or 0. value between eVersionMinorMin and eVersionMinorMax.</remarks>
         public byte VersionMinor
         {
-
-            get
-            {
-
-                //Get minor component of version of LAS format.
-
-                //\return Valid values are 1 or 0.
+            get
+            {
 
                 return CAPI.LASHeader_GetVersionMinor(hHeader);
-
-            }
-
-            set
-            {
-
-                //Set minor component of version of LAS format.
-
-                //\exception std::out_of_range - invalid value given.
-
-                //\param v - value between eVersionMinorMin and eVersionMinorMax.
+            }
+            set
+            {
 
                 LASError error = CAPI.LASHeader_SetVersionMinor(hHeader, value);
-
                 if ((Int32)error != 0)
                 {
                     LASException e = new LASException("Exception in Set Header VersionMinor.");
-
-                    throw e;
-                }
-
-            }
-
-        }
-
-
-
+                    throw e;
+                }
+            }
+        }
+
+        /// <summary>
+        /// system identifier
+        /// </summary>
+        /// <remarks>Default value is "libLAS" specified as the SystemIdentifier constant. string is padded right with spaces and its length is 32 bytes.</remarks>
         public String SystemId
         {
-
-            get
-            {
-
-                //Get system identifier.
-
-                //Default value is \b "libLAS" specified as the SystemIdentifier constant.
-
-                //\param pad - if true the returned string is padded right with spaces and