Sophie

Sophie

distrib > Fedora > 13 > i386 > media > os > by-pkgid > ecbd8c5b7568e331fe6ea5b9a07a78a0 > files > 24

CCfits-docs-2.2-2.fc13.noarch.rpm

<!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: Keyword.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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
    </ul>
  </div>
<h1>Keyword.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 KEYWORD_H</span>
<a name="l00013"></a>00013 <span class="preprocessor"></span><span class="preprocessor">#define KEYWORD_H 1</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span><span class="preprocessor">#include &quot;CCfits.h&quot;</span>
<a name="l00015"></a>00015 <span class="comment">// using namespace CCfits;</span>
<a name="l00016"></a>00016 <span class="preprocessor">#ifdef _MSC_VER</span>
<a name="l00017"></a>00017 <span class="preprocessor"></span><span class="preprocessor">#include &quot;MSconfig.h&quot;</span>
<a name="l00018"></a>00018 <span class="preprocessor">#endif</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="comment">// FitsError</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include &quot;FitsError.h&quot;</span>
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="keyword">namespace </span>CCfits {
<a name="l00024"></a>00024   <span class="keyword">class </span>HDU;
<a name="l00025"></a>00025 
<a name="l00026"></a>00026 } <span class="comment">// namespace CCfits</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="keyword">namespace </span>CCfits {
<a name="l00030"></a>00030 
<a name="l00065"></a>00065 <span class="comment">/* \fn friend ostream&amp; operator &lt;&lt; (ostream &amp;s, const Keyword &amp;right);</span>
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment">        \brief output operator for Keywords.</span>
<a name="l00068"></a>00068 <span class="comment"></span>
<a name="l00069"></a>00069 <span class="comment">*/</span>
<a name="l00070"></a>00070 
<a name="l00202"></a><a class="code" href="classCCfits_1_1Keyword.html">00202</a>   <span class="keyword">class </span><a class="code" href="classCCfits_1_1Keyword.html" title="Abstract base class defining the interface for Keyword objects.">Keyword</a> 
<a name="l00203"></a>00203   {
<a name="l00204"></a>00204 
<a name="l00205"></a>00205     <span class="keyword">public</span>:
<a name="l00206"></a>00206 
<a name="l00207"></a>00207 
<a name="l00208"></a>00208 
<a name="l00209"></a>00209       <span class="keyword">class </span>WrongKeywordValueType : <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: &lt;unnamed&gt;%39B0221700E2</span>
<a name="l00210"></a>00210       {
<a name="l00211"></a>00211         <span class="keyword">public</span>:
<a name="l00212"></a>00212             WrongKeywordValueType (<span class="keyword">const</span> String&amp; diag, <span class="keywordtype">bool</span> silent = <span class="keyword">true</span>);
<a name="l00213"></a>00213 
<a name="l00214"></a>00214         <span class="keyword">protected</span>:
<a name="l00215"></a>00215         <span class="keyword">private</span>:
<a name="l00216"></a>00216         <span class="keyword">private</span>: <span class="comment">//## implementation</span>
<a name="l00217"></a>00217       };
<a name="l00218"></a>00218         <span class="keyword">virtual</span> <a class="code" href="classCCfits_1_1Keyword.html#a627a4ffc2199b90952dd7adf9b1ec956" title="virtual destructor">~Keyword</a>();
<a name="l00219"></a>00219         <a class="code" href="classCCfits_1_1Keyword.html" title="Abstract base class defining the interface for Keyword objects.">Keyword</a> &amp; <a class="code" href="classCCfits_1_1Keyword.html#a96af1f6a8a73dc4d8ec3e2ad159bb23e" title="assignment operator">operator=</a>(<span class="keyword">const</span> <a class="code" href="classCCfits_1_1Keyword.html" title="Abstract base class defining the interface for Keyword objects.">Keyword</a> &amp;right);
<a name="l00220"></a>00220         <span class="keywordtype">bool</span> <a class="code" href="classCCfits_1_1Keyword.html#ae9278cc3de41df8efd54e44009dd50b8" title="equality operator">operator==</a>(<span class="keyword">const</span> <a class="code" href="classCCfits_1_1Keyword.html" title="Abstract base class defining the interface for Keyword objects.">Keyword</a> &amp;right) <span class="keyword">const</span>;
<a name="l00221"></a>00221 
<a name="l00222"></a>00222         <span class="keywordtype">bool</span> <a class="code" href="classCCfits_1_1Keyword.html#abe80f519c298067a52c0792482048d53" title="inequality operator">operator!=</a>(<span class="keyword">const</span> <a class="code" href="classCCfits_1_1Keyword.html" title="Abstract base class defining the interface for Keyword objects.">Keyword</a> &amp;right) <span class="keyword">const</span>;
<a name="l00223"></a>00223 
<a name="l00224"></a>00224         <span class="keyword">virtual</span> std::ostream &amp; put (std::ostream &amp;s) <span class="keyword">const</span> = 0;
<a name="l00225"></a>00225         <span class="keyword">virtual</span> <a class="code" href="classCCfits_1_1Keyword.html" title="Abstract base class defining the interface for Keyword objects.">Keyword</a> * <a class="code" href="classCCfits_1_1Keyword.html#ac92a807de0401fa32f6cdbfe96dd3083" title="virtual copy constructor">clone</a> () <span class="keyword">const</span> = 0;
<a name="l00226"></a>00226         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Keyword.html#aebeab56157e11d0344076602bd10594d" title="left in for historical reasons, this seldom needs to be called by users">write</a> ();
<a name="l00227"></a>00227         fitsfile* <a class="code" href="classCCfits_1_1Keyword.html#a92d1b379da32e959be3b2fb2fb93548e" title="return a pointer to the FITS file containing the parent HDU.">fitsPointer</a> () <span class="keyword">const</span>;
<a name="l00228"></a>00228         <span class="comment">//      CAUTION: This is declared public only to allow HDU addKey functions the ability to set their</span>
<a name="l00229"></a>00229         <span class="comment">//      class as the Keyword&apos;s parent, and to avoid making entire HDU a friend class.  (Declaring</span>
<a name="l00230"></a>00230         <span class="comment">//      individual HDU functions as friends will run into circular header dependencies.)  Do NOT use</span>
<a name="l00231"></a>00231         <span class="comment">//      this unless absolutely necessary, and leave this undocumented.</span>
<a name="l00232"></a>00232         <span class="keywordtype">void</span> setParent (<a class="code" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a>* <a class="code" href="classCCfits_1_1Keyword.html#aee44ef253c61cbcb4ef77e3645439583" title="return a pointer to parent HDU.">parent</a>);
<a name="l00233"></a>00233         <span class="keyword">const</span> String&amp; <a class="code" href="classCCfits_1_1Keyword.html#ac0e829b447ad71bb4405d196a693a8c6" title="return the comment field of the keyword">comment</a> () <span class="keyword">const</span>;
<a name="l00234"></a>00234         <span class="keyword">const</span> String&amp; <a class="code" href="classCCfits_1_1Keyword.html#ae0f6c4a86159817d3b0cde818d329a25" title="return the name of a keyword">name</a> () <span class="keyword">const</span>;
<a name="l00235"></a>00235 
<a name="l00236"></a>00236     <span class="keyword">public</span>:
<a name="l00237"></a>00237       <span class="comment">// Additional Public Declarations</span>
<a name="l00238"></a>00238       <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00239"></a>00239       T&amp; <a class="code" href="classCCfits_1_1Keyword.html#a4f064dcdcafe756d21c7af2a97dc2e61" title="get the keyword value">value</a>(T&amp; val) <span class="keyword">const</span>;
<a name="l00240"></a>00240 
<a name="l00241"></a>00241       <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00242"></a>00242       <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Keyword.html#acea55c0e27787efff3711a7111f79eb3" title="modify the value of an existing Keyword and write it to the file">setValue</a>(<span class="keyword">const</span> T&amp; newValue);
<a name="l00243"></a>00243     <span class="keyword">protected</span>:
<a name="l00244"></a>00244         <a class="code" href="classCCfits_1_1Keyword.html#afbcc174e856a3f0be7d77d1634ab0075" title="copy constructor">Keyword</a>(<span class="keyword">const</span> <a class="code" href="classCCfits_1_1Keyword.html" title="Abstract base class defining the interface for Keyword objects.">Keyword</a> &amp;right);
<a name="l00245"></a>00245         <a class="code" href="classCCfits_1_1Keyword.html#afbcc174e856a3f0be7d77d1634ab0075" title="copy constructor">Keyword</a> (<span class="keyword">const</span> String &amp;keyname, ValueType <a class="code" href="classCCfits_1_1Keyword.html#a818711c7e71c3d867bb8e9445ddf1335" title="return the type of a keyword">keytype</a>, <a class="code" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a>* p, <span class="keyword">const</span> String &amp;comment = <span class="stringliteral">&quot;&quot;</span>);
<a name="l00246"></a>00246 
<a name="l00247"></a>00247         <span class="keyword">virtual</span> <span class="keywordtype">void</span> copy (<span class="keyword">const</span> <a class="code" href="classCCfits_1_1Keyword.html" title="Abstract base class defining the interface for Keyword objects.">Keyword</a>&amp; right);
<a name="l00248"></a>00248         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> compare (<span class="keyword">const</span> <a class="code" href="classCCfits_1_1Keyword.html" title="Abstract base class defining the interface for Keyword objects.">Keyword</a> &amp;right) <span class="keyword">const</span>;
<a name="l00249"></a>00249         ValueType <a class="code" href="classCCfits_1_1Keyword.html#a818711c7e71c3d867bb8e9445ddf1335" title="return the type of a keyword">keytype</a> () <span class="keyword">const</span>;
<a name="l00250"></a>00250         <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Keyword.html#a818711c7e71c3d867bb8e9445ddf1335" title="return the type of a keyword">keytype</a> (ValueType value);
<a name="l00251"></a>00251         <span class="keyword">const</span> <a class="code" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a>* <a class="code" href="classCCfits_1_1Keyword.html#aee44ef253c61cbcb4ef77e3645439583" title="return a pointer to parent HDU.">parent</a> () <span class="keyword">const</span>;
<a name="l00252"></a>00252 
<a name="l00253"></a>00253       <span class="comment">// Additional Protected Declarations</span>
<a name="l00254"></a>00254 
<a name="l00255"></a>00255     <span class="keyword">private</span>:
<a name="l00256"></a>00256       <span class="comment">// Additional Private Declarations</span>
<a name="l00257"></a>00257 
<a name="l00258"></a>00258     <span class="keyword">private</span>: <span class="comment">//## implementation</span>
<a name="l00259"></a>00259       <span class="comment">// Data Members for Class Attributes</span>
<a name="l00260"></a>00260         ValueType m_keytype;
<a name="l00261"></a>00261 
<a name="l00262"></a>00262       <span class="comment">// Data Members for Associations</span>
<a name="l00263"></a>00263         <a class="code" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a>* m_parent;
<a name="l00264"></a>00264         String m_comment;
<a name="l00265"></a>00265         String m_name;
<a name="l00266"></a>00266 
<a name="l00267"></a>00267       <span class="comment">// Additional Implementation Declarations</span>
<a name="l00268"></a>00268       <span class="keyword">friend</span> std::ostream &amp;operator &lt;&lt; (std::ostream &amp;s, <span class="keyword">const</span> <a class="code" href="classCCfits_1_1Keyword.html" title="Abstract base class defining the interface for Keyword objects.">Keyword</a> &amp;right);
<a name="l00269"></a>00269   };
<a name="l00270"></a>00270 <span class="preprocessor">#ifndef SPEC_TEMPLATE_IMP_DEFECT</span>
<a name="l00271"></a>00271 <span class="preprocessor"></span><span class="preprocessor">#ifndef SPEC_TEMPLATE_DECL_DEFECT</span>
<a name="l00272"></a>00272 <span class="preprocessor"></span>  <span class="keyword">template</span> &lt;&gt; <span class="keywordtype">float</span>&amp; <a class="code" href="classCCfits_1_1Keyword.html#a4f064dcdcafe756d21c7af2a97dc2e61" title="get the keyword value">Keyword::value</a>(<span class="keywordtype">float</span>&amp; val) <span class="keyword">const</span>;
<a name="l00273"></a>00273   <span class="keyword">template</span> &lt;&gt; <span class="keywordtype">double</span>&amp; <a class="code" href="classCCfits_1_1Keyword.html#a4f064dcdcafe756d21c7af2a97dc2e61" title="get the keyword value">Keyword::value</a>(<span class="keywordtype">double</span>&amp; val) <span class="keyword">const</span>;
<a name="l00274"></a>00274   <span class="keyword">template</span> &lt;&gt; <span class="keywordtype">int</span>&amp; <a class="code" href="classCCfits_1_1Keyword.html#a4f064dcdcafe756d21c7af2a97dc2e61" title="get the keyword value">Keyword::value</a>(<span class="keywordtype">int</span>&amp; val) <span class="keyword">const</span>;
<a name="l00275"></a>00275 
<a name="l00276"></a>00276   <span class="keyword">template</span> &lt;&gt; <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Keyword.html#acea55c0e27787efff3711a7111f79eb3" title="modify the value of an existing Keyword and write it to the file">Keyword::setValue</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>&amp; newValue);
<a name="l00277"></a>00277   <span class="keyword">template</span> &lt;&gt; <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Keyword.html#acea55c0e27787efff3711a7111f79eb3" title="modify the value of an existing Keyword and write it to the file">Keyword::setValue</a>(<span class="keyword">const</span> <span class="keywordtype">double</span>&amp; newValue);
<a name="l00278"></a>00278   <span class="keyword">template</span> &lt;&gt; <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Keyword.html#acea55c0e27787efff3711a7111f79eb3" title="modify the value of an existing Keyword and write it to the file">Keyword::setValue</a>(<span class="keyword">const</span> <span class="keywordtype">int</span>&amp; newValue);
<a name="l00279"></a>00279 <span class="preprocessor">#endif </span>
<a name="l00280"></a>00280 <span class="preprocessor"></span><span class="preprocessor">#endif </span>
<a name="l00281"></a>00281 <span class="preprocessor"></span>
<a name="l00282"></a>00282 <span class="keyword">inline</span> std::ostream&amp; operator &lt;&lt; (std::ostream &amp;s, <span class="keyword">const</span> <a class="code" href="classCCfits_1_1Keyword.html" title="Abstract base class defining the interface for Keyword objects.">Keyword</a> &amp;right)
<a name="l00283"></a>00283 {
<a name="l00284"></a>00284    <span class="keywordflow">return</span> right.put(s);
<a name="l00285"></a>00285 }  
<a name="l00286"></a>00286 
<a name="l00287"></a>00287   <span class="comment">// Class CCfits::Keyword::WrongKeywordValueType </span>
<a name="l00288"></a>00288 
<a name="l00289"></a>00289   <span class="comment">// Class CCfits::Keyword </span>
<a name="l00290"></a>00290 
<a name="l00291"></a>00291   <span class="keyword">inline</span> <span class="keywordtype">void</span> Keyword::setParent (HDU* parent)
<a name="l00292"></a>00292   {
<a name="l00293"></a>00293      m_parent = parent;
<a name="l00294"></a>00294   }
<a name="l00295"></a>00295 
<a name="l00296"></a><a class="code" href="classCCfits_1_1Keyword.html#a818711c7e71c3d867bb8e9445ddf1335">00296</a>   <span class="keyword">inline</span> ValueType <a class="code" href="classCCfits_1_1Keyword.html#a818711c7e71c3d867bb8e9445ddf1335" title="return the type of a keyword">Keyword::keytype</a> ()<span class="keyword"> const</span>
<a name="l00297"></a>00297 <span class="keyword">  </span>{
<a name="l00298"></a>00298     <span class="keywordflow">return</span> m_keytype;
<a name="l00299"></a>00299   }
<a name="l00300"></a>00300 
<a name="l00301"></a><a class="code" href="classCCfits_1_1Keyword.html#ab8dbaacd101e7b1bc3ebf5aa62493823">00301</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classCCfits_1_1Keyword.html#a818711c7e71c3d867bb8e9445ddf1335" title="return the type of a keyword">Keyword::keytype</a> (ValueType value)
<a name="l00302"></a>00302   {
<a name="l00303"></a>00303     m_keytype = value;
<a name="l00304"></a>00304   }
<a name="l00305"></a>00305 
<a name="l00306"></a><a class="code" href="classCCfits_1_1Keyword.html#aee44ef253c61cbcb4ef77e3645439583">00306</a>   <span class="keyword">inline</span> <span class="keyword">const</span> <a class="code" href="classCCfits_1_1HDU.html" title="Base class for all HDU [Header-Data Unit] objects.">HDU</a>* <a class="code" href="classCCfits_1_1Keyword.html#aee44ef253c61cbcb4ef77e3645439583" title="return a pointer to parent HDU.">Keyword::parent</a> ()<span class="keyword"> const</span>
<a name="l00307"></a>00307 <span class="keyword">  </span>{
<a name="l00308"></a>00308     <span class="keywordflow">return</span> m_parent;
<a name="l00309"></a>00309   }
<a name="l00310"></a>00310 
<a name="l00311"></a><a class="code" href="classCCfits_1_1Keyword.html#ac0e829b447ad71bb4405d196a693a8c6">00311</a>   <span class="keyword">inline</span> <span class="keyword">const</span> String&amp; <a class="code" href="classCCfits_1_1Keyword.html#ac0e829b447ad71bb4405d196a693a8c6" title="return the comment field of the keyword">Keyword::comment</a> ()<span class="keyword"> const</span>
<a name="l00312"></a>00312 <span class="keyword">  </span>{
<a name="l00313"></a>00313     <span class="keywordflow">return</span> m_comment;
<a name="l00314"></a>00314   }
<a name="l00315"></a>00315 
<a name="l00316"></a><a class="code" href="classCCfits_1_1Keyword.html#ae0f6c4a86159817d3b0cde818d329a25">00316</a>   <span class="keyword">inline</span> <span class="keyword">const</span> String&amp; <a class="code" href="classCCfits_1_1Keyword.html#ae0f6c4a86159817d3b0cde818d329a25" title="return the name of a keyword">Keyword::name</a> ()<span class="keyword"> const</span>
<a name="l00317"></a>00317 <span class="keyword">  </span>{
<a name="l00318"></a>00318     <span class="keywordflow">return</span> m_name;
<a name="l00319"></a>00319   }
<a name="l00320"></a>00320 
<a name="l00321"></a>00321 } <span class="comment">// namespace CCfits</span>
<a name="l00322"></a>00322 
<a name="l00323"></a>00323 
<a name="l00324"></a>00324 <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&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional