docs: Add overview of the structure of vsperf code

Text & sequence diagrams as both source and png.

JIRA: VSPERF-106

Signed-off-by: Billy O'Mahony<billy.o.mahony@intel.com>
Reviewed-by: Al Morton <acmorton@att.com>
Reviewed-by: Eugene Snider <Eugene.Snider@huawei.com>
Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com>
Reviewed-by: Gurpreet Singh <gurpreet.singh@spirent.com>
Reviewed-by: Brian Castelli <brian.castelli@spirent.com>
Change-Id: I33f57fba85710ab4cfc72d0a5d06db6f653545d6

1 files changed, 17 insertions, 0 deletions

diff --git a/docs/msc/factory_and_loader.msc b/docs/msc/factory_and_loader.msc
new file mode 100755
index 00000000..a744607e
--- /dev/null
+++ b/docs/msc/factory_and_loader.msc
@@ -0,0 +1,17 @@
+

+msc {

+

+hscale = "1.5";

+

+ #Entities

+  app, loader, component_factory, traffic_ctlr;

+

+  #Arcs

+  app => loader [label = "get_trafficgen_class()"];

+  loader note loader [label = "searches TRAFFICGEN_DIR for classes implementing ITraffic and matching name configured as TRAFFICGEN"];

+  app << loader [label = "TrafficGenClass"];

+  app => component_factory [label = "create_traffic(traffic_type, TrafficGenClass"];

+  component_factory note component_factory [label = "Component Factory maps from a traffic_type (string) to a TrafficController class"];

+  component_factory => traffic_ctlr [label = "create()"];

+  app << component_factory [label= "traffic_ctlr"];

+ }