Changeset 913

Show
Ignore:
Timestamp:
10/09/08 09:28:21 (3 months ago)
Author:
mloskot
Message:

trunk/csharp: Added README file with instructions startup.

Location:
trunk/csharp
Files:
1 added
1 modified

Legend:

Unmodified
Added
Removed

  • trunk/csharp/dotnetLibLAS/dotnetLibLas.xml

    r902 r913  
    55    </assembly> 
    66    <members> 
     7        <member name="T:LibLAS.LASException"> 
     8            <summary> 
     9            LASException class 
     10            </summary> 
     11        </member> 
     12        <member name="M:LibLAS.LASException.#ctor(System.String)"> 
     13            <summary> 
     14            Default constructor 
     15            </summary> 
     16            <param name="message">string to show</param> 
     17        </member> 
     18        <member name="M:LibLAS.LASException.GetString(System.Int32)"> 
     19            <summary> 
     20            TODO 
     21            </summary> 
     22            <param name="value">TODO</param> 
     23            <returns>the string </returns> 
     24        </member> 
     25        <member name="T:LibLAS.LASVariableLengthRecord"> 
     26            <summary> 
     27            LASVariableLengthRecord class 
     28            </summary> 
     29        </member> 
     30        <member name="M:LibLAS.LASVariableLengthRecord.Dispose"> 
     31            <summary> 
     32            The object user should call this method when they finished with the object. 
     33            </summary> 
     34        </member> 
     35        <member name="M:LibLAS.LASVariableLengthRecord.#ctor"> 
     36            <summary> 
     37            Default constructor. 
     38            </summary> 
     39        </member> 
     40        <member name="M:LibLAS.LASVariableLengthRecord.#ctor(System.IntPtr)"> 
     41            <summary> 
     42            Creates a new variable length record uing the LASVLRH opaque pointer 
     43            </summary> 
     44            <param name="hVlrh">LASVLRH opaque pointer</param> 
     45        </member> 
     46        <member name="M:LibLAS.LASVariableLengthRecord.GetPointer"> 
     47            <summary> 
     48            Get the LASVLRH opaque pointer. 
     49            </summary> 
     50            <returns>LASVLRH opaque pointer </returns> 
     51        </member> 
     52        <member name="M:LibLAS.LASVariableLengthRecord.GetData(System.Byte[]@)"> 
     53            <summary> 
     54            Gets the data stream for the variable length record as an array of bytes 
     55            </summary> 
     56            <param name="data">a empty array of bytes where place the array</param> 
     57        </member> 
     58        <member name="M:LibLAS.LASVariableLengthRecord.SetData(System.Byte[]@)"> 
     59            <summary> 
     60            Sets the data stream for the variable length record as an array of bytes 
     61            </summary> 
     62            <param name="data">array of bytes</param> 
     63        </member> 
     64        <member name="P:LibLAS.LASVariableLengthRecord.UserId"> 
     65            <summary> 
     66            the User Id for the variable length record. 
     67            </summary> 
     68            <remarks> It will be clipped to fit within 16 characters</remarks> 
     69        </member> 
     70        <member name="P:LibLAS.LASVariableLengthRecord.Description"> 
     71            <summary> 
     72            the description for the variable length record. 
     73            </summary> 
     74            <remarks> It will be clipped to fit within 32 characters</remarks> 
     75        </member> 
     76        <member name="P:LibLAS.LASVariableLengthRecord.RecordLength"> 
     77            <summary> 
     78            the record length of the data stored in the variable length record. 
     79            </summary> 
     80        </member> 
     81        <member name="P:LibLAS.LASVariableLengthRecord.RecordId"> 
     82            <summary> 
     83            the record id for the variable length record. 
     84            </summary> 
     85        </member> 
     86        <member name="P:LibLAS.LASVariableLengthRecord.Reserved"> 
     87            <summary> 
     88            the reserved value of the variable length record.   
     89            </summary> 
     90            <remarks>This should be 0 and should always be 0.</remarks> 
     91        </member> 
    792        <member name="T:LibLAS.LASReadWriteMode"> 
    893            <summary> 
    … …  
    420505            Size of point record in data format \e 1 
    421506        </member> 
    422         <member name="T:LibLAS.LASPoint"> 
    423             <summary> 
    424             LASPoint class 
    425             </summary> 
    426         </member> 
    427         <member name="M:LibLAS.LASPoint.#ctor(System.IntPtr)"> 
    428             <summary> 
    429             Create a new LASPoint from the LASPointH opaque structure 
    430             </summary> 
    431             <param name="hLASPoint">LASPointH opaque structure</param> 
    432         </member> 
    433         <member name="M:LibLAS.LASPoint.#ctor"> 
    434             <summary> 
    435             Create a generic LASPoint 
    436             </summary> 
    437         </member> 
    438         <member name="M:LibLAS.LASPoint.Equals(LibLAS.LASPoint)"> 
    439             <summary> 
    440             Compare 2 LASPoint to be equal 
    441             </summary> 
    442             <param name="lasPoint">LASPoint object</param> 
    443             <returns>true if lasPoint is equals to the instance.</returns> 
    444         </member> 
    445         <member name="M:LibLAS.LASPoint.IsValid"> 
    446             <summary> 
    447             test is the LASPoint is Valid 
    448             </summary> 
    449             <returns>true is is valid</returns> 
    450         </member> 
    451         <member name="M:LibLAS.LASPoint.Dispose"> 
    452             <summary> 
    453             The object user should call this method when they finished with the object. In .NET is magaged by the GC. 
    454             </summary> 
    455         </member> 
    456         <member name="M:LibLAS.LASPoint.GetPointer"> 
    457             <summary> 
    458             gets the opaque pointer to the LASPointH instance. 
    459             </summary> 
    460             <returns>the opaque pointer to the LASPointH instance</returns> 
    461         </member> 
    462         <member name="M:LibLAS.LASPoint.Copy"> 
    463             <summary> 
    464             Copy a LASPoint object creating a new one. 
    465             </summary> 
    466             <returns>a new LASPoint instance copied.</returns> 
    467         </member> 
    468         <member name="M:LibLAS.LASPoint.Validate"> 
    469              <summary> 
    470              
    471              </summary> 
    472              <returns></returns> 
    473         </member> 
    474         <member name="P:LibLAS.LASPoint.X"> 
    475             <summary> 
    476             X value for the point. 
    477             </summary> 
    478             <remarks>This value must be scaled or offset by any header values before being set.</remarks> 
    479         </member> 
    480         <member name="P:LibLAS.LASPoint.Y"> 
    481             <summary> 
    482             Y value for the point. 
    483             </summary> 
    484             <remarks>This value must be scaled or offset by any header values before being set.</remarks> 
    485         </member> 
    486         <member name="P:LibLAS.LASPoint.Z"> 
    487             <summary> 
    488             Z value for the point. 
    489             </summary> 
    490             <remarks>This value must be scaled or offset by any header values before being set.</remarks> 
    491              
    492         </member> 
    493         <member name="P:LibLAS.LASPoint.Intensity"> 
    494             <summary> 
    495              intensity value for the point. 
    496             </summary> 
    497             <remarks>This value is the pulse return magnitude, it is optional, and it is LiDAR system specific.  
    498             </remarks> 
    499         </member> 
    500         <member name="P:LibLAS.LASPoint.ScanFlags"> 
    501             <summary> 
    502              scan flags for the point -- Return number, number of returns, flightline edge, scan direction, and scan angle rank. 
    503             </summary> 
    504             <remarks></remarks> 
    505         </member> 
    506         <member name="P:LibLAS.LASPoint.ReturnNumber"> 
    507             <summary> 
    508              return number for the point. 
    509             </summary> 
    510             <remarks>The return number is "the pulse return number for a given output pulse."  The first return number starts with the value 1. valid from 1 to 6.</remarks> 
    511         </member> 
    512         <member name="P:LibLAS.LASPoint.NumberOfReturns"> 
    513             <summary> 
    514              total number of returns for a given pulse. 
    515             </summary> 
    516             <remarks>Valid values are from 1-5. </remarks> 
    517         </member> 
    518         <member name="P:LibLAS.LASPoint.ScanDirection"> 
    519             <summary> 
    520             scan direction for a given pulse. 
    521             </summary> 
    522             <remarks>Valid values are 0 or 1, with 1 being a positive scan direction and 0 being a negative scan direction.</remarks> 
    523         </member> 
    524         <member name="P:LibLAS.LASPoint.FlightLineEdge"> 
    525             <summary> 
    526             whether or not a given pulse is an edge point. 
    527             </summary> 
    528             <remarks>Valid values are 0 or 1, with 1 being an edge point and 0 being interior.</remarks> 
    529         </member> 
    530         <member name="P:LibLAS.LASPoint.Classification"> 
    531             <summary> 
    532             classification for the point. 
    533             </summary> 
    534         </member> 
    535         <member name="P:LibLAS.LASPoint.ScanAngleRank"> 
    536             <summary> 
    537             the scan angle for the point. 
    538             </summary> 
    539         </member> 
    540         <member name="P:LibLAS.LASPoint.UserData"> 
    541             <summary> 
    542             arbitrary user data for the point. 
    543             </summary> 
    544         </member> 
    545         <member name="P:LibLAS.LASPoint.Time"> 
    546             <summary> 
    547              time for the point. 
    548             </summary> 
    549         </member> 
    550         <member name="T:LibLAS.LASPoint.DataMemberFlag"> 
    551             <summary> 
    552             Returns a bitfield representing the validity of various members. 
    553             </summary> 
    554         </member> 
    555         <member name="F:LibLAS.LASPoint.DataMemberFlag.eReturnNumber"> 
    556             <summary> 
    557             ReturnNumber property flag. 
    558             </summary> 
    559         </member> 
    560         <member name="F:LibLAS.LASPoint.DataMemberFlag.eNumberOfReturns"> 
    561             <summary> 
    562             NumberOfReturns property flag. 
    563             </summary> 
    564         </member> 
    565         <member name="F:LibLAS.LASPoint.DataMemberFlag.eScanDirection"> 
    566             <summary> 
    567             ScanDirection property flag. 
    568             </summary> 
    569         </member> 
    570         <member name="F:LibLAS.LASPoint.DataMemberFlag.eFlightLineEdge"> 
    571             <summary> 
    572             FlightLineEdge property flag. 
    573             </summary> 
    574         </member> 
    575         <member name="F:LibLAS.LASPoint.DataMemberFlag.eClassification"> 
    576             <summary> 
    577             Classification property flag. 
    578             </summary> 
    579         </member> 
    580         <member name="F:LibLAS.LASPoint.DataMemberFlag.eScanAngleRank"> 
    581             <summary> 
    582             ScanAngleRank property flag. 
    583             </summary> 
    584         </member> 
    585         <member name="F:LibLAS.LASPoint.DataMemberFlag.eTime"> 
    586             <summary> 
    587             Time property flag. 
    588             </summary> 
    589         </member> 
    590507        <member name="T:LibLAS.LASGuid"> 
    591508            <summary> 
    … …  
    652569            Returns the version string for this library. 
    653570            @return the version string for this library. 
     571             
     572            If libLAS is built using solution from trunk/build/msvc80/liblas.sln 
     573            then C API DLL is called liblas_c_dll.dll, so value of the constant below 
     574            should be updated to "liblas_c_dll.dll". 
    654575        </member> 
    655576        <member name="M:LibLAS.CAPI.LASError_Reset"> 
    … …  
    13461267            @return LASErrorEnum 
    13471268        </member> 
    1348         <member name="T:LibLAS.LASException"> 
    1349             <summary> 
    1350             LASException class 
    1351             </summary> 
    1352         </member> 
    1353         <member name="M:LibLAS.LASException.#ctor(System.String)"> 
    1354             <summary> 
    1355             Default constructor 
    1356             </summary> 
    1357             <param name="message">string to show</param> 
    1358         </member> 
    1359         <member name="M:LibLAS.LASException.GetString(System.Int32)"> 
    1360             <summary> 
    1361             TODO 
    1362             </summary> 
    1363             <param name="value">TODO</param> 
    1364             <returns>the string </returns> 
    1365         </member> 
    1366         <member name="T:LibLAS.LASVariableLengthRecord"> 
    1367             <summary> 
    1368             LASVariableLengthRecord class 
    1369             </summary> 
    1370         </member> 
    1371         <member name="M:LibLAS.LASVariableLengthRecord.Dispose"> 
    1372             <summary> 
    1373             The object user should call this method when they finished with the object. 
    1374             </summary> 
    1375         </member> 
    1376         <member name="M:LibLAS.LASVariableLengthRecord.#ctor"> 
    1377             <summary> 
    1378             Default constructor. 
    1379             </summary> 
    1380         </member> 
    1381         <member name="M:LibLAS.LASVariableLengthRecord.#ctor(System.IntPtr)"> 
    1382             <summary> 
    1383             Creates a new variable length record uing the LASVLRH opaque pointer 
    1384             </summary> 
    1385             <param name="hVlrh">LASVLRH opaque pointer</param> 
    1386         </member> 
    1387         <member name="M:LibLAS.LASVariableLengthRecord.GetPointer"> 
    1388             <summary> 
    1389             Get the LASVLRH opaque pointer. 
    1390             </summary> 
    1391             <returns>LASVLRH opaque pointer </returns> 
    1392         </member> 
    1393         <member name="M:LibLAS.LASVariableLengthRecord.GetData(System.Byte[]@)"> 
    1394             <summary> 
    1395             Gets the data stream for the variable length record as an array of bytes 
    1396             </summary> 
    1397             <param name="data">a empty array of bytes where place the array</param> 
    1398         </member> 
    1399         <member name="M:LibLAS.LASVariableLengthRecord.SetData(System.Byte[]@)"> 
    1400             <summary> 
    1401             Sets the data stream for the variable length record as an array of bytes 
    1402             </summary> 
    1403             <param name="data">array of bytes</param> 
    1404         </member> 
    1405         <member name="P:LibLAS.LASVariableLengthRecord.UserId"> 
    1406             <summary> 
    1407             the User Id for the variable length record. 
    1408             </summary> 
    1409             <remarks> It will be clipped to fit within 16 characters</remarks> 
    1410         </member> 
    1411         <member name="P:LibLAS.LASVariableLengthRecord.Description"> 
    1412             <summary> 
    1413             the description for the variable length record. 
    1414             </summary> 
    1415             <remarks> It will be clipped to fit within 32 characters</remarks> 
    1416         </member> 
    1417         <member name="P:LibLAS.LASVariableLengthRecord.RecordLength"> 
    1418             <summary> 
    1419             the record length of the data stored in the variable length record. 
    1420             </summary> 
    1421         </member> 
    1422         <member name="P:LibLAS.LASVariableLengthRecord.RecordId"> 
    1423             <summary> 
    1424             the record id for the variable length record. 
    1425             </summary> 
    1426         </member> 
    1427         <member name="P:LibLAS.LASVariableLengthRecord.Reserved"> 
    1428             <summary> 
    1429             the reserved value of the variable length record.   
    1430             </summary> 
    1431             <remarks>This should be 0 and should always be 0.</remarks> 
     1269        <member name="T:LibLAS.LASPoint"> 
     1270            <summary> 
     1271            LASPoint class 
     1272            </summary> 
     1273        </member> 
     1274        <member name="M:LibLAS.LASPoint.#ctor(System.IntPtr)"> 
     1275            <summary> 
     1276            Create a new LASPoint from the LASPointH opaque structure 
     1277            </summary> 
     1278            <param name="hLASPoint">LASPointH opaque structure</param> 
     1279        </member> 
     1280        <member name="M:LibLAS.LASPoint.#ctor"> 
     1281            <summary> 
     1282            Create a generic LASPoint 
     1283            </summary> 
     1284        </member> 
     1285        <member name="M:LibLAS.LASPoint.Equals(LibLAS.LASPoint)"> 
     1286            <summary> 
     1287            Compare 2 LASPoint to be equal 
     1288            </summary> 
     1289            <param name="lasPoint">LASPoint object</param> 
     1290            <returns>true if lasPoint is equals to the instance.</returns> 
     1291        </member> 
     1292        <member name="M:LibLAS.LASPoint.IsValid"> 
     1293            <summary> 
     1294            test is the LASPoint is Valid 
     1295            </summary> 
     1296            <returns>true is is valid</returns> 
     1297        </member> 
     1298        <member name="M:LibLAS.LASPoint.Dispose"> 
     1299            <summary> 
     1300            The object user should call this method when they finished with the object. In .NET is magaged by the GC. 
     1301            </summary> 
     1302        </member> 
     1303        <member name="M:LibLAS.LASPoint.GetPointer"> 
     1304            <summary> 
     1305            gets the opaque pointer to the LASPointH instance. 
     1306            </summary> 
     1307            <returns>the opaque pointer to the LASPointH instance</returns> 
     1308        </member> 
     1309        <member name="M:LibLAS.LASPoint.Copy"> 
     1310            <summary> 
     1311            Copy a LASPoint object creating a new one. 
     1312            </summary> 
     1313            <returns>a new LASPoint instance copied.</returns> 
     1314        </member> 
     1315        <member name="M:LibLAS.LASPoint.Validate"> 
     1316             <summary> 
     1317             
     1318             </summary> 
     1319             <returns></returns> 
     1320        </member> 
     1321        <member name="P:LibLAS.LASPoint.X"> 
     1322            <summary> 
     1323            X value for the point. 
     1324            </summary> 
     1325            <remarks>This value must be scaled or offset by any header values before being set.</remarks> 
     1326        </member> 
     1327        <member name="P:LibLAS.LASPoint.Y"> 
     1328            <summary> 
     1329            Y value for the point. 
     1330            </summary> 
     1331            <remarks>This value must be scaled or offset by any header values before being set.</remarks> 
     1332        </member> 
     1333        <member name="P:LibLAS.LASPoint.Z"> 
     1334            <summary> 
     1335            Z value for the point. 
     1336            </summary> 
     1337            <remarks>This value must be scaled or offset by any header values before being set.</remarks> 
     1338             
     1339        </member> 
     1340        <member name="P:LibLAS.LASPoint.Intensity"> 
     1341            <summary> 
     1342             intensity value for the point. 
     1343            </summary> 
     1344            <remarks>This value is the pulse return magnitude, it is optional, and it is LiDAR system specific.  
     1345            </remarks> 
     1346        </member> 
     1347        <member name="P:LibLAS.LASPoint.ScanFlags"> 
     1348            <summary> 
     1349             scan flags for the point -- Return number, number of returns, flightline edge, scan direction, and scan angle rank. 
     1350            </summary> 
     1351            <remarks></remarks> 
     1352        </member> 
     1353        <member name="P:LibLAS.LASPoint.ReturnNumber"> 
     1354            <summary> 
     1355             return number for the point. 
     1356            </summary> 
     1357            <remarks>The return number is "the pulse return number for a given output pulse."  The first return number starts with the value 1. valid from 1 to 6.</remarks> 
     1358        </member> 
     1359        <member name="P:LibLAS.LASPoint.NumberOfReturns"> 
     1360            <summary> 
     1361             total number of returns for a given pulse. 
     1362            </summary> 
     1363            <remarks>Valid values are from 1-5. </remarks> 
     1364        </member> 
     1365        <member name="P:LibLAS.LASPoint.ScanDirection"> 
     1366            <summary> 
     1367            scan direction for a given pulse. 
     1368            </summary> 
     1369            <remarks>Valid values are 0 or 1, with 1 being a positive scan direction and 0 being a negative scan direction.</remarks> 
     1370        </member> 
     1371        <member name="P:LibLAS.LASPoint.FlightLineEdge"> 
     1372            <summary> 
     1373            whether or not a given pulse is an edge point. 
     1374            </summary> 
     1375            <remarks>Valid values are 0 or 1, with 1 being an edge point and 0 being interior.</remarks> 
     1376        </member> 
     1377        <member name="P:LibLAS.LASPoint.Classification"> 
     1378            <summary> 
     1379            classification for the point. 
     1380            </summary> 
     1381        </member> 
     1382        <member name="P:LibLAS.LASPoint.ScanAngleRank"> 
     1383            <summary> 
     1384            the scan angle for the point. 
     1385            </summary> 
     1386        </member> 
     1387        <member name="P:LibLAS.LASPoint.UserData"> 
     1388            <summary> 
     1389            arbitrary user data for the point. 
     1390            </summary> 
     1391        </member> 
     1392        <member name="P:LibLAS.LASPoint.Time"> 
     1393            <summary> 
     1394             time for the point. 
     1395            </summary> 
     1396        </member> 
     1397        <member name="T:LibLAS.LASPoint.DataMemberFlag"> 
     1398            <summary> 
     1399            Returns a bitfield representing the validity of various members. 
     1400            </summary> 
     1401        </member> 
     1402        <member name="F:LibLAS.LASPoint.DataMemberFlag.eReturnNumber"> 
     1403            <summary> 
     1404            ReturnNumber property flag. 
     1405            </summary> 
     1406        </member> 
     1407        <member name="F:LibLAS.LASPoint.DataMemberFlag.eNumberOfReturns"> 
     1408            <summary> 
     1409            NumberOfReturns property flag. 
     1410            </summary> 
     1411        </member> 
     1412        <member name="F:LibLAS.LASPoint.DataMemberFlag.eScanDirection"> 
     1413            <summary> 
     1414            ScanDirection property flag. 
     1415            </summary> 
     1416        </member> 
     1417        <member name="F:LibLAS.LASPoint.DataMemberFlag.eFlightLineEdge"> 
     1418            <summary> 
     1419            FlightLineEdge property flag. 
     1420            </summary> 
     1421        </member> 
     1422        <member name="F:LibLAS.LASPoint.DataMemberFlag.eClassification"> 
     1423            <summary> 
     1424            Classification property flag. 
     1425            </summary> 
     1426        </member> 
     1427        <member name="F:LibLAS.LASPoint.DataMemberFlag.eScanAngleRank"> 
     1428            <summary> 
     1429            ScanAngleRank property flag. 
     1430            </summary> 
     1431        </member> 
     1432        <member name="F:LibLAS.LASPoint.DataMemberFlag.eTime"> 
     1433            <summary> 
     1434            Time property flag. 
     1435            </summary> 
    14321436        </member> 
    14331437    </members>