.. include:: headings.inc



.. _Tm:

==========================================================================================================================================
|phoenix_title|  **Tm**
==========================================================================================================================================

Contains broken down date-time representation.          

This struct is analogous to standard C  ``struct tm``   and uses the same, not always immediately obvious, conventions for its members: notably its mon and mday fields count from 0 while yday counts from 1.            




|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **Tm**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/Tm_inheritance.png" alt="Inheritance diagram of Tm" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Tm.html" title="Contains broken down date-time representation." alt="" coords="5,5,77,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~Tm.GetWeekDay`                                                           Return the week day corresponding to this date.
:meth:`~Tm.IsValid`                                                              Check if the given date/time is valid (in Gregorian calendar).
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~Tm.WeekDay`                                                              See :meth:`~Tm.GetWeekDay`
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: Tm(object)

   Contains broken down date-time representation.



   .. method:: GetWeekDay(self)

      Return the week day corresponding to this date.                  

      Unlike the other fields, the week day is not always available and so must be accessed using this method as it is computed on demand when it is called.                  

      :rtype: `DateTime.WeekDay`








   .. method:: IsValid(self)

      Check if the given date/time is valid (in Gregorian calendar).                  

      Return ``False`` if the components don't correspond to a correct date.                  

      :rtype: `bool`








   .. attribute:: WeekDay

      See :meth:`~Tm.GetWeekDay`