.. currentmodule:: cf
.. default-role:: obj

cf.CoordinateReference
======================

.. autoclass:: cf.CoordinateReference
   :no-members:
   :no-inherited-members:

CoordinateReference attributes
------------------------------

.. autosummary::
   :toctree: ../generated/
   :template: attribute.rst

   ~cf.CoordinateReference.T
   ~cf.CoordinateReference.X
   ~cf.CoordinateReference.Y
   ~cf.CoordinateReference.Z

CoordinateReference methods
---------------------------

.. autosummary::
   :nosignatures:
   :toctree: ../generated/	
   :template: method.rst

   ~cf.CoordinateReference.change_coord
   ~cf.CoordinateReference.close
   ~cf.CoordinateReference.dump
   ~cf.CoordinateReference.equals
   ~cf.CoordinateReference.equivalent
   ~cf.CoordinateReference.identity
   ~cf.CoordinateReference.match
   ~cf.CoordinateReference.remove_all_coords
   ~cf.CoordinateReference.set
   ~cf.CoordinateReference.setcoord

CoordinateReference class methods
---------------------------------

.. autosummary::
   :nosignatures:
   :toctree: ../generated/
   :template: method.rst

   ~cf.CoordinateReference.canonical_units
   ~cf.CoordinateReference.default_value

CoordinateReference dict-like methods
-------------------------------------

These methods provide functionality similar to that of a built-in
:py:obj:`dict`.

Undocumented methods behave exactly as their counterparts in a
built-in :py:obj:`dict`.

.. autosummary::
   :nosignatures:
   :toctree: ../generated/	
   :template: method.rst

   ~cf.CoordinateReference.clear
   ~cf.CoordinateReference.get
   ~cf.CoordinateReference.has_key
   ~cf.CoordinateReference.items
   ~cf.CoordinateReference.iteritems
   ~cf.CoordinateReference.iterkeys
   ~cf.CoordinateReference.itervalues
   ~cf.CoordinateReference.keys
   ~cf.CoordinateReference.pop
   ~cf.CoordinateReference.popitem
   ~cf.CoordinateReference.setdefault
   ~cf.CoordinateReference.update
   ~cf.CoordinateReference.values
