BufferVector.h

Go to the documentation of this file.

#ifndef _MADARA_CONTAINERS_BUFFER_VECTOR_H_
#define _MADARA_CONTAINERS_BUFFER_VECTOR_H_

#include <vector>
#include <string>
#include "madara/LockType.h"
#include "madara/knowledge/KnowledgeBase.h"
#include "madara/knowledge/ThreadSafeContext.h"
#include "madara/knowledge/KnowledgeUpdateSettings.h"
#include "BaseContainer.h"

namespace madara
{
  namespace knowledge
  {
    namespace containers
    {
      class MADARA_EXPORT BufferVector : public BaseContainer
      {
      public:
        BufferVector (const KnowledgeUpdateSettings & settings =
          KnowledgeUpdateSettings (),
          const std::string & delimiter = ".");

        BufferVector (const std::string & name,
                KnowledgeBase & knowledge,
                int size = -1,
                bool delete_vars = true,
                const KnowledgeUpdateSettings & settings =
                  KnowledgeUpdateSettings (),
                const std::string & delimiter = ".");

        BufferVector (const std::string & name,
                Variables & knowledge,
                int size = -1,
                bool delete_vars = true,
                const KnowledgeUpdateSettings & settings =
                  KnowledgeUpdateSettings (),
                const std::string & delimiter = ".");

        BufferVector (const BufferVector & rhs);

        virtual ~BufferVector ();

        void modify (void);

        void modify (size_t index);

        void operator= (const BufferVector & rhs);

        void push_back (const unsigned char * value, size_t size);

        void resize (int size = -1, bool delete_vars = true);

        void exchange (BufferVector & other, bool refresh_keys = true,
          bool delete_keys = true);

        void transfer_to (BufferVector & other);

        void copy_to (KnowledgeVector & target) const;

        size_t size (void) const;

        void set_name (const std::string & var_name,
          KnowledgeBase & knowledge, int size = -1);

        void set_name (const std::string & var_name,
          Variables & knowledge, int size = -1);

        void set_name (const std::string & var_name,
          ThreadSafeContext & knowledge, int size = -1);

        void set_delimiter (const std::string & delimiter);

        std::string get_delimiter (void);

        knowledge::KnowledgeRecord operator[] (size_t index) const;

        knowledge::KnowledgeRecord to_record (size_t index) const;

        bool exists (size_t index) const;

        int read_file (size_t index,
                       const std::string & filename);

        int read_file (size_t index,
                       const std::string & filename,
          const KnowledgeUpdateSettings & settings);

        int set (size_t index, const knowledge::KnowledgeRecord & value);

        int set_file (size_t index,
          const unsigned char * value, size_t size);

        int set_file (size_t index,
          const unsigned char * value, size_t size,
          const KnowledgeUpdateSettings & settings);

        int set_jpeg (size_t index,
          const unsigned char * value, size_t size);

        int set_jpeg (size_t index,
          const unsigned char * value, size_t size,
          const KnowledgeUpdateSettings & settings);

        void set_quality (size_t index, uint32_t quality,
               const KnowledgeReferenceSettings & settings =
                       KnowledgeReferenceSettings (false));

        VariableReference get_size_ref (void) const;

        std::string get_debug_info (void);

        virtual BaseContainer * clone (void) const;

        bool is_true (void) const;

        bool is_false (void) const;

      private:

        virtual bool is_true_ (void) const;

        virtual bool is_false_ (void) const;

        virtual void modify_ (void);

        virtual std::string get_debug_info_ (void);

        ThreadSafeContext * context_;

        std::vector <VariableReference> vector_;

        mutable VariableReference size_;

        std::string delimiter_;
      };

      typedef  BufferVector   BufferArray;
    }
  }
}

#endif // _MADARA_CONTAINERS_BUFFER_VECTOR_H_