System_Date.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       System_Date.h
//! @brief      System date and time calss implementation.
//! @attention  No special attention requered.
//! @copyright  (C) 2015-2020 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Common/System_Date.h $
//!             $Revision: 2944 $
//!             $Date: 2022-02-26 10:45:42 +0500 (Sa, 26 Feb 2022) $
//!             $Author: minch $
//------------------------------------------------------------------------------
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of ANVILEX nor the names of its contributors may be
//    used to endorse or promote products derived from this software without
//    specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Defines.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief System date and time class
class TDate_Time
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public definesn
    //--------------------------------------------------------------------------
  
    //! @brief Date and time structure
    typedef struct
    {
      
      //! @brief Year
      U16 u16_Year; 
      
      //! @brief Month 1..12
      U16 u16_Month;
      
      //! @brief Day 1..31
      U16 u16_Day; 
      
      //! @brief Hour 0..23
      U16 u16_Hour; 
      
      //! @brief Minute 0..59
      U16 u16_Minute; 
      
      //! @brief Secinds 0..59
      U16 u16_Second; 
      
      //! @brief Miliseconds 0..999
      U16 u16_Milisecond; 
      
      //! @brief Flags
      U16 u16_Flags; 
      
    } TDate_Time_Structure;
    
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
    
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //! \par       UML diagram
    //! @dotfile   TDate_Time__TDate_Time.dt
    //--------------------------------------------------------------------------
 
    TDate_Time();
    
//    TDate_Time( I32 i32_Source ); //!< Constructor method
//    TDate_Time( DOUBLE double_Source );
    TDate_Time( const TDate_Time &object_Source ); //!< Constructor method
    TDate_Time( TDate_Time *object_Source ); //!< Constructor method
      TDate_Time( TDate_Time_Structure *struct_Source ); //!< Constructor method
//    TDate_Time* TDate_Time( const TDate_TimeBase& src );  //!< Constructor method
//    TDate_Time* TDate_Time( const System::UnicodeString & src, TDate_Time::TDate_TimeFlag flag);   //!< Constructor method
    TDate_Time( U16 u16_Year, U16 u16_Month, U16 u16_Day );   //!< Constructor method
    TDate_Time( U16 u16_Hour, U16 u16_Minute, U16 u16_Second, U16 u16_Milisecond );   //!< Constructor method
    TDate_Time( U16 u16_Year, U16 u16_Month, U16 u16_Day, U16 u16_Hour, U16 u16_Minute, U16 u16_Second, U16 u16_Milisecond );  //!< Constructor method
    TDate_Time( U64 u64_Source ); //!< Constructor method
    ~TDate_Time(); //!< Destructor method
 
    
    // Data processing methods
    VOID Set_Default();
    VOID Get( TDate_Time_Structure *struct_DateTime );
    BOOL Set( TDate_Time_Structure struct_New_DateTime );
    BOOL Set( TDate_Time_Structure *struct_New_DateTime );    
    BOOL Set( U16 u16_Year, U16 u16_Month, U16 u16_Day, U16 u16_Hour, U16 u16_Minute, U16 u16_Second, U16 u16_Milisecond );
    U64 Get_Compressed_As_U64();
    TDate_Time_Structure Convert_From_CDT64( U64 u64_Value );
    U64 Get_As_CDT64();
    TDate_Time_Structure *Get_Data();
    
    
    BOOL Is_Valid( TDate_Time_Structure struct_DateTime_Structure );
    VOID Increment_ms();
 
    U16 Last_Day_Of_Month_Common_Year( U16 u16_Month );
    U16 Last_Day_Of_Month_Leap_Year( U16 u16_Month );
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
    
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    //! @brief Date and time drorage structure
    TDate_Time_Structure struct_DateTime_Structure; 
  
    //! @brief Date and time validity flag
    BOOL bool_Valid; 
  
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------