MADARA  3.2.3
ExternFunctionVariables.h
Go to the documentation of this file.
1 
2 #ifndef _MADARA_EXTERNAL_FUNCTION_VARIABLES_H_
3 #define _MADARA_EXTERNAL_FUNCTION_VARIABLES_H_
4 
5 #include <string>
6 #include "madara/MadaraExport.h"
7 #include "madara/knowledge/KnowledgeRecord.h"
8 #include "madara/knowledge/KnowledgeUpdateSettings.h"
9 #include "madara/expression/ExpressionTree.h"
10 #include "madara/knowledge/CompiledExpression.h"
11 #include "madara/knowledge/VariableReference.h"
12 #include "madara/knowledge/FunctionArguments.h"
13 #include "madara/knowledge/Functions.h"
14 
15 #ifdef _MADARA_PYTHON_CALLBACKS_
16 #include "madara/Boost.h"
17 #include "boost/python/object.hpp"
18 #endif
19 
20 #ifdef _MADARA_JAVA_
21  #include <jni.h>
22  #include "madara_jni.h"
23 #endif
24 
33 namespace madara
34 {
35  namespace expression
36  {
37  class CompositeFunctionNode;
38  }
39 
40  namespace knowledge
41  {
42  class ThreadSafeContext;
43  class KnowledgeRecordFilters;
44 
45  typedef madara::knowledge::KnowledgeRecord VALUE_TYPE;
46 
52  class MADARA_EXPORT Variables
53  {
54  public:
55  friend class madara::expression::CompositeFunctionNode;
56  friend class madara::knowledge::KnowledgeRecordFilters;
57 
61  Variables ()
62  : context_ (0)
63  {
64  }
65 
69  Variables (const Variables & rhs)
70  : context_ (rhs.context_)
71  {
72  }
73 
77  void operator= (Variables & rhs);
78 
85  ThreadSafeContext * get_context (void);
86 
93  knowledge::KnowledgeRecord get (const std::string & key,
94  const KnowledgeReferenceSettings & settings =
95  knowledge::KnowledgeReferenceSettings (false));
96 
103  knowledge::KnowledgeRecord get (const VariableReference & variable,
104  const KnowledgeReferenceSettings & settings =
105  knowledge::KnowledgeReferenceSettings (false));
106 
113  VariableReference get_ref (const std::string & key,
114  const KnowledgeReferenceSettings & settings =
115  knowledge::KnowledgeReferenceSettings (false));
116 
124  int set (const std::string & key,
125  madara::knowledge::KnowledgeRecord::Integer value,
126  const KnowledgeUpdateSettings & settings =
127  knowledge::KnowledgeUpdateSettings (
128  false, true, false, false));
129 
137  int set (const VariableReference & variable,
138  madara::knowledge::KnowledgeRecord::Integer value,
139  const KnowledgeUpdateSettings & settings =
140  knowledge::KnowledgeUpdateSettings (
141  false, true, false, false));
142 
151  int set (const std::string & key,
152  const madara::knowledge::KnowledgeRecord::Integer * value,
153  uint32_t size,
154  const KnowledgeUpdateSettings & settings =
155  knowledge::KnowledgeUpdateSettings (
156  false, true, false, false));
157 
166  int set (const VariableReference & variable,
167  const madara::knowledge::KnowledgeRecord::Integer * value,
168  uint32_t size,
169  const KnowledgeUpdateSettings & settings =
170  knowledge::KnowledgeUpdateSettings (
171  false, true, false, false));
172 
180  int set (const std::string & key,
181  const std::vector <KnowledgeRecord::Integer> & value,
182  const KnowledgeUpdateSettings & settings =
183  knowledge::KnowledgeUpdateSettings (
184  false, true, false, false));
185 
193  int set (const VariableReference & variable,
194  const std::vector <KnowledgeRecord::Integer> & value,
195  const KnowledgeUpdateSettings & settings =
196  knowledge::KnowledgeUpdateSettings (
197  false, true, false, false));
198 
206  int set (const std::string & key, double value,
207  const KnowledgeUpdateSettings & settings =
208  knowledge::KnowledgeUpdateSettings (
209  false, true, false, false));
210 
218  int set (const VariableReference & variable, double value,
219  const KnowledgeUpdateSettings & settings =
220  knowledge::KnowledgeUpdateSettings (
221  false, true, false, false));
222 
231  int set (const std::string & key,
232  const double * value,
233  uint32_t size,
234  const KnowledgeUpdateSettings & settings =
235  knowledge::KnowledgeUpdateSettings (
236  false, true, false, false));
237 
246  int set (const VariableReference & variable,
247  const double * value,
248  uint32_t size,
249  const KnowledgeUpdateSettings & settings =
250  knowledge::KnowledgeUpdateSettings (
251  false, true, false, false));
252 
260  int set (const std::string & key,
261  const std::vector <double> & value,
262  const KnowledgeUpdateSettings & settings =
263  knowledge::KnowledgeUpdateSettings (
264  false, true, false, false));
265 
273  int set (const VariableReference & variable,
274  const std::vector <double> & value,
275  const KnowledgeUpdateSettings & settings =
276  knowledge::KnowledgeUpdateSettings (
277  false, true, false, false));
278 
286  int set (const std::string & key, const std::string & value,
287  const KnowledgeUpdateSettings & settings =
288  knowledge::KnowledgeUpdateSettings (
289  false, true, false, false));
290 
298  int set (const VariableReference & variable, const std::string & value,
299  const KnowledgeUpdateSettings & settings =
300  knowledge::KnowledgeUpdateSettings (
301  false, true, false, false));
302 
310  int set (const std::string & key,
311  const madara::knowledge::KnowledgeRecord & value,
312  const KnowledgeUpdateSettings & settings =
313  knowledge::KnowledgeUpdateSettings (
314  false, true, false, false));
315 
323  int set (const VariableReference & variable,
324  const madara::knowledge::KnowledgeRecord & value,
325  const KnowledgeUpdateSettings & settings =
326  knowledge::KnowledgeUpdateSettings (
327  false, true, false, false));
328 
335  knowledge::KnowledgeRecord inc (const std::string & key,
336  const KnowledgeUpdateSettings & settings =
337  knowledge::KnowledgeUpdateSettings (
338  false, true, false, false));
339 
346  knowledge::KnowledgeRecord inc (const VariableReference & variable,
347  const KnowledgeUpdateSettings & settings =
348  knowledge::KnowledgeUpdateSettings (
349  false, true, false, false));
350 
357  knowledge::KnowledgeRecord dec (const std::string & key,
358  const KnowledgeUpdateSettings & settings =
359  knowledge::KnowledgeUpdateSettings (
360  false, true, false, false));
361 
368  knowledge::KnowledgeRecord dec (const VariableReference & variable,
369  const KnowledgeUpdateSettings & settings =
370  knowledge::KnowledgeUpdateSettings (
371  false, true, false, false));
372 
395  void to_string (std::string & target,
396  const std::string & array_delimiter = ",",
397  const std::string & record_delimiter = ";\n",
398  const std::string & key_val_delimiter = "=") const;
399 
404  void print (unsigned int level = 0) const;
405 
412  void print (const std::string & statement, unsigned int level = 0) const;
413 
421  madara::knowledge::KnowledgeRecord retrieve_index (
422  const std::string & key,
423  size_t index,
424  const KnowledgeReferenceSettings & settings =
425  knowledge::KnowledgeReferenceSettings (false));
426 
434  madara::knowledge::KnowledgeRecord retrieve_index (
435  const VariableReference & variable,
436  size_t index,
437  const KnowledgeReferenceSettings & settings =
438  knowledge::KnowledgeReferenceSettings (false));
439 
447  std::string expand_statement (const std::string & statement) const;
448 
453  void apply_modified (
454  const KnowledgeUpdateSettings & settings =
455  knowledge::KnowledgeUpdateSettings ());
456 
464  bool exists (const std::string & key,
465  const KnowledgeReferenceSettings & settings =
466  KnowledgeReferenceSettings (false)) const;
467 
475  bool exists (const VariableReference & variable,
476  const KnowledgeReferenceSettings & settings =
477  KnowledgeReferenceSettings (false)) const;
478 
479 #ifndef _MADARA_NO_KARL_
480 
495  CompiledExpression
496  compile (const std::string & expression);
497 
513  madara::knowledge::KnowledgeRecord evaluate (
514  const std::string & expression,
515  const KnowledgeUpdateSettings & settings =
516  knowledge::KnowledgeUpdateSettings ());
517 
529  madara::knowledge::KnowledgeRecord evaluate (
530  CompiledExpression & expression,
531  const KnowledgeUpdateSettings & settings =
532  knowledge::KnowledgeUpdateSettings ());
533 
539  void define_function (const std::string & name,
540  knowledge::KnowledgeRecord (*func) (FunctionArguments &, Variables &));
541 
548  void define_function (const std::string & name,
549  knowledge::KnowledgeRecord (*func) (const char *, FunctionArguments &, Variables &));
550 
551 #ifdef _MADARA_JAVA_
552 
557  void define_function (const std::string & name, jobject callable);
558 #endif
559 
560 #ifdef _MADARA_PYTHON_CALLBACKS_
561 
566  void define_function (const std::string & name, boost::python::object callable);
567 #endif
568 
574  void define_function (const std::string & name,
575  const std::string & expression);
576 
582  void define_function (const std::string & name,
583  const CompiledExpression & expression);
584 
585 #endif // _MADARA_NO_KARL_
586 
601  size_t to_vector (const std::string & subject,
602  unsigned int start,
603  unsigned int end,
604  std::vector <KnowledgeRecord> & target);
605 
613  void get_matches (
614  const std::string & prefix,
615  const std::string & suffix,
616  VariableReferences & matches);
617 
628  size_t to_map (const std::string & subject,
629  std::map <std::string, knowledge::KnowledgeRecord> & target);
630 
636  int64_t save_as_karl (const std::string & filename) const;
637 
643  int64_t save_context (const std::string & filename);
644 
652  int64_t save_checkpoint (const std::string & filename,
653  bool reset_modifieds = true);
654 
661  int64_t load_context (const std::string & filename,
662  const KnowledgeUpdateSettings & settings =
663  KnowledgeUpdateSettings (true, true, true, false));
664 
671  ssize_t write_file (const std::string & knowledge_key,
672  const std::string & filename);
673 
674  private:
678  ThreadSafeContext * context_;
679  };
680  }
681 }
682 
683 #endif
madara::knowledge::KnowledgeRecord
This class encapsulates an entry in a KnowledgeBase.
Definition: KnowledgeRecord.h:59
madara::knowledge::KnowledgeRecordFilters::context_
ThreadSafeContext * context_
Context used by this filter.
Definition: KnowledgeRecordFilters.h:272
madara::knowledge::ThreadSafeContext
This class stores variables and their values for use by any entity needing state information in a thr...
Definition: ThreadSafeContext.h:75
madara::expression::CompositeFunctionNode
A composite node that calls a function.
Definition: CompositeFunctionNode.h:24
madara::knowledge::VariableReference
Optimized reference to a variable within the knowledge base.
Definition: VariableReference.h:36
madara::knowledge::CompiledExpression
Compiled, optimized KaRL logic.
Definition: CompiledExpression.h:35
madara::knowledge::KnowledgeRecordFilters
Provides map of data types to a filter chain to apply to the data.
Definition: KnowledgeRecordFilters.h:50
madara::knowledge::FunctionArguments
std::vector< KnowledgeRecord > FunctionArguments
Definition: FunctionArguments.h:20
madara::knowledge::tags::string
static struct madara::knowledge::tags::string_t string
madara::knowledge::Variables::context_
ThreadSafeContext * context_
Variables context that is directly used by the KaRL engine.
Definition: ExternFunctionVariables.h:678
madara::knowledge::VALUE_TYPE
madara::knowledge::KnowledgeRecord VALUE_TYPE
Definition: ExternFunctionVariables.h:43
madara::knowledge::VariableReferences
std::vector< VariableReference > VariableReferences
a vector of variable references
Definition: VariableReference.h:101
madara::transport::exists
MADARA_EXPORT bool exists(const char *originator, uint64_t clock, uint32_t update_number, OriginatorFragmentMap &map)
Checks if a fragment already exists within a fragment map.
Definition: Fragmentation.cpp:733
madara::knowledge
Provides functions and classes for the distributed knowledge base.
Definition: AggregateFilter.h:32
madara::knowledge::KnowledgeRecordFilters::operator=
void operator=(const KnowledgeRecordFilters &rhs)
Assignment operator.
Definition: KnowledgeRecordFilters.cpp:41
madara::knowledge::KnowledgeUpdateSettings
Settings for applying knowledge updates.
Definition: KnowledgeUpdateSettings.h:23
madara
Copyright (c) 2015 Carnegie Mellon University.
Definition: AggregateFilter.h:30
madara::knowledge::KnowledgeReferenceSettings
Settings for applying knowledge updates.
Definition: KnowledgeReferenceSettings.h:22
madara::knowledge::Variables
Provides an interface for external functions into the MADARA KaRL variable settings.
Definition: ExternFunctionVariables.h:52
madara::knowledge::Variables::Variables
Variables(const Variables &rhs)
Constructor.
Definition: ExternFunctionVariables.h:69
madara::utility::write_file
ssize_t write_file(const std::string &filename, void *buffer, size_t size)
Writes a file with provided contents.
Definition: Utility.cpp:547