docs/developer-guide/opflex-genie-developer-guide.rst

   1 .. _opflex-genie-dev-guide:
   2
   3 OpFlex genie Developer Guide
   4 ============================
   5
   6 Overview
   7 --------
   8
   9 Genie is a tool for code generation from a model. It supports generating
  10 C++ and Java code. C++ can be generated suitable for use with libopflex.
  11 C++ and Java can be generated as a plain set of objects.
  12
  13 Group-based Policy Model
  14 ------------------------
  15
  16 The group-based policy model is included with the genie tool and can be
  17 found under the MODEL directory. By running mvn exec:java, libmodelgbp
  18 will be generated as a library project that, when built and installed,
  19 will work with libopflex. This model is used by the OVS agent.
  20
  21 API Reference Documentation
  22 ---------------------------
  23
  24 Complete API documentation for the generated libmodelgbp can be found
  25 in doc/html/index.html in any build