PageRenderTime 53ms CodeModel.GetById 18ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/1.0/generated/cf.Field.insert_ref.html

https://bitbucket.org/cfpython/cfpython.bitbucket.org
HTML | 200 lines | 176 code | 24 blank | 0 comment | 0 complexity | 785a23030c2d686d61efd72136ec0511 MD5 | raw file
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2. 

  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. 

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">
    6. 

  6.   <head>
    7. 

  7.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    8. 

  8.     
    9. 

  9.     <title>cf.Field.insert_ref &mdash; Documentation</title>
    10. 

  10.     
    11. 

  11.     <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    12. 

  12.     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    13. 

  13.     
    14. 

  14.     <script type="text/javascript">
    15. 

  15.       var DOCUMENTATION_OPTIONS = {
    16. 

  16.         URL_ROOT:    '../',
    17. 

  17.         VERSION:     '1.0',
    18. 

  18.         COLLAPSE_INDEX: false,
    19. 

  19.         FILE_SUFFIX: '.html',
    20. 

  20.         HAS_SOURCE:  true
    21. 

  21.       };
    22. 

  22.     </script>
    23. 

  23.     <script type="text/javascript" src="../_static/jquery.js"></script>
    24. 

  24.     <script type="text/javascript" src="../_static/underscore.js"></script>
    25. 

  25.     <script type="text/javascript" src="../_static/doctools.js"></script>
    26. 

  26.     <script type="text/javascript" src="../_static/copybutton.js"></script>
    27. 

  27.     <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
    28. 

  28.     <link rel="top" title="Documentation" href="../index.html" />
    29. 

  29.     <link rel="up" title="cf.Field" href="../classes/cf.Field.html" />
    30. 

  30.     <link rel="next" title="cf.Field.iscyclic" href="cf.Field.iscyclic.html" />
    31. 

  31.     <link rel="prev" title="cf.Field.insert_measure" href="cf.Field.insert_measure.html" /> 
    32. 

  32.   </head>
    33. 

  33.   <body>
    34. 

  34.     <div class="related">
    35. 

  35.       <h3>Navigation</h3>
    36. 

  36.       <ul>
    37. 

  37.         <li class="right" style="margin-right: 10px">
    38. 

  38.           <a href="../genindex.html" title="General Index"
    39. 

  39.              accesskey="I">index</a></li>
    40. 

  40.         <li class="right" >
    41. 

  41.           <a href="cf.Field.iscyclic.html" title="cf.Field.iscyclic"
    42. 

  42.              accesskey="N">next</a> |</li>
    43. 

  43.         <li class="right" >
    44. 

  44.           <a href="cf.Field.insert_measure.html" title="cf.Field.insert_measure"
    45. 

  45.              accesskey="P">previous</a> |</li>
    46. 

  46.   <li><a target="_blank" href="http://cfpython.bitbucket.org">cf-python</a> &raquo;</li>
    47. 

  47.   <li><select onchange="location = this.options[this.selectedIndex].value;">
    48. 

  48. 

  49.       <option value="../../1.0/index.html"selected>1.0
    50. 

  50. 

  51.       <option value="../../0.9.9/index.html">0.9.9
    52. 

  52. 

  53.       <option value="../../0.9.8.3/index.html">0.9.8.3
    54. 

  54. 

  55.       <option value="../../archive.html">Archive
    56. 

  56. 

  57.       </select>
    58. 

  58.   </li>
    59. 

  59.   
    60. 

  60.         <li><a href="../index.html">Documentation</a> &raquo;</li>
    61. 

  61. 

  62.           <li><a href="../reference.html" >Reference manual</a> &raquo;</li>
    63. 

  63.           <li><a href="../class.html" >Classes of the <tt class="docutils literal"><span class="pre">cf</span></tt> module</a> &raquo;</li>
    64. 

  64.           <li><a href="../classes/cf.Field.html" accesskey="U">cf.Field</a> &raquo;</li> 
    65. 

  65.       </ul>
    66. 

  66.     </div>  
    67. 

  67. 

  68.     <div class="document">
    69. 

  69.       <div class="documentwrapper">
    70. 

  70.         <div class="bodywrapper">
    71. 

  71.           <div class="body">
    72. 

  72.             
    73. 

  73.   <div class="section" id="cf-field-insert-ref">
    74. 

  74. <h1>cf.Field.insert_ref<a class="headerlink" href="#cf-field-insert-ref" title="Permalink to this headline">Âś</a></h1>
    75. 

  75. <dl class="method">
    76. 

  76. <dt id="cf.Field.insert_ref">
    77. 

  77. <tt class="descclassname">Field.</tt><tt class="descname">insert_ref</tt><big>(</big><em>item</em>, <em>key=None</em>, <em>copy=True</em>, <em>replace=True</em><big>)</big><a class="reference external" href="https://bitbucket.org/cfpython/cf-python/src/v1.0/cf/field.py#cl-8949"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cf.Field.insert_ref" title="Permalink to this definition">Âś</a></dt>
    78. 

  78. <dd><p>Insert a coordinate reference object into the domain in place.</p>
    79. 

  79. <div class="admonition seealso">
    80. 

  80. <p class="first admonition-title">See also</p>
    81. 

  81. <p class="last"><a class="reference internal" href="cf.Field.insert_axis.html#cf.Field.insert_axis" title="cf.Field.insert_axis"><tt class="xref py py-obj docutils literal"><span class="pre">insert_axis</span></tt></a>, <a class="reference internal" href="cf.Field.insert_aux.html#cf.Field.insert_aux" title="cf.Field.insert_aux"><tt class="xref py py-obj docutils literal"><span class="pre">insert_aux</span></tt></a>, <a class="reference internal" href="cf.Field.insert_measure.html#cf.Field.insert_measure" title="cf.Field.insert_measure"><tt class="xref py py-obj docutils literal"><span class="pre">insert_measure</span></tt></a>,
    82. 

  82. <a class="reference internal" href="cf.Field.insert_data.html#cf.Field.insert_data" title="cf.Field.insert_data"><tt class="xref py py-obj docutils literal"><span class="pre">insert_data</span></tt></a>, <a class="reference internal" href="cf.Field.insert_dim.html#cf.Field.insert_dim" title="cf.Field.insert_dim"><tt class="xref py py-obj docutils literal"><span class="pre">insert_dim</span></tt></a></p>
    83. 

  83. </div>
    84. 

  84. <table class="docutils field-list" frame="void" rules="none">
    85. 

  85. <col class="field-name" />
    86. 

  86. <col class="field-body" />
    87. 

  87. <tbody valign="top">
    88. 

  88. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
    89. 

  89. <dt>item <span class="classifier-delimiter">:</span> <span class="classifier">cf.CoordinateReference</span></dt>
    90. 

  90. <dd><p class="first last">The new coordinate reference object.</p>
    91. 

  91. </dd>
    92. 

  92. <dt>key <span class="classifier-delimiter">:</span> <span class="classifier">str, optional</span></dt>
    93. 

  93. <dd><p class="first last">The domain identifier for the <em>item</em>. By default a new, unique
    94. 

  94. identifier will be generated.</p>
    95. 

  95. </dd>
    96. 

  96. <dt>copy: bool, optional</dt>
    97. 

  97. <dd><p class="first last">If False then the <em>item</em> is not copied before insertion. By
    98. 

  98. default it is copied.</p>
    99. 

  99. </dd>
    100. 

  100. <dt>replace <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional</span></dt>
    101. 

  101. <dd><p class="first last">If False then do not replace an existing coordinate reference object of
    102. 

  102. domain which has the same identifier. By default an existing
    103. 

  103. coordinate reference object with the same identifier is replaced with
    104. 

  104. <em>item</em>.</p>
    105. 

  105. </dd>
    106. 

  106. </dl>
    107. 

  107. </td>
    108. 

  108. </tr>
    109. 

  109. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first docutils">
    110. 

  110. <dt>out <span class="classifier-delimiter">:</span> <span class="classifier"></span></dt>
    111. 

  111. <dd><p class="first last">The domain identifier for the <em>item</em>.</p>
    112. 

  112. </dd>
    113. 

  113. </dl>
    114. 

  114. </td>
    115. 

  115. </tr>
    116. 

  116. <tr class="field-odd field"><th class="field-name">Examples:</th><td class="field-body"></td>
    117. 

  117. </tr>
    118. 

  118. </tbody>
    119. 

  119. </table>
    120. 

  120. <div class="highlight-python"><div class="highlight"><pre><span class="go">&gt;&gt;&gt;</span>
    121. 

  121. </pre></div>
    122. 

  122. </div>
    123. 

  123. </dd></dl>
    124. 

  124. 

  125. </div>
    126. 

  126. 

  127. 

  128.           </div>
    129. 

  129.         </div>
    130. 

  130.       </div>
    131. 

  131.       <div class="sphinxsidebar">
    132. 

  132.         <div class="sphinxsidebarwrapper">
    133. 

  133.   <h4>Previous topic</h4>
    134. 

  134.   <p class="topless"><a href="cf.Field.insert_measure.html"
    135. 

  135.                         title="previous chapter">cf.Field.insert_measure</a></p>
    136. 

  136.   <h4>Next topic</h4>
    137. 

  137.   <p class="topless"><a href="cf.Field.iscyclic.html"
    138. 

  138.                         title="next chapter">cf.Field.iscyclic</a></p>
    139. 

  139.   <h3>This Page</h3>
    140. 

  140.   <ul class="this-page-menu">
    141. 

  141.     <li><a href="../_sources/generated/cf.Field.insert_ref.txt"
    142. 

  142.            rel="nofollow">Show Source</a></li>
    143. 

  143.   </ul>
    144. 

  144. <div id="searchbox" style="display: none">
    145. 

  145.   <h3>Quick search</h3>
    146. 

  146.     <form class="search" action="../search.html" method="get">
    147. 

  147.       <input type="text" name="q" />
    148. 

  148.       <input type="submit" value="Go" />
    149. 

  149.       <input type="hidden" name="check_keywords" value="yes" />
    150. 

  150.       <input type="hidden" name="area" value="default" />
    151. 

  151.     </form>
    152. 

  152.     <p class="searchtip" style="font-size: 90%">
    153. 

  153.     Enter search terms or a module, class or function name.
    154. 

  154.     </p>
    155. 

  155. </div>
    156. 

  156. <script type="text/javascript">$('#searchbox').show(0);</script>
    157. 

  157.         </div>
    158. 

  158.       </div>
    159. 

  159.       <div class="clearer"></div>
    160. 

  160.     </div>
    161. 

  161.     <div class="related">
    162. 

  162.       <h3>Navigation</h3>
    163. 

  163.       <ul>
    164. 

  164.         <li class="right" style="margin-right: 10px">
    165. 

  165.           <a href="../genindex.html" title="General Index"
    166. 

  166.              >index</a></li>
    167. 

  167.         <li class="right" >
    168. 

  168.           <a href="cf.Field.iscyclic.html" title="cf.Field.iscyclic"
    169. 

  169.              >next</a> |</li>
    170. 

  170.         <li class="right" >
    171. 

  171.           <a href="cf.Field.insert_measure.html" title="cf.Field.insert_measure"
    172. 

  172.              >previous</a> |</li>
    173. 

  173.   <li><a target="_blank" href="http://cfpython.bitbucket.org">cf-python</a> &raquo;</li>
    174. 

  174.   <li><select onchange="location = this.options[this.selectedIndex].value;">
    175. 

  175. 

  176.       <option value="../../1.0/index.html"selected>1.0
    177. 

  177. 

  178.       <option value="../../0.9.9/index.html">0.9.9
    179. 

  179. 

  180.       <option value="../../0.9.8.3/index.html">0.9.8.3
    181. 

  181. 

  182.       <option value="../../archive.html">Archive
    183. 

  183. 

  184.       </select>
    185. 

  185.   </li>
    186. 

  186.   
    187. 

  187.         <li><a href="../index.html">Documentation</a> &raquo;</li>
    188. 

  188. 

  189.           <li><a href="../reference.html" >Reference manual</a> &raquo;</li>
    190. 

  190.           <li><a href="../class.html" >Classes of the <tt class="docutils literal"><span class="pre">cf</span></tt> module</a> &raquo;</li>
    191. 

  191.           <li><a href="../classes/cf.Field.html" >cf.Field</a> &raquo;</li> 
    192. 

  192.       </ul>
    193. 

  193.     </div>
    194. 

  194.     <div class="footer">
    195. 

  195.         &copy; Copyright 2015, David Hassell.
    196. 

  196.       Last updated on May 27, 2015.
    197. 

  197.       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
    198. 

  198.     </div>
    199. 

  199.   </body>
    200. 

  200. </html>
    201.