<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>CCfits: Table.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="files.html"><span>File List</span></a></li> </ul> </div> <h1>Table.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Read the documentation to learn more about C++ code generator</span> <a name="l00002"></a>00002 <span class="comment">// versioning.</span> <a name="l00003"></a>00003 <span class="comment">// This is version 2.2 release dated Sep 2009</span> <a name="l00004"></a>00004 <span class="comment">// Astrophysics Science Division,</span> <a name="l00005"></a>00005 <span class="comment">// NASA/ Goddard Space Flight Center</span> <a name="l00006"></a>00006 <span class="comment">// HEASARC</span> <a name="l00007"></a>00007 <span class="comment">// http://heasarc.gsfc.nasa.gov</span> <a name="l00008"></a>00008 <span class="comment">// e-mail: ccfits@legacy.gsfc.nasa.gov</span> <a name="l00009"></a>00009 <span class="comment">//</span> <a name="l00010"></a>00010 <span class="comment">// Original author: Ben Dorman</span> <a name="l00011"></a>00011 <a name="l00012"></a>00012 <span class="preprocessor">#ifndef TABLE_H</span> <a name="l00013"></a>00013 <span class="preprocessor"></span><span class="preprocessor">#define TABLE_H 1</span> <a name="l00014"></a>00014 <span class="preprocessor"></span> <a name="l00015"></a>00015 <span class="comment">// ExtHDU</span> <a name="l00016"></a>00016 <span class="preprocessor">#include "ExtHDU.h"</span> <a name="l00017"></a>00017 <span class="comment">// FitsError</span> <a name="l00018"></a>00018 <span class="preprocessor">#include "FitsError.h"</span> <a name="l00019"></a>00019 <a name="l00020"></a>00020 <span class="keyword">namespace </span>CCfits { <a name="l00021"></a>00021 <span class="keyword">class </span>Column; <a name="l00022"></a>00022 <a name="l00023"></a>00023 } <span class="comment">// namespace CCfits</span> <a name="l00024"></a>00024 <a name="l00025"></a>00025 <span class="preprocessor">#ifdef _MSC_VER</span> <a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#include "MSconfig.h"</span> <span class="comment">// for truncation warning</span> <a name="l00027"></a>00027 <span class="preprocessor">#endif</span> <a name="l00028"></a>00028 <span class="preprocessor"></span> <a name="l00029"></a>00029 <span class="preprocessor">#ifdef HAVE_CONFIG_H</span> <a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#include "config.h"</span> <a name="l00031"></a>00031 <span class="preprocessor">#endif</span> <a name="l00032"></a>00032 <span class="preprocessor"></span> <a name="l00033"></a>00033 <span class="preprocessor">#ifdef SSTREAM_DEFECT</span> <a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#include <strstream></span> <a name="l00035"></a>00035 <span class="preprocessor">#else</span> <a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#include <sstream></span> <a name="l00037"></a>00037 <span class="preprocessor">#endif</span> <a name="l00038"></a>00038 <span class="preprocessor"></span> <a name="l00039"></a>00039 <a name="l00040"></a>00040 <span class="keyword">namespace </span>CCfits { <a name="l00041"></a>00041 <a name="l00283"></a><a class="code" href="classCCfits_1_1Table.html">00283</a> <span class="keyword">class </span><a class="code" href="classCCfits_1_1Table.html">Table</a> : <span class="keyword">public</span> <a class="code" href="classCCfits_1_1ExtHDU.html" title="base class for all FITS extension HDUs, i.e. Image Extensions and Tables.">ExtHDU</a> <span class="comment">//## Inherits: <unnamed>%3804A126EB10</span> <a name="l00284"></a>00284 { <a name="l00285"></a>00285 <a name="l00286"></a>00286 <span class="keyword">public</span>: <a name="l00287"></a>00287 <a name="l00288"></a>00288 <a name="l00289"></a>00289 <a name="l00290"></a><a class="code" href="classCCfits_1_1Table_1_1NoSuchColumn.html">00290</a> <span class="keyword">class </span><a class="code" href="classCCfits_1_1Table_1_1NoSuchColumn.html" title="Exception to be thrown on a failure to retrieve a column specified either by name...">NoSuchColumn</a> : <span class="keyword">public</span> <a class="code" href="classCCfits_1_1FitsException.html" title="FitsException is the base class for all exceptions thrown by this library.">FitsException</a> <span class="comment">//## Inherits: <unnamed>%397CB0970174</span> <a name="l00291"></a>00291 { <a name="l00292"></a>00292 <span class="keyword">public</span>: <a name="l00293"></a>00293 <a class="code" href="classCCfits_1_1Table_1_1NoSuchColumn.html#a5f21d893d831bb74eff8703b3c6d0b1e" title="Exception ctor for exception thrown if the requested column (specified by name) is...">NoSuchColumn</a> (<span class="keyword">const</span> String& <a class="code" href="classCCfits_1_1ExtHDU.html#af1128c49f0381473feff2cd9e5650dce" title="return the name of the extension.">name</a>, <span class="keywordtype">bool</span> silent = <span class="keyword">true</span>); <a name="l00294"></a>00294 <a class="code" href="classCCfits_1_1Table_1_1NoSuchColumn.html#a5f21d893d831bb74eff8703b3c6d0b1e" title="Exception ctor for exception thrown if the requested column (specified by name) is...">NoSuchColumn</a> (<span class="keywordtype">int</span> <a class="code" href="classCCfits_1_1HDU.html#a111434a1e35e2453237f86b30b3f4a8d" title="return the HDU number">index</a>, <span class="keywordtype">bool</span> silent = <span class="keyword">true</span>); <a name="l00295"></a>00295 <a name="l00296"></a>00296 <span class="keyword">protected</span>: <a name="l00297"></a>00297 <span class="keyword">private</span>: <a name="l00298"></a>00298 <span class="keyword">private</span>: <span class="comment">//## implementation</span> <a name="l00299"></a>00299 }; <a name="l00300"></a>00300 <a name="l00301"></a>00301 <a name="l00302"></a>00302 <a name="l00303"></a>00303 <span class="keyword">class </span>InvalidColumnSpecification : <span class="keyword">public</span> <a class="code" href="classCCfits_1_1FitsException.html" title="FitsException is the base class for all exceptions thrown by this library.">FitsException</a> <span class="comment">//## Inherits: <unnamed>%3B1E52D703B0</span> <a name="l00304"></a>00304 { <a name="l00305"></a>00305 <span class="keyword">public</span>: <a name="l00306"></a>00306 InvalidColumnSpecification (<span class="keyword">const</span> String& msg, <span class="keywordtype">bool</span> silent = <span class="keyword">true</span>); <a name="l00307"></a>00307 <a name="l00308"></a>00308 <span class="keyword">protected</span>: <a name="l00309"></a>00309 <span class="keyword">private</span>: <a name="l00310"></a>00310 <span class="keyword">private</span>: <span class="comment">//## implementation</span> <a name="l00311"></a>00311 }; <a name="l00312"></a>00312 <a class="code" href="classCCfits_1_1Table.html#a0b1f880e7bb883a2b05ee20909d94fbf" title="copy constructor">Table</a>(<span class="keyword">const</span> <a class="code" href="classCCfits_1_1Table.html">Table</a> &right); <a name="l00313"></a>00313 <span class="keyword">virtual</span> <a class="code" href="classCCfits_1_1Table.html#a933afd64667d8ad6a7291686ca3d8603" title="destructor">~Table</a>(); <a name="l00314"></a>00314 <a name="l00315"></a>00315 <span class="comment">// ! return reference to a column given by column name.</span> <a name="l00316"></a>00316 <span class="keyword">virtual</span> <a class="code" href="classCCfits_1_1Column.html" title="Abstract base class for Column objects.">Column</a>& <a class="code" href="classCCfits_1_1Table.html#a573b295bfdd242a99d97d0d3a1dd4982" title="return a reference to the array containing the columns.">column</a> (<span class="keyword">const</span> String& colName, <span class="keywordtype">bool</span> caseSensitive = <span class="keyword">true</span>) <span class="keyword">const</span>; <a name="l00317"></a>00317 <span class="keyword">virtual</span> <a class="code" href="classCCfits_1_1Column.html" title="Abstract base class for Column objects.">Column</a>& <a class="code" href="classCCfits_1_1Table.html#a573b295bfdd242a99d97d0d3a1dd4982" title="return a reference to the array containing the columns.">column</a> (<span class="keywordtype">int</span> colIndex <span class="comment">// ! return reference to a column given by a column index number</span> <a name="l00318"></a>00318 ) <span class="keyword">const</span>; <a name="l00319"></a>00319 <span class="keyword">virtual</span> <span class="keywordtype">long</span> <a class="code" href="classCCfits_1_1Table.html#a63b3ceb651637d7e73fd4a787b136450" title="return the number of rows in the table (NAXIS2).">rows</a> () <span class="keyword">const</span>; <a name="l00320"></a>00320 <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Table.html#aa610c082528ac5ed89b715e3f3b2e4e6" title="update the number of rows in the table">updateRows</a> (); <a name="l00321"></a>00321 <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Table.html#a63b3ceb651637d7e73fd4a787b136450" title="return the number of rows in the table (NAXIS2).">rows</a> (<span class="keywordtype">long</span> numRows); <a name="l00322"></a>00322 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Table.html#a19bde9d4a37a2ee07016ef627e5fecde" title="delete a column in a Table extension by name.">deleteColumn</a> (<span class="keyword">const</span> String& columnName); <a name="l00323"></a>00323 <span class="comment">// Insert one or more blank rows into a FITS column.</span> <a name="l00324"></a>00324 <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Table.html#a470beae464348ac917729b0d1d693ba0" title="insert empty rows into the table">insertRows</a> (<span class="keywordtype">long</span> first, <span class="keywordtype">long</span> number = 1); <a name="l00325"></a>00325 <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Table.html#aa89bbe572a86b8bc4ca4249ba0b21dbb" title="delete a range of rows in a table.">deleteRows</a> (<span class="keywordtype">long</span> first, <span class="keywordtype">long</span> number = 1); <a name="l00326"></a>00326 <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Table.html#aa89bbe572a86b8bc4ca4249ba0b21dbb" title="delete a range of rows in a table.">deleteRows</a> (<span class="keyword">const</span> std::vector<long>& rowList); <a name="l00327"></a>00327 <span class="keyword">virtual</span> <span class="keywordtype">long</span> <a class="code" href="classCCfits_1_1Table.html#a54e2948a7603a058c6a3cd99f0806ac9" title="return the optimal number of rows to read or write at a time">getRowsize</a> () <span class="keyword">const</span>; <a name="l00328"></a>00328 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classCCfits_1_1Table.html#a7a10118f8f79786fa1c8813e2e838076" title="return the number of Columns in the Table (the TFIELDS keyword).">numCols</a> () <span class="keyword">const</span>; <a name="l00329"></a>00329 <span class="keyword">virtual</span> <span class="keyword">const</span> std::map<string, Column*>& <a class="code" href="classCCfits_1_1Table.html#a573b295bfdd242a99d97d0d3a1dd4982" title="return a reference to the array containing the columns.">column</a> () <span class="keyword">const</span>; <a name="l00330"></a>00330 <span class="keyword">virtual</span> std::map<string, Column*>& <a class="code" href="classCCfits_1_1Table.html#a573b295bfdd242a99d97d0d3a1dd4982" title="return a reference to the array containing the columns.">column</a> (); <a name="l00331"></a>00331 <a name="l00332"></a>00332 <span class="keyword">public</span>: <a name="l00333"></a>00333 <span class="comment">// Additional Public Declarations</span> <a name="l00334"></a>00334 <a name="l00335"></a>00335 <span class="keyword">protected</span>: <a name="l00336"></a>00336 <a class="code" href="classCCfits_1_1Table.html#a0b1f880e7bb883a2b05ee20909d94fbf" title="copy constructor">Table</a> (FITSBase* p, HduType xtype, <span class="keyword">const</span> String &hduName, <span class="keywordtype">int</span> <a class="code" href="classCCfits_1_1Table.html#a63b3ceb651637d7e73fd4a787b136450" title="return the number of rows in the table (NAXIS2).">rows</a>, <span class="comment">// ! Number of rows in table at creation, to be used to initialize NAXIS2</span> <a name="l00337"></a>00337 <span class="keyword">const</span> std::vector<String>& columnName, <span class="keyword">const</span> std::vector<String>& columnFmt, <span class="keyword">const</span> std::vector<String>& columnUnit = std::vector<String>(), <span class="keywordtype">int</span> <a class="code" href="classCCfits_1_1ExtHDU.html#a5e2785377c404f05dc948db844c6eec7" title="return the extension version number.">version</a> = 1); <a name="l00338"></a>00338 <span class="comment">// To be called by reading operations.</span> <a name="l00339"></a>00339 <a class="code" href="classCCfits_1_1Table.html#a0b1f880e7bb883a2b05ee20909d94fbf" title="copy constructor">Table</a> (FITSBase* p, HduType xtype, <span class="keyword">const</span> String &hduName = String(<span class="stringliteral">""</span>), <span class="keywordtype">int</span> <a class="code" href="classCCfits_1_1ExtHDU.html#a5e2785377c404f05dc948db844c6eec7" title="return the extension version number.">version</a> = 1); <a name="l00340"></a>00340 <span class="comment">// ExtHDU constructor for getting ExtHDUs by number.</span> <a name="l00341"></a>00341 <span class="comment">// Necessary since EXTNAME is a reserved not required</span> <a name="l00342"></a>00342 <span class="comment">// keyword.</span> <a name="l00343"></a>00343 <a class="code" href="classCCfits_1_1Table.html#a0b1f880e7bb883a2b05ee20909d94fbf" title="copy constructor">Table</a> (FITSBase* p, HduType xtype, <span class="keywordtype">int</span> number); <a name="l00344"></a>00344 <a name="l00345"></a>00345 <span class="keyword">virtual</span> std::ostream & put (std::ostream &s) <span class="keyword">const</span>; <a name="l00346"></a>00346 <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Table.html#a573b295bfdd242a99d97d0d3a1dd4982" title="return a reference to the array containing the columns.">column</a> (<span class="keywordtype">int</span> columnNum, <a class="code" href="classCCfits_1_1Column.html" title="Abstract base class for Column objects.">Column</a> *value); <a name="l00347"></a>00347 <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Table.html#ab5ade7dd546fe55f2c0e1f5ff7e0eddf">init</a> (<span class="keywordtype">bool</span> readFlag = <span class="keyword">false</span>, <span class="keyword">const</span> std::vector<String>& keys = std::vector<String>()); <a name="l00348"></a>00348 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Table.html#adcf7114a5828d38b35e1732618716c35" title="set the column with name colname to the input value.">setColumn</a> (<span class="keyword">const</span> String& colname, <a class="code" href="classCCfits_1_1Column.html" title="Abstract base class for Column objects.">Column</a>* value); <a name="l00349"></a>00349 <span class="keywordtype">void</span> reindex (); <a name="l00350"></a>00350 <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Table.html#a7a10118f8f79786fa1c8813e2e838076" title="return the number of Columns in the Table (the TFIELDS keyword).">numCols</a> (<span class="keywordtype">int</span> value); <a name="l00351"></a>00351 <a name="l00352"></a>00352 <span class="comment">// Additional Protected Declarations</span> <a name="l00353"></a>00353 <a name="l00354"></a>00354 <span class="keyword">private</span>: <a name="l00355"></a>00355 <span class="keyword">virtual</span> <span class="keywordtype">void</span> initRead (); <a name="l00356"></a>00356 <span class="keyword">virtual</span> <span class="keywordtype">void</span> readTableHeader (<span class="keywordtype">int</span> ncols, std::vector<String>& colName, std::vector<String>& colFmt, std::vector<String>& colUnit) = 0; <a name="l00357"></a>00357 <span class="comment">// deep erasure , to be called by assignment and dtors.</span> <a name="l00358"></a>00358 <span class="keywordtype">void</span> clearData (); <a name="l00359"></a>00359 <span class="keywordtype">void</span> copyData (<span class="keyword">const</span> <a class="code" href="classCCfits_1_1Table.html">Table</a>& right); <a name="l00360"></a>00360 <a name="l00361"></a>00361 <span class="comment">// Additional Private Declarations</span> <a name="l00362"></a>00362 <a name="l00363"></a>00363 <span class="keyword">private</span>: <span class="comment">//## implementation</span> <a name="l00364"></a>00364 <span class="comment">// Data Members for Class Attributes</span> <a name="l00365"></a>00365 <span class="keywordtype">int</span> m_numCols; <a name="l00366"></a>00366 <a name="l00367"></a>00367 <span class="comment">// Data Members for Associations</span> <a name="l00368"></a>00368 std::map<string, Column*> m_column; <a name="l00369"></a>00369 <a name="l00370"></a>00370 <span class="comment">// Additional Implementation Declarations</span> <a name="l00371"></a>00371 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classCCfits_1_1Column.html" title="Abstract base class for Column objects.">Column</a>; <a name="l00372"></a>00372 }; <a name="l00373"></a>00373 <a name="l00374"></a>00374 <span class="comment">// Class CCfits::Table::NoSuchColumn </span> <a name="l00375"></a>00375 <a name="l00376"></a>00376 <span class="comment">// Class CCfits::Table::InvalidColumnSpecification </span> <a name="l00377"></a>00377 <a name="l00378"></a>00378 <span class="comment">// Class CCfits::Table </span> <a name="l00379"></a>00379 <a name="l00380"></a><a class="code" href="classCCfits_1_1Table.html#a63b3ceb651637d7e73fd4a787b136450">00380</a> <span class="keyword">inline</span> <span class="keywordtype">long</span> <a class="code" href="classCCfits_1_1Table.html#a63b3ceb651637d7e73fd4a787b136450" title="return the number of rows in the table (NAXIS2).">Table::rows</a> ()<span class="keyword"> const</span> <a name="l00381"></a>00381 <span class="keyword"> </span>{ <a name="l00382"></a>00382 <a name="l00383"></a>00383 <span class="keywordflow">return</span> <a class="code" href="classCCfits_1_1HDU.html#a9e19372a1a01046420c6ba4393bb5674" title="return the size of axis numbered index [zero based].">axis</a>(1); <a name="l00384"></a>00384 } <a name="l00385"></a>00385 <a name="l00386"></a><a class="code" href="classCCfits_1_1Table.html#aaf11d6f4b77aa533bd09562edcea4c10">00386</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Table.html#a63b3ceb651637d7e73fd4a787b136450" title="return the number of rows in the table (NAXIS2).">Table::rows</a> (<span class="keywordtype">long</span> numRows) <a name="l00387"></a>00387 { <a name="l00388"></a>00388 <a name="l00389"></a>00389 <a class="code" href="classCCfits_1_1HDU.html#a2e02db0df89451736c7863963170a081" title="return the HDU data axis array.">naxes</a>(1) = numRows; <a name="l00390"></a>00390 } <a name="l00391"></a>00391 <a name="l00392"></a><a class="code" href="classCCfits_1_1Table.html#a7a10118f8f79786fa1c8813e2e838076">00392</a> <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="classCCfits_1_1Table.html#a7a10118f8f79786fa1c8813e2e838076" title="return the number of Columns in the Table (the TFIELDS keyword).">Table::numCols</a> ()<span class="keyword"> const</span> <a name="l00393"></a>00393 <span class="keyword"> </span>{ <a name="l00394"></a>00394 <span class="keywordflow">return</span> m_numCols; <a name="l00395"></a>00395 } <a name="l00396"></a>00396 <a name="l00397"></a><a class="code" href="classCCfits_1_1Table.html#a573b295bfdd242a99d97d0d3a1dd4982">00397</a> <span class="keyword">inline</span> <span class="keyword">const</span> std::map<string, Column*>& <a class="code" href="classCCfits_1_1Table.html#a573b295bfdd242a99d97d0d3a1dd4982" title="return a reference to the array containing the columns.">Table::column</a> ()<span class="keyword"> const</span> <a name="l00398"></a>00398 <span class="keyword"> </span>{ <a name="l00399"></a>00399 <span class="keywordflow">return</span> m_column; <a name="l00400"></a>00400 } <a name="l00401"></a>00401 <a name="l00402"></a><a class="code" href="classCCfits_1_1Table.html#a7a9b5c4231233847904f841d023978a5">00402</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Table.html#a7a10118f8f79786fa1c8813e2e838076" title="return the number of Columns in the Table (the TFIELDS keyword).">Table::numCols</a> (<span class="keywordtype">int</span> value) <a name="l00403"></a>00403 { <a name="l00404"></a>00404 m_numCols = value; <a name="l00405"></a>00405 } <a name="l00406"></a>00406 <a name="l00407"></a><a class="code" href="classCCfits_1_1Table.html#ac41ac8e02386d095a969142b486d3890">00407</a> <span class="keyword">inline</span> std::map<string, Column*>& <a class="code" href="classCCfits_1_1Table.html#a573b295bfdd242a99d97d0d3a1dd4982" title="return a reference to the array containing the columns.">Table::column</a> () <a name="l00408"></a>00408 { <a name="l00409"></a>00409 <span class="keywordflow">return</span> m_column; <a name="l00410"></a>00410 } <a name="l00411"></a>00411 <a name="l00412"></a>00412 } <span class="comment">// namespace CCfits</span> <a name="l00413"></a>00413 <a name="l00414"></a>00414 <a name="l00415"></a>00415 <span class="preprocessor">#endif</span> </pre></div></div> <hr size="1"/><address style="text-align: right;"><small>Generated on Wed Sep 9 11:59:41 2009 for CCfits by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> </body> </html>