StringVector.h

Go to the documentation of this file.

#ifndef _MADARA_CONTAINERS_STRING_VECTOR_H_
#define _MADARA_CONTAINERS_STRING_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 StringVector : public BaseContainer
      {
      public:
        typedef std::string  type;
        
        StringVector (const KnowledgeUpdateSettings & settings =
            KnowledgeUpdateSettings (),
          const std::string & delimiter = ".");

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

        virtual ~StringVector ();
    
        void modify (void);

        void modify (size_t index);
        
        void operator= (const StringVector & rhs);

        void push_back (type value);

        void resize (int size = -1, bool delete_vars = true);
      
        void exchange (StringVector & other, bool refresh_keys = true,
          bool delete_keys = true);
        
        void copy_to (KnowledgeVector & target) const;

        void copy_to (std::vector <type> & target) const;

        void transfer_to (StringVector & other);

        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);

        type operator[] (size_t index) const;
      
        knowledge::KnowledgeRecord to_record (size_t index) const;
      
        knowledge::KnowledgeRecord to_record (void) const;
      
        bool exists (size_t index) const;
      
        int set (size_t index,
          const type & value);

        int set (size_t index,
          const type & value, 
          const KnowledgeUpdateSettings & settings);
        
        int set (
          const std::vector <type> & value);
       
        int set (
          const std::vector <type> & value,
          const KnowledgeUpdateSettings & settings);
       
        void set_quality (size_t index, uint32_t quality,
               const KnowledgeReferenceSettings & settings =
                       KnowledgeReferenceSettings (false));
      
        VariableReference get_size_ref (void);

        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_;

        VariableReference size_;

        std::string delimiter_;
      };

      typedef  StringVector   StringArray;
    }
  }
}

#endif // _MADARA_CONTAINERS_STRING_VECTOR_H_