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

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