Autowiring  1.0.3
A C++ Inversion of Control Framework
AutoPacketGraph Class Reference

Graphical visualization of AutoPackets More...

#include <AutoPacketGraph.h>

Inheritance diagram for AutoPacketGraph:
CoreRunnable

Public Member Functions

void AutoFilter (AutoPacket &packet)
 Get a copy of the packet via AutoFilter More...
 
bool WriteGV (const std::string &filename, bool numPackets=false) const
 Write the graph to a file in graphviz format More...
 
- Public Member Functions inherited from CoreRunnable
virtual bool IsRunning (void) const
 Reports whether this runnable is currently running.
 
bool ShouldStop (void) volatile const
 Reports whether this runnable should stop.
 
virtual bool Start (std::shared_ptr< CoreObject > outstanding)
 Causes this runnable to begin processing. More...
 
void Stop (bool graceful=true)
 Stops this runnable. More...
 
bool ThreadSleep (std::chrono::nanoseconds timeout)
 Sleeps this thread for the specified duration. More...
 
void Wait (void)
 Waits indefinitely. Returns when this runnable stops. More...
 
bool WaitFor (std::chrono::nanoseconds timeout)
 Waits for the specified amount of time. More...
 
template<typename TimeType >
bool WaitUntil (TimeType timepoint)
 Waits until the specified time. More...
 
bool WasStarted (void) volatile const
 Reports whether this runnable was ever started.
 

Protected Member Functions

void LoadEdges ()
 Scan all of the objects and add any AutoFilter's from all of the objects in a system. More...
 
virtual bool OnStart (void) override
 CoreRunnable overrides.
 
void RecordDelivery (auto_id id, const autowiring::AutoFilterDescriptor &descriptor, DeliveryEdge::ArgType arg_type)
 Record the delivery of a packet and increment the number of times the packet has been delivered More...
 
- Protected Member Functions inherited from CoreRunnable
virtual bool DoAdditionalWait (std::chrono::nanoseconds timeout)
 Invoked just before control is returned to the user. More...
 
virtual void DoAdditionalWait (void)
 Untimed variant of DoAdditionalWait More...
 
const std::shared_ptr< CoreObject > & GetOutstanding (void) const
 
virtual void OnStop (bool graceful)
 Invoked by the base class Stop() method. Override this method to perform any needed cleanup. More...
 

Detailed Description

Graphical visualization of AutoPackets

Member Function Documentation

void AutoPacketGraph::AutoFilter ( AutoPacket packet)

Get a copy of the packet via AutoFilter

void AutoPacketGraph::LoadEdges ( )
protected

Scan all of the objects and add any AutoFilter's from all of the objects in a system.

This function will scan all of the objects (and rescan) and only add new edges to our graph.

void AutoPacketGraph::RecordDelivery ( auto_id  id,
const autowiring::AutoFilterDescriptor &  descriptor,
DeliveryEdge::ArgType  arg_type 
)
protected

Record the delivery of a packet and increment the number of times the packet has been delivered

bool AutoPacketGraph::WriteGV ( const std::string &  filename,
bool  numPackets = false 
) const

Write the graph to a file in graphviz format

Parameters
filenameThe name of the file to write the graph to
numPacketsInclude the number of times the packet was delivered

The documentation for this class was generated from the following file: