SqlStatement.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/

#ifndef IGNITION_TRANSPORT_LOG_SQLSTATEMENT_HH_
#define IGNITION_TRANSPORT_LOG_SQLSTATEMENT_HH_

#include <memory>
#include <string>
#include <vector>

#include <ignition/transport/config.hh>
#include <ignition/transport/log/Export.hh>

namespace ignition
{
  namespace transport
  {
    namespace log
    {
      // Inline bracket to help doxygen filtering.
      inline namespace IGNITION_TRANSPORT_VERSION_NAMESPACE {
      //
      class IGNITION_TRANSPORT_LOG_VISIBLE SqlParameter
      {
        public: enum class ParamType : int
        {
          NULL_TYPE,
          INTEGER,
          REAL,
          TEXT
          // TODO(anyone): Consider supporting blob types
        };

        public: SqlParameter();

        public: explicit SqlParameter(std::nullptr_t);

        public: explicit SqlParameter(int64_t _integer);

        public: explicit SqlParameter(double _real);

        public: explicit SqlParameter(const std::string &_string);

        public: SqlParameter(const SqlParameter &_other);

        public: SqlParameter(SqlParameter &&_other);  // NOLINT

        public: SqlParameter &operator=(const SqlParameter &_other);

        public: SqlParameter &operator=(SqlParameter &&_other);  // NOLINT

        public: void Set(std::nullptr_t _np);

        public: void Set(int64_t _integer);

        public: void Set(double _real);

        public: void Set(const std::string &_text);

        public: ParamType Type() const;

        public: const int64_t *QueryInteger() const;

        public: const double *QueryReal() const;

        public: const std::string *QueryText() const;

        public: ~SqlParameter();

        private: class Implementation;

#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::*
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
        private: std::unique_ptr<Implementation> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
      };

      struct IGNITION_TRANSPORT_LOG_VISIBLE SqlStatement
      {
#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::*
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
        public: std::string statement;

        public: std::vector<SqlParameter> parameters;
#ifdef _WIN32
#pragma warning(pop)
#endif

        public: void Append(const SqlStatement &_other);
      };
      }
    }
  }
}

#endif