Drizzled Public API Documentation

time.h

00001 /* - mode: c++ c-basic-offset: 2; indent-tabs-mode: nil; -*-
00002  *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
00003  *
00004  *  Copyright (C) 2008 MySQL
00005  *
00006  *  This program is free software; you can redistribute it and/or modify
00007  *  it under the terms of the GNU General Public License as published by
00008  *  the Free Software Foundation; either version 2 of the License, or
00009  *  (at your option) any later version.
00010  *
00011  *  This program is distributed in the hope that it will be useful,
00012  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  *  GNU General Public License for more details.
00015  *
00016  *  You should have received a copy of the GNU General Public License
00017  *  along with this program; if not, write to the Free Software
00018  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00019  */
00020 
00021 #pragma once
00022 
00023 #include <drizzled/field/str.h>
00024 
00025 namespace drizzled
00026 {
00027 
00028 class Time;
00029 
00030 namespace field
00031 {
00032 
00033 class TableShare;
00034 typedef struct charset_info_st CHARSET_INFO;
00035 
00036 class Time :public Field_str {
00037 public:
00038   Time(unsigned char *ptr_arg,
00039                   uint32_t len_arg,
00040                   unsigned char *null_ptr_arg,
00041                   unsigned char null_bit_arg,
00042                   const char *field_name_arg);
00043 
00044   Time(bool maybe_null_arg,
00045                   const char *field_name_arg);
00046 
00047   enum_field_types type() const { return DRIZZLE_TYPE_TIMESTAMP;}
00048   enum ha_base_keytype key_type() const { return HA_KEYTYPE_LONG_INT; }
00049   enum Item_result cmp_type () const { return INT_RESULT; }
00050   int  store(const char *to,uint32_t length,
00051              const CHARSET_INFO * const charset);
00052   int  store(double nr);
00053   int  store(int64_t nr, bool unsigned_val);
00054   int  reset(void) { ptr[0]= ptr[1]= ptr[2]= ptr[3]= 0; return 0; }
00055   double val_real(void) const;
00056   int64_t val_int(void) const;
00057   String *val_str(String*,String *) const;
00058   int cmp(const unsigned char *,const unsigned char *);
00059   void sort_string(unsigned char *buff,uint32_t length);
00060   uint32_t pack_length() const { return 4; }
00061   void sql_type(String &str) const;
00062   bool can_be_compared_as_int64_t() const { return true; }
00063   bool zero_pack() const { return 0; }
00064 
00065   /* Get TIME field value as seconds since begging of Unix Epoch */
00066   long get_timestamp(bool *null_value) const;
00067 private:
00068   bool get_date(type::Time &ltime, uint32_t fuzzydate) const;
00069   bool get_time(type::Time &ltime) const;
00070 
00071 public:
00072   timestamp_auto_set_type get_auto_set_type() const;
00073   static size_t max_string_length();
00074   void pack_time(drizzled::Time &arg);
00075   void unpack_time(drizzled::Time &arg) const;
00076   void unpack_time(int32_t &destination, const unsigned char *source) const;
00077 };
00078 
00079 } /* namespace field */
00080 } /* namespace drizzled */
00081 
00082