sofaswitch-svn
Threads by month
- ----- 2026 -----
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2025 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2024 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2023 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2022 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2021 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2020 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2019 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2018 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2017 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2016 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2015 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2014 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2013 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2012 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2011 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2010 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2009 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2008 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2007 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2006 -----
- December
- November
- October
- September
- August
- July
September 2006
- 2 participants
- 78 discussions
15 Sep '06
Author: derek
Date: Fri Sep 15 01:22:32 2006
New Revision: 95
Modified:
sofaswitch/trunk/callflow/src/shapelist.cpp
Log:
Work on processing request new id messages.
Modified: sofaswitch/trunk/callflow/src/shapelist.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/shapelist.cpp (original)
+++ sofaswitch/trunk/callflow/src/shapelist.cpp Fri Sep 15 01:22:32 2006
@@ -357,18 +357,28 @@
file.AddLine(" eventerNode = self.currentHandlers[keys[k]] ");
file.AddLine(" #print \"eventer node is \", eventerNode ");
file.AddLine(" self.DoWork(self.data[eventerNode][\"Event Handler\"])");
- file.AddLine(" self.generatedEvents.pop(keys[k]) ");
- file.AddLine(" ");
- file.AddLine(" def transferEventToGenerated(self, data): ");
+ file.AddLine(" self.generatedEvents.pop(keys[k]) ");
+ file.AddLine(" ");
+ file.AddLine(" def transferEventToGenerated(self, data): ");
file.AddLine(" \"\"\"An event has happened, and now we need to act on it. Consequently, ");
file.AddLine(" we take it out of the pending list and put it in the process now list");
- file.AddLine(" \"\"\" ");
- file.AddLine(" if self.pendingEvents.has_key(data): ");
+ file.AddLine(" \"\"\" ");
+ file.AddLine(" if self.pendingEvents.has_key(data): ");
file.AddLine(" self.generatedEvents[data] = self.pendingEvents.pop(data)");
- file.AddLine(" ");
- file.AddLine(" def timerObjectExpired(self, data): ");
+ file.AddLine(" ");
+ file.AddLine(" def newRemoteNodeToUse(self, eventName, newNode):");
+ file.AddLine(" \"\"\"This node has received a message advising us that a remote");
+ file.AddLine(" sofa switch entity has created a node for us to use. This method");
+ file.AddLine(" has to transfer the pending event to the generated event queue ");
+ file.AddLine(" and get it activated for processing ");
+ file.AddLine(" \"\"\" ");
+ file.AddLine(" self.transferEventToGenerated(eventName) ");
+ file.AddLine(" reactor.callLater(0, self.processQueue, newNode) ");
+ file.AddLine(" ");
+ file.AddLine(" def timerObjectExpired(self, data): ");
file.AddLine(" \"\"\"Some timer has expired. Move it from the pending list and place ");
- file.AddLine(" it in the active list. Then activate processing so that things move along");
+ file.AddLine(" it in the active list. Then activate processing so that things move ");
+ file.AddLine(" along");
file.AddLine(" \"\"\" ");
file.AddLine(" #print \"timer object has expired \", data ");
file.AddLine(" self.transferEventToGenerated(data) ");
@@ -450,10 +460,13 @@
file.AddLine(" turn it into a MyEvent message, and added to the right ");
file.AddLine(" queue. On doing this, spark an event to drive queue processing. ");
file.AddLine(" \"\"\" ");
- file.AddLine(" #print \"Received \", thisMessage ");
+ file.AddLine(" print \"Received \", thisMessage ");
+ file.AddLine(" if (thisMessage.find(\"REQUESTNEWID\") >=0):");
+ file.AddLine(" pMsg = str(thisMessage).split(\" \") ");
+ file.AddLine(" eName = pMsg(":","") ");
+ file.AddLine("
file.AddLine(" ");
file.AddLine(" ");
-
for (int i = 0; i < DndShape::KnownShapes; i++) {
DndShape *thisShape;
if (i == DndShape::None)
1
0
15 Sep '06
Author: derek
Date: Thu Sep 14 22:44:56 2006
New Revision: 94
Modified:
sofaswitch/trunk/callflow/src/requestnode.cpp
Log:
Add units to title.
Modified: sofaswitch/trunk/callflow/src/requestnode.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/requestnode.cpp (original)
+++ sofaswitch/trunk/callflow/src/requestnode.cpp Thu Sep 14 22:44:56 2006
@@ -30,7 +30,7 @@
InformationSection(wxT("Request node from"), wxT("voip"));
displayData[displayData.size()] =
- InformationSection(wxT("Timer period"), wxT("1"));
+ InformationSection(wxT("Timer period (seconds)"), wxT("1"));
displayData[displayData.size()] =
InformationSection(wxT("Timer label"), wxT("request node"));
1
0
15 Sep '06
Author: derek
Date: Thu Sep 14 22:43:05 2006
New Revision: 93
Modified:
sofaswitch/trunk/callflow/src/requestnode.cpp
sofaswitch/trunk/callflow/src/timer.cpp
Log:
Work on the handling of request node at some other sofaswitch entity.
Modified: sofaswitch/trunk/callflow/src/requestnode.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/requestnode.cpp (original)
+++ sofaswitch/trunk/callflow/src/requestnode.cpp Thu Sep 14 22:43:05 2006
@@ -27,8 +27,15 @@
SetSize(newSize);
displayData[displayData.size()] =
- InformationSection(wxT("request node from "), wxT("voip"));
+ InformationSection(wxT("Request node from"), wxT("voip"));
+
+ displayData[displayData.size()] =
+ InformationSection(wxT("Timer period"), wxT("1"));
+ displayData[displayData.size()] =
+ InformationSection(wxT("Timer label"), wxT("request node"));
+
+
relInputPoints.Add(25, 0);
relOutputPoints.Add(25, 50);
AdjustIoPoints();
@@ -65,32 +72,43 @@
bool DndShapeRequestNode::WriteSystemCode(wxTextFile & file)
{
- file.AddLine(" def Request_Node(self, aTuple): ");
- file.AddLine(" id,y,z = aTuple");
- file.AddLine(" return data[id][\"Output\"]");
+ file.AddLine(" def Request_Node(self, aTuple): ");
+ file.AddLine(" a,y,z = aTuple ");
+ file.AddLine(" eName = self.data[a][\"Timer label\"] ");
+ file.AddLine(" self.pendingEvents[eName] = a ");
+ file.AddLine(" reactor.callLater(self.data[a][\"Timer period\"], self.timerObjectExpired, eName)");
+ file.AddLine(" rhost = self.data[a][\"Request node from\"] ");
+ file.AddLine(" rhost += \":REQUESTNEWID\\0\" ");
+ file.AddLine(" self.transport.write(rhost) ");
+ file.AddLine(" return self.data[a][\"Output\"] ");
file.AddLine("");
return true;
}
bool DndShapeRequestNode::WriteThisShapeInfo(wxTextFile & file)
{
- file.AddLine(wxString::Format("\"%s\" : { ", GetKey().c_str()));
+ file.AddLine(wxString::Format(" \"%s\" : { ", GetKey().c_str()));
wxNode *inputNode = (wxNode *)GetInputPoints().GetFirst();
const wxString & inputLabel = ((LabelledPoint *)inputNode->GetData())->GetFullLabel();
- file.AddLine(wxString::Format(" \"Input\" : "));
- file.AddLine(wxString::Format(" %s, ", inputLabel.c_str()));
+ file.AddLine(wxString::Format(" \"Input\" : "));
+ file.AddLine(wxString::Format(" %s, ", inputLabel.c_str()));
wxNode *outputNode = (wxNode *)GetOutputPoints().GetFirst();
const wxString & outputLabel = ((LabelledPoint *)outputNode->GetData())->GetFullLabel();
- file.AddLine(wxString::Format(" \"Output\" : "));
- file.AddLine(wxString::Format(" %s, ", outputLabel.c_str()));
+ file.AddLine(wxString::Format(" \"Output\" : "));
+ file.AddLine(wxString::Format(" %s, ", outputLabel.c_str()));
+ file.AddLine(wxString::Format(" \"Request node from\" : "));
+ file.AddLine(wxString::Format(" \"%s\", ", displayData[1].data.c_str()));
- file.AddLine(wxString::Format(" \"request node from\" : "));
- file.AddLine(wxString::Format(" \"%s\", ", displayData[1].data.c_str()));
+ file.AddLine(wxString::Format(" \"Timer period\" : "));
+ file.AddLine(wxString::Format(" %s, ", displayData[2].data.c_str()));
- file.AddLine(wxString::Format(" },"));
+ file.AddLine(wxString::Format(" \"Timer label\" : "));
+ file.AddLine(wxString::Format(" \"%s\", ", displayData[3].data.c_str()));
+
+ file.AddLine(wxString::Format(" },"));
return true;
}
Modified: sofaswitch/trunk/callflow/src/timer.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/timer.cpp (original)
+++ sofaswitch/trunk/callflow/src/timer.cpp Thu Sep 14 22:43:05 2006
@@ -57,6 +57,7 @@
void DndShapeTimer::Draw(wxDC& dc)
{
+ dc.SetPen(*wxBLACK_PEN);
DrawCompileError(dc);
wxPoint p1(m_rect.GetPosition());
1
0
14 Sep '06
Author: derek
Date: Thu Sep 14 19:45:30 2006
New Revision: 92
Modified:
sofaswitch/trunk/callflow/src/callflow.cpp
sofaswitch/trunk/callflow/src/callflow.h
Log:
Get it to compile after the doxygen related tidyups.
Add a dialog to confirm closing.
Modified: sofaswitch/trunk/callflow/src/callflow.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/callflow.cpp (original)
+++ sofaswitch/trunk/callflow/src/callflow.cpp Thu Sep 14 19:45:30 2006
@@ -142,11 +142,6 @@
Controls_menu -> Append ( wxH_CONTROLSFOR, wxT("for"), wxT(""));
Controls_menu -> Append ( wxH_CONTROLSEND_FOR, wxT("end for"), wxT(""));
Controls_menu -> Append ( wxH_CONTROLSPYTHON, wxT("python"), wxT(""));
- Controls_menu -> Append ( wxH_CONTROLSMAKE_CALL, wxT("make call"), wxT(""));
- Controls_menu -> Append ( wxH_CONTROLSJOIN_CONFERENCE, wxT("join conference"), wxT(""));
- Controls_menu -> Append ( wxH_CONTROLSMAKE_CONFERENCE, wxT("make conference"), wxT(""));
- Controls_menu -> Append ( wxH_CONTROLSJOIN_PLAY_HRECORD, wxT("join play/record"), wxT(""));
- Controls_menu -> Append ( wxH_CONTROLSMAKE_PLAY_HRECORD, wxT("make play/record"), wxT(""));
Controls_menu -> Append ( wxH_CONTROLSCONNECT_OBJECTS, wxT("connect objects"), wxT(""));
Help_menu -> Append ( wxH_HELPMANUAL, wxT("Manual"), wxT(""));
Help_menu -> AppendSeparator () ;
@@ -173,9 +168,12 @@
void MyFrame::OnClose (wxCloseEvent& event)
{
-
- // event.Skip();
- // or event.Veto();
+ int answer = wxMessageBox("Quit program?", "Confirm",
+ wxYES_NO, this);
+ if (answer == wxYES)
+ event.Skip();
+ else
+ event.Veto();
}
@@ -264,7 +262,7 @@
void MyFrame::OnFileE_xit (wxCommandEvent & WXUNUSED(event))
{
//Respond to menu here
- exit(0);
+ Close();
}
@@ -381,45 +379,10 @@
}
-void MyFrame::OnControlsmake_call (wxCommandEvent & WXUNUSED(event))
-{
- //Respond to menu here
- SetStatusText("Make a call");
-}
-
-
-void MyFrame::OnControlsjoin_conference (wxCommandEvent & WXUNUSED(event))
-{
- //Respond to menu here
- SetStatusText("Join a conference");
-}
-
-
-void MyFrame::OnControlsmake_conference (wxCommandEvent & WXUNUSED(event))
-{
- //Respond to menu here
- SetStatusText("Make a conference");
-}
-
-
-void MyFrame::OnControlsjoin_play_Hrecord (wxCommandEvent & WXUNUSED(event))
-{
- //Respond to menu here
- SetStatusText("Join play record");
-}
-
-
-void MyFrame::OnControlsmake_play_Hrecord (wxCommandEvent & WXUNUSED(event))
-{
- //Respond to menu here
- SetStatusText("Make a play record thing");
-}
-
-
void MyFrame::OnHelpManual (wxCommandEvent & WXUNUSED(event))
{
//Respond to menu here
- SetStatusText("Get manual");
+ SetStatusText("Get manual has to be written");
}
Modified: sofaswitch/trunk/callflow/src/callflow.h
==============================================================================
--- sofaswitch/trunk/callflow/src/callflow.h (original)
+++ sofaswitch/trunk/callflow/src/callflow.h Thu Sep 14 19:45:30 2006
@@ -140,7 +140,7 @@
void OnControlsConnectObjects(wxCommandEvent & event);
/**Called in response to a user comand to turn the current graph into executable
- python code */.
+ python code */
void OnCompile(wxCommandEvent & event);
/**Called in response to a user comand to display the current help file */
1
0
14 Sep '06
Author: derek
Date: Thu Sep 14 19:31:09 2006
New Revision: 91
Modified:
sofaswitch/trunk/callflow/Makefile.am
sofaswitch/trunk/callflow/src/callflow.cpp
sofaswitch/trunk/callflow/src/callflow.h
sofaswitch/trunk/callflow/src/canvas.h
sofaswitch/trunk/callflow/src/dnd.h
sofaswitch/trunk/callflow/src/shapelist.cpp
Log:
Add doxygen comments everywhere.
Remove surplus methods.
Modified: sofaswitch/trunk/callflow/Makefile.am
==============================================================================
--- sofaswitch/trunk/callflow/Makefile.am (original)
+++ sofaswitch/trunk/callflow/Makefile.am Thu Sep 14 19:31:09 2006
@@ -3,3 +3,7 @@
MAKEFLAGS=-j$(shell cat /proc/cpuinfo | grep processor | wc -l)
SUBDIRS = src
+
+docs:
+ doxygen callflow.dxy
+
Modified: sofaswitch/trunk/callflow/src/callflow.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/callflow.cpp (original)
+++ sofaswitch/trunk/callflow/src/callflow.cpp Thu Sep 14 19:31:09 2006
@@ -67,11 +67,6 @@
EVT_MENU ( wxH_EDITCUT, MyFrame::OnEditCut)
EVT_MENU ( wxH_HELPABOUT, MyFrame::OnHelpAbout)
EVT_MENU ( wxH_HELPMANUAL, MyFrame::OnHelpManual)
- EVT_MENU ( wxH_CONTROLSMAKE_PLAY_HRECORD, MyFrame::OnControlsmake_play_Hrecord)
- EVT_MENU ( wxH_CONTROLSJOIN_PLAY_HRECORD, MyFrame::OnControlsjoin_play_Hrecord)
- EVT_MENU ( wxH_CONTROLSMAKE_CONFERENCE, MyFrame::OnControlsmake_conference)
- EVT_MENU ( wxH_CONTROLSJOIN_CONFERENCE, MyFrame::OnControlsjoin_conference)
- EVT_MENU ( wxH_CONTROLSMAKE_CALL, MyFrame::OnControlsmake_call)
EVT_MENU ( wxH_CONTROLSREQUESTNODE, MyFrame::OnControlsrequestnode)
EVT_MENU ( wxH_CONTROLSPYTHON, MyFrame::OnControlspython)
EVT_MENU ( wxH_CONTROLSEND_FOR, MyFrame::OnControlsend_for)
@@ -171,7 +166,7 @@
InitToolBar(GetToolBar());
CreateStatusBar();
- SetStatusText(" Hello ");
+ SetStatusText(" Welcome to Call Flow. ");
}
@@ -234,6 +229,7 @@
if (file.IsOpened()) {
file.Close();
canvas->ShapeInformationToFile(currentFileName);
+ SetStatusText(wxString::Format("Saved source code to %s", currentFileName.c_str()));
} else {
wxMessageBox(wxString::Format("Unable to open the file %s for saving", currentFileName.c_str()));
return;
@@ -261,6 +257,7 @@
currentFileName = filedlg.GetPath();
file.Close();
canvas->ShapeInformationToFile(currentFileName);
+ SetStatusText(wxString::Format("Saved source code to %s", currentFileName.c_str()));
}
Modified: sofaswitch/trunk/callflow/src/callflow.h
==============================================================================
--- sofaswitch/trunk/callflow/src/callflow.h (original)
+++ sofaswitch/trunk/callflow/src/callflow.h Thu Sep 14 19:31:09 2006
@@ -5,7 +5,8 @@
#include "dnd.h"
class MyCanvas;
-
+/**Enumerate over the different values that the GUI can generate. Each value
+ means to do some action on the flow chart */
enum
{
// menu IDs these two are needed by wxHatch
@@ -26,11 +27,6 @@
wxH_CONTROLSFOR,
wxH_CONTROLSEND_FOR,
wxH_CONTROLSPYTHON,
- wxH_CONTROLSMAKE_CALL,
- wxH_CONTROLSJOIN_CONFERENCE,
- wxH_CONTROLSMAKE_CONFERENCE,
- wxH_CONTROLSJOIN_PLAY_HRECORD,
- wxH_CONTROLSMAKE_PLAY_HRECORD,
wxH_CONTROLSCONNECT_OBJECTS,
wxH_CONTROLSCOMPILE,
wxH_HELPMANUAL,
@@ -41,58 +37,141 @@
wxH_QUIT
};
+/**The global class, which describes this application. Instantiating this
+ class intiates everything to happen */
class MyApp: public wxApp
{
public:
+ /**Called on construction by wx widgets code, at which point we can
+ * initialise, and define all the menus etc. */
virtual bool OnInit();
};
-
+/**Create the main window that displays this running application */
class MyFrame: public wxFrame
{
public:
+ /**Constructor */
MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size);
+ /**Destructor */
~MyFrame ();
+ /**Called in response to a shutdown command issued from somewhere */
void OnClose (wxCloseEvent& event);
+
+ /**Called in response to a user comand to start over with a new blank
+ screen */
void OnFileNew (wxCommandEvent & event);
+
+ /**Called in response to a user comand to read in an existing graph */
void OnFileOpen (wxCommandEvent & event);
+
+ /**Called in response to a user comand to save current graph to a file.
+ This will save the current graph to the current name. If no such current
+ name is stored, it will ask for a new name.*/
void OnFileSave (wxCommandEvent & event);
+
+ /**Called in response to a user comand to save the current graph to
+ some specified file - the user will have a requester asking to
+ what file to write to */
void OnFileSave__As (wxCommandEvent & event);
+
+ /**Called in response to a user comand to shutdown this program */
void OnFileE_xit (wxCommandEvent & event);
+ /**Generic method to initialise the tool bar. This will add all our custom icons
+ to the tool bar.*/
void InitToolBar(wxToolBar* toolBar);
+
+ /**Called in response to a user comand to add a "Start here" widget to the
+ current graph */
void OnControlsstarthere (wxCommandEvent & event);
+
+ /**Called in response to a user comand to add a "Stop Here" widget to the
+ current graph */
void OnControlsendhere (wxCommandEvent & event);
+
+ /**Called in response to a user comand to add a "request worker" widget to
+ the current graph. This will ask of the remote supervisor for a node to
+ handle some audio functionality. */
void OnControlsrequestnode (wxCommandEvent & event);
+
+ /**Called in response to a user comand to add a "End" ??? widget to the
+ current graph */
void OnControlsend (wxCommandEvent & event);
+
+ /**Called in response to a user comand to add a "Event catcher" widget to
+ the current graph. These widgets have two outputs - a)for an event, or
+ for continuing the proessing of the graph. */
void OnControlsEventer (wxCommandEvent & event);
+
+ /**Called in response to a user comand to add a "Conditional", or if
+ statement type widget to the current graph */
void OnControlsif (wxCommandEvent & event);
+
+ /**Called in response to a user comand to add a "For loop" widget to the
+ current graph */
void OnControlsfor (wxCommandEvent & event);
+
+ /**Called in response to a user comand to add a "End of for loop" widget
+ to the current graph. */
void OnControlsend_for (wxCommandEvent & event);
+
+ /**Called in response to a user comand to add a "Python" widget to the
+ current graph. This widget allows the user to add their own special
+ python code for processing. One such use is print statements.*/
void OnControlspython (wxCommandEvent & event);
+
+ /**Called in response to a user comand to add a "Stop Timer" widget to the
+ current graph. This is used when an event has been detected before a
+ timer has timed out, so the timer needs to be stopped. */
void OnControlsStopTimer (wxCommandEvent & event);
+
+ /**Called in response to a user comand to add a "Timer" widget to the
+ current graph. This starts a timer, which will generate an event of the
+ specified name. */
void OnControlsTimer (wxCommandEvent & event);
- void OnControlsmake_call (wxCommandEvent & event);
- void OnControlsjoin_conference (wxCommandEvent & event);
- void OnControlsmake_conference (wxCommandEvent & event);
- void OnControlsjoin_play_Hrecord (wxCommandEvent & event);
- void OnControlsmake_play_Hrecord (wxCommandEvent & event);
+
+ /**Called in response to a user comand to add a "Draw Line Segment" widget
+ to the current graph. The multiple line segment object is used to join
+ two widgets on the screen */
void OnControlsConnectObjects(wxCommandEvent & event);
+
+ /**Called in response to a user comand to turn the current graph into executable
+ python code */.
void OnCompile(wxCommandEvent & event);
+
+ /**Called in response to a user comand to display the current help file */
void OnHelpManual (wxCommandEvent & event);
+
+ /**Called in response to a user comand to display the brief synopsis of
+ this project */
void OnHelpAbout (wxCommandEvent & event);
+
+ /**Called in response to a user command to cut the selected widgets from the
+ current graph */
void OnEditCut (wxCommandEvent & event);
+
+ /**Called in response to a user command to copy the selected widgets in the current
+ graph to the clipboard */
void OnEditCopy (wxCommandEvent & event);
+
+ /**Called in response to a user comand to copy the contents of the
+ clipboard to the current graph */
void OnEditPaste (wxCommandEvent & event);
DECLARE_EVENT_TABLE()
public:
+ /**Report the shape that we much add to the current graph. This shape
+ would be, for example, a Conditional (or if) if the user had just sent
+ a MyFrame::OnControlsif() command */
DndShape::Kind GetImageTypeForPlacing() const { return imageTypeForPlacing; }
-
+ /**Undo the current variable - so we are now not ready to place a new
+ shape in the current graph. It is, partly, the opposite of the the
+ "GetImageTypeForPlacing" method. */
void ClearImageTypeForPlacing() { imageTypeForPlacing = DndShape::None; }
/**Following a click on the tool bar, we are now editing in a
@@ -106,8 +185,10 @@
void CloseJoinBlocks();
protected:
+ /**The shape that we much add to the current graph. This shape would be,
+ for example, a Conditional (or if) if the user had just sent a
+ MyFrame::OnControlsif() command */
DndShape::Kind imageTypeForPlacing;
-
/**The name of the file we are currently editing */
wxString currentFileName;
Modified: sofaswitch/trunk/callflow/src/canvas.h
==============================================================================
--- sofaswitch/trunk/callflow/src/canvas.h (original)
+++ sofaswitch/trunk/callflow/src/canvas.h Thu Sep 14 19:31:09 2006
@@ -12,6 +12,9 @@
/////////////////////////////////////////////////////////////////////////////
+/**Class that describes activity on the area inside the scrollbars, titlebars
+ etc. It is on this Canvas that the current graph is drawn. This class
+ contains callbacks for the different mouse events that influence drawing */
class MyCanvas: public wxScrolledWindow
{
public:
@@ -117,7 +120,7 @@
/**Send the curent active shapes to be compiled, and save output
to the specified file.
- Return true on success, false on failure */
+ @return true on success, false on failure */
bool Compile(wxTextFile & file)
{ return activeShapes.Compile(file); }
Modified: sofaswitch/trunk/callflow/src/dnd.h
==============================================================================
--- sofaswitch/trunk/callflow/src/dnd.h (original)
+++ sofaswitch/trunk/callflow/src/dnd.h Thu Sep 14 19:31:09 2006
@@ -229,7 +229,7 @@
output points to be linked. DndShape::Eventer, for example, only requires
one of the output points to be linked.
- @params index is the position in the list, and values are 0, 1, 2 ....*/
+ @param index is the position in the list, and values are 0, 1, 2 ....*/
bool PointLinked(int index);
protected:
Modified: sofaswitch/trunk/callflow/src/shapelist.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/shapelist.cpp (original)
+++ sofaswitch/trunk/callflow/src/shapelist.cpp Thu Sep 14 19:31:09 2006
@@ -36,18 +36,18 @@
void MyListShapesExtended::RemoveSelectedShapes()
{
- MyListShapes::iterator it = begin();
- while (it != end()) {
- MyListShapes::iterator it_del = it;
- it++;
-
- if (it_del->second != NULL) {
- if (it_del->second->IsSelected()) {
- delete it_del->second;
+ MyListShapes::iterator it = begin();
+ while (it != end()) {
+ MyListShapes::iterator it_del = it;
+ it++;
+
+ if (it_del->second != NULL) {
+ if (it_del->second->IsSelected()) {
+ delete it_del->second;
+ erase (it_del);
+ }
}
- erase (it_del);
}
- }
}
void MyListShapesExtended::RemoveCurrentShapes()
@@ -56,8 +56,8 @@
while (it != end()) {
MyListShapes::iterator it_del = it;
it++;
-
- delete it_del->second;
+ if (it_del->second != NULL)
+ delete it_del->second;
erase (it_del);
}
}
1
0
Author: derek
Date: Thu Sep 14 19:30:26 2006
New Revision: 90
Added:
sofaswitch/trunk/callflow/callflow.dxy
sofaswitch/trunk/callflow/overview.dxy
Log:
Add doxygen control file, and overview description.
This will have to be extended to contain a full "howto" on use.
Added: sofaswitch/trunk/callflow/callflow.dxy
==============================================================================
--- (empty file)
+++ sofaswitch/trunk/callflow/callflow.dxy Thu Sep 14 19:30:26 2006
@@ -0,0 +1,1238 @@
+# Doxyfile 1.4.6
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a hash (#) is considered a comment and will be ignored
+# The format is:
+# TAG = value [value, ...]
+# For lists items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ")
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
+# by quotes) that should identify the project.
+
+PROJECT_NAME = CallFlow
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
+# This could be handy for archiving the generated documentation or
+# if some version control system is used.
+
+PROJECT_NUMBER = 0.0.1
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# If a relative path is entered, it will be relative to the location
+# where doxygen was started. If left blank the current directory will be used.
+
+OUTPUT_DIRECTORY = .
+
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
+# 4096 sub-directories (in 2 levels) under the output directory of each output
+# format and will distribute the generated files over these directories.
+# Enabling this option can be useful when feeding doxygen a huge amount of
+# source files, where putting all generated files in the same directory would
+# otherwise cause performance problems for the file system.
+
+CREATE_SUBDIRS = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# The default language is English, other supported languages are:
+# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
+# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
+# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
+# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
+# Swedish, and Ukrainian.
+
+OUTPUT_LANGUAGE = English
+
+# This tag can be used to specify the encoding used in the generated output.
+# The encoding is not always determined by the language that is chosen,
+# but also whether or not the output is meant for Windows or non-Windows users.
+# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
+# forces the Windows encoding (this is the default for the Windows binary),
+# whereas setting the tag to NO uses a Unix-style encoding (the default for
+# all platforms other than Windows).
+
+USE_WINDOWS_ENCODING = NO
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
+# include brief member descriptions after the members that are listed in
+# the file and class documentation (similar to JavaDoc).
+# Set to NO to disable this.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+
+REPEAT_BRIEF = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator
+# that is used to form the text in various listings. Each string
+# in this list, if found as the leading text of the brief description, will be
+# stripped from the text and the result after processing the whole list, is
+# used as the annotated text. Otherwise, the brief description is used as-is.
+# If left blank, the following values are used ("$name" is automatically
+# replaced with the name of the entity): "The $name class" "The $name widget"
+# "The $name file" "is" "provides" "specifies" "contains"
+# "represents" "a" "an" "the"
+
+ABBREVIATE_BRIEF =
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# Doxygen will generate a detailed section even if there is only a brief
+# description.
+
+ALWAYS_DETAILED_SEC = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
+# path before files name in the file list and in the header files. If set
+# to NO the shortest path that makes the file name unique will be used.
+
+FULL_PATH_NAMES = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user-defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the
+# path to strip.
+
+STRIP_FROM_PATH =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
+# the path mentioned in the documentation of a class, which tells
+# the reader which header file to include in order to use a class.
+# If left blank only the name of the header file containing the class
+# definition is used. Otherwise one should specify the include paths that
+# are normally passed to the compiler using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful is your file systems
+# doesn't support long names like on DOS, Mac, or CD-ROM.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
+# will interpret the first line (until the first dot) of a JavaDoc-style
+# comment as the brief description. If set to NO, the JavaDoc
+# comments will behave just like the Qt-style comments (thus requiring an
+# explicit @brief command for a brief description.
+
+JAVADOC_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
+# comments) as a brief description. This used to be the default behaviour.
+# The new default is to treat a multi-line C++ comment block as a detailed
+# description. Set this tag to YES if you prefer the old behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the DETAILS_AT_TOP tag is set to YES then Doxygen
+# will output the detailed description near the top, like JavaDoc.
+# If set to NO, the detailed description appears after the member
+# documentation.
+
+DETAILS_AT_TOP = NO
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# re-implements.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
+# a new page for each member. If set to NO, the documentation of a member will
+# be part of the file/class/namespace that contains it.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
+# Doxygen uses this value to replace tabs by spaces in code fragments.
+
+TAB_SIZE = 8
+
+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
+# put the command \sideeffect (or @sideeffect) in the documentation, which
+# will result in a user-defined paragraph with heading "Side Effects:".
+# You can put \n's in the value part of an alias to insert newlines.
+
+ALIASES =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
+# sources only. Doxygen will then generate output that is more tailored for C.
+# For instance, some of the names that are used will be different. The list
+# of all members will be omitted, etc.
+
+OPTIMIZE_OUTPUT_FOR_C = NO
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
+# sources only. Doxygen will then generate output that is more tailored for Java.
+# For instance, namespaces will be presented as packages, qualified scopes
+# will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
+# include (a tag file for) the STL sources as input, then you should
+# set this tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+# func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
+# the same type (for instance a group of public functions) to be put as a
+# subgroup of that type (e.g. under the Public Functions section). Set it to
+# NO to prevent subgrouping. Alternatively, this can be done per class using
+# the \nosubgrouping command.
+
+SUBGROUPING = YES
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available.
+# Private class members and static file members will be hidden unless
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE = NO
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+
+EXTRACT_STATIC = YES
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. When set to YES local
+# methods, which are defined in the implementation section but not in
+# the interface are included in the documentation.
+# If set to NO (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) these members will be included in the
+# various overviews, but no documentation section is generated.
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES = YES
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+# documentation blocks found inside the body of a function.
+# If set to NO (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation
+# that is typed after a \internal command is included. If the tag is set
+# to NO (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
+# file names in lower-case letters. If set to YES upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
+
+CASE_SENSE_NAMES = YES
+
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
+# will show members with their full class and namespace scopes in the
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
+# will sort the (detailed) documentation of file and class members
+# alphabetically by member name. If set to NO the members will appear in
+# declaration order.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
+# sorted by fully-qualified names, including namespaces. If set to
+# NO (the default), the class list will be sorted only by class name,
+# not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the
+# alphabetical list.
+
+SORT_BY_SCOPE_NAME = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
+# disable (NO) the todo list. This list is created by putting \todo
+# commands in the documentation.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting \test
+# commands in the documentation.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting \bug
+# commands in the documentation.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
+# disable (NO) the deprecated list. This list is created by putting
+# \deprecated commands in the documentation.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if sectionname ... \endif.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or define consists of for it to appear in
+# the documentation. If the initializer consists of more lines than specified
+# here it will be hidden. Use a value of 0 to hide initializers completely.
+# The appearance of the initializer of individual variables and defines in the
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES = YES
+
+# If the sources in your project are distributed over multiple directories
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
+# in the documentation. The default is NO.
+
+SHOW_DIRECTORIES = NO
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from the
+# version control system). Doxygen will invoke the program by executing (via
+# popen()) the command <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
+# provided by doxygen. Whatever the program writes to standard output
+# is used as the file version. See the manual for examples.
+
+FILE_VERSION_FILTER =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS = YES
+
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
+# automatically be disabled.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some
+# parameters in a documented function, or documenting parameters that
+# don't exist or using markup commands wrongly.
+
+WARN_IF_DOC_ERROR = YES
+
+# This WARN_NO_PARAMDOC option can be abled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that
+# doxygen can produce. The string should contain the $file, $line, and $text
+# tags, which will be replaced by the file and line number from which the
+# warning originated and the warning text. Optionally the format may contain
+# $version, which will be replaced by the version of the file (if it could
+# be obtained via FILE_VERSION_FILTER)
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
+# to stderr.
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT = ./overview.dxy src/
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
+
+FILE_PATTERNS =
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
+# should be searched for input files as well. Possible values are YES and NO.
+# If left blank NO is used.
+
+RECURSIVE = YES
+
+# The EXCLUDE tag can be used to specify files and/or directories that should
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
+# directories that are symbolic links (a Unix filesystem feature) are excluded
+# from the input.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or
+# directories that contain example code fragments that are included (see
+# the \include command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank all files are included.
+
+EXAMPLE_PATTERNS =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude
+# commands irrespective of the value of the RECURSIVE tag.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are included in the documentation (see
+# the \image command).
+
+IMAGE_PATH =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
+# input file. Doxygen will then use the output that the filter program writes
+# to standard output. If FILTER_PATTERNS is specified, this tag will be
+# ignored.
+
+INPUT_FILTER =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form:
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
+# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
+# is applied to all files.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
+# be generated. Documented entities will be cross-referenced with these sources.
+# Note: To get rid of all source code in the generated output, make sure also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C and C++ comments will always remain visible.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES (the default)
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = YES
+
+# If the REFERENCES_RELATION tag is set to YES (the default)
+# then for each documented function all documented entities
+# called/used by that function will be listed.
+
+REFERENCES_RELATION = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code
+# will point to the HTML generated by the htags(1) tool instead of doxygen
+# built-in source browser. The htags tool is part of GNU's global source
+# tagging system (see http://www.gnu.org/software/global/global.html) You
+# will need version 4.8.6 or higher.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
+# will generate a verbatim copy of the header file for each class for
+# which an include is specified. Set to NO to disable this.
+
+VERBATIM_HEADERS = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
+# of all compounds will be generated. Enable this if the project
+# contains a lot of classes, structs, unions or interfaces.
+
+ALPHABETICAL_INDEX = NO
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
+# style sheet that is used by each HTML page. It can be used to
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
+# will generate a default style sheet. Note that doxygen will try to copy
+# the style sheet file to the HTML output directory, so don't put your own
+# stylesheet in the HTML output directory as well, or it will be erased!
+
+HTML_STYLESHEET =
+
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
+# files or namespaces will be aligned in HTML using tables. If set to
+# NO a bullet list will be used.
+
+HTML_ALIGN_MEMBERS = YES
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+# be used to specify the file name of the resulting .chm file. You
+# can add a path in front of the file if the result should not be
+# written to the html output directory.
+
+CHM_FILE =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
+# be used to specify the location (absolute path including file name) of
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
+# the HTML help compiler on the generated index.hhp.
+
+HHC_LOCATION =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
+# controls if a separate .chi index file is generated (YES) or that
+# it should be included in the master .chm file (NO).
+
+GENERATE_CHI = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
+# controls whether a binary table of contents is generated (YES) or a
+# normal table of contents (NO) in the .chm file.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the HTML help documentation and to the tree view.
+
+TOC_EXPAND = NO
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
+# top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it.
+
+DISABLE_INDEX = NO
+
+# This tag can be used to set the number of enum values (range [1..20])
+# that doxygen will group on one line in the generated HTML documentation.
+
+ENUM_VALUES_PER_LINE = 4
+
+# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
+# generated containing a tree-like index structure (just like the one that
+# is generated for HTML Help). For this to work a browser that supports
+# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
+# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
+# probably better off using the HTML help feature.
+
+GENERATE_TREEVIEW = NO
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
+# used to set the initial width (in pixels) of the frame in which the tree
+# is shown.
+
+TREEVIEW_WIDTH = 250
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, a4wide, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE = a4wide
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS = NO
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX = NO
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE = NO
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
+# in the output.
+
+LATEX_HIDE_INDICES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimized for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD =
+
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
+# dump the program listings (including syntax highlighting
+# and cross-referencing information) to the XML output. Note that
+# enabling this will significantly increase the size of the XML output.
+
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
+# to generate PDF and DVI output from the Perl module output.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader. This is useful
+# if you want to understand what is going on. On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# in the INCLUDE_PATH (see below) will be search if a #include is found.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
+
+PREDEFINED = DOCPLUSLUS \
+ DOC_PLUS_PLUS
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to specify a list of macro names that should be expanded.
+# The macro definition that is found in the sources will be used.
+# Use the PREDEFINED tag if you want to use a different macro definition.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
+# doxygen's preprocessor will remove all function-like macros that are alone
+# on a line, have an all uppercase name, and do not end with a semicolon. Such
+# function macros are typically used for boiler-plate code, and will confuse
+# the parser if not removed.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES option can be used to specify one or more tagfiles.
+# Optionally an initial location of the external documentation
+# can be added for each tagfile. The format of a tag file without
+# this location is as follows:
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths or
+# URLs. If a location is present for each tag, the installdox tool
+# does not have to be run to correct the links.
+# Note that each tag file must have a unique name
+# (where the name does NOT include the path)
+# If a tag file is not located in the directory in which doxygen
+# is run, you must also specify the path to the tagfile here.
+
+TAGFILES =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
+# will be listed.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will
+# be listed.
+
+EXTERNAL_GROUPS = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
+# this option is superseded by the HAVE_DOT option below. This is only a
+# fallback. It is recommended to install and use dot, since it yields more
+# powerful graphs.
+
+CLASS_DIAGRAMS = YES
+
+# If set to YES, the inheritance and collaboration graphs will hide
+# inheritance and usage relations if the target is undocumented
+# or is not a class.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz, a graph visualization
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
+# have no effect if this option is set to NO (the default)
+
+HAVE_DOT = YES
+
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect inheritance relations. Setting this tag to YES will force the
+# the CLASS_DIAGRAMS tag to NO.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect implementation dependencies (inheritance, containment, and
+# class references variables) of the class with other documented classes.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for groups, showing the direct groups dependencies
+
+GROUP_GRAPHS = YES
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+
+UML_LOOK = NO
+
+# If set to YES, the inheritance and collaboration graphs will show the
+# relations between templates and their instances.
+
+TEMPLATE_RELATIONS = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
+# tags are set to YES then doxygen will generate a graph for each documented
+# file showing the direct and indirect include dependencies of the file with
+# other documented files.
+
+INCLUDE_GRAPH = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
+# indirectly include this file.
+
+INCLUDED_BY_GRAPH = YES
+
+# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
+# generate a call dependency graph for every global function or class method.
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable call graphs for selected
+# functions only using the \callgraph command.
+
+CALL_GRAPH = NO
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
+# will graphical hierarchy of all classes instead of a textual one.
+
+GRAPHICAL_HIERARCHY = YES
+
+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
+# then doxygen will show the dependencies a directory has on other directories
+# in a graphical way. The dependency relations are determined by the #include
+# relations between the files in the directories.
+
+DIRECTORY_GRAPH = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. Possible values are png, jpg, or gif
+# If left blank png will be used.
+
+DOT_IMAGE_FORMAT = png
+
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the
+# \dotfile command).
+
+DOTFILE_DIRS =
+
+# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
+# (in pixels) of the graphs generated by dot. If a graph becomes larger than
+# this value, doxygen will try to truncate the graph, so that it fits within
+# the specified constraint. Beware that most browsers cannot cope with very
+# large images.
+
+MAX_DOT_GRAPH_WIDTH = 1024
+
+# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
+# (in pixels) of the graphs generated by dot. If a graph becomes larger than
+# this value, doxygen will try to truncate the graph, so that it fits within
+# the specified constraint. Beware that most browsers cannot cope with very
+# large images.
+
+MAX_DOT_GRAPH_HEIGHT = 1024
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+# graphs generated by dot. A depth value of 3 means that only nodes reachable
+# from the root by following a path via at most 3 edges will be shown. Nodes
+# that lay further from the root node will be omitted. Note that setting this
+# option to 1 or 2 may greatly reduce the computation time needed for large
+# code bases. Also note that a graph may be further truncated if the graph's
+# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
+# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
+# the graph is not depth-constrained.
+
+MAX_DOT_GRAPH_DEPTH = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, which results in a white background.
+# Warning: Depending on the platform used, enabling this option may lead to
+# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
+# read).
+
+DOT_TRANSPARENT = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10)
+# support this, this feature is disabled by default.
+
+DOT_MULTI_TARGETS = NO
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
+# generate a legend page explaining the meaning of the various boxes and
+# arrows in the dot generated graphs.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermediate dot files that are used to generate
+# the various graphs.
+
+DOT_CLEANUP = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to the search engine
+#---------------------------------------------------------------------------
+
+# The SEARCHENGINE tag specifies whether or not a search engine should be
+# used. If set to NO the values of all tags below this one will be ignored.
+
+SEARCHENGINE = NO
Added: sofaswitch/trunk/callflow/overview.dxy
==============================================================================
--- (empty file)
+++ sofaswitch/trunk/callflow/overview.dxy Thu Sep 14 19:30:26 2006
@@ -0,0 +1,24 @@
+/*! \mainpage CallFlow - Generate call handling scripts for SofaSwitch
+
+
+\section introduction Introduction
+
+ This is an Open Source application specifically designed
+ to ease the development of call control in the SofaSwitch suite
+ of applications.
+
+ The code is based on wxWidgets (for portability), in C++ (for
+ functionality and ease of integrating with exWidgets) and has
+ been released under the MPL license.
+
+Last updated 15 September 2006
+
+Copyright (C) 2006 Indranet Technologies Ltd, All right reserved
+
+
+\subsection history History
+
+\li 15 September 2005 - Created by Derek J Smithies
+
+
+*/
1
0
[Sofaswitch-svn] [commit] r89 - in sofaswitch/trunk/callflow: bitmaps src
by SofaSWITCH SVN 13 Sep '06
by SofaSWITCH SVN 13 Sep '06
13 Sep '06
Author: derek
Date: Wed Sep 13 17:55:05 2006
New Revision: 89
Modified:
sofaswitch/trunk/callflow/bitmaps/stoptimer.xpm
sofaswitch/trunk/callflow/src/dnd.h
sofaswitch/trunk/callflow/src/starthere.cpp
sofaswitch/trunk/callflow/src/stoptimer.cpp
sofaswitch/trunk/callflow/src/stoptimer.h
sofaswitch/trunk/callflow/src/timer.cpp
sofaswitch/trunk/callflow/src/timer.h
Log:
Improve stop timer bitmap.
Get stoptimer widget & handler to operate correctly.
Tidy up format of output code.
Modified: sofaswitch/trunk/callflow/bitmaps/stoptimer.xpm
==============================================================================
--- sofaswitch/trunk/callflow/bitmaps/stoptimer.xpm (original)
+++ sofaswitch/trunk/callflow/bitmaps/stoptimer.xpm Wed Sep 13 17:55:05 2006
@@ -1,25 +1,24 @@
/* XPM */
static char *stoptimer[]={
-"16 16 6 1",
+"16 16 5 1",
+"c c None",
". c None",
-"# c #000000",
-"d c #303030",
-"c c #800000",
-"b c #c0c0c0",
-"a c #ffffff",
-"................",
-"......#####.....",
-"....##aaaaa##...",
-"...#baaa#aaab#..",
-"################",
-"ccc#ccc#ccc#ccc#",
-"c####c##c#c#c#c#",
-"ccc##c##c#c#ccc#",
-"ddc##c##c#c#c###",
-"ccc##c##ccc#c###",
-"##d#############",
-"...#baaaaaaab#..",
-"....##aaaaa##...",
-"......#####.....",
-"................",
-"................"};
+"a c #000000",
+"# c #ff0000",
+"b c #ffffff",
+".#.#.........#.#",
+"#.#.#.aaaaa.#.#.",
+".#.#a#bbbbb#a#.#",
+"..#a#b#bab#b#a#.",
+"...#b#b#a#b#b#..",
+"..ab#b#b#b#b#ba.",
+"..abb#b#a#b#bba.",
+"..abbb#a#b#bbba.",
+"..abb#b#a#b#bba.",
+"..ab#b#bab#b#ba.",
+"...#b#b#b#b#b#..",
+"..#c#b#bbb#b#a#.",
+".#.#a#bbbbb#a#.#",
+"#c#.#.aaaaa.#.#.",
+".c.#.........#.#",
+".#.............."};
Modified: sofaswitch/trunk/callflow/src/dnd.h
==============================================================================
--- sofaswitch/trunk/callflow/src/dnd.h (original)
+++ sofaswitch/trunk/callflow/src/dnd.h Wed Sep 13 17:55:05 2006
@@ -313,7 +313,7 @@
/**Get the name of this shape, based on the "kind" variable that
describes which particular shape we are */
- wxString GetName() const { return GetKindName(GetKind()); }
+ virtual wxString GetName() const { return GetKindName(GetKind()); }
/** Used to report the name of this particular class. */
static wxString GetKindName()
Modified: sofaswitch/trunk/callflow/src/starthere.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/starthere.cpp (original)
+++ sofaswitch/trunk/callflow/src/starthere.cpp Wed Sep 13 17:55:05 2006
@@ -63,8 +63,8 @@
wxNode *outputNode = (wxNode *)GetOutputPoints().GetFirst();
const wxString & outputLabel = ((LabelledPoint *)outputNode->GetData())->GetFullLabel();
- file.AddLine(wxString::Format(" \"Output\" : "));
- file.AddLine(wxString::Format(" %s, ", outputLabel.c_str()));
+ file.AddLine(wxString::Format(" \"Output\" : "));
+ file.AddLine(wxString::Format(" %s, ", outputLabel.c_str()));
file.AddLine(wxString::Format(" },"));
Modified: sofaswitch/trunk/callflow/src/stoptimer.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/stoptimer.cpp (original)
+++ sofaswitch/trunk/callflow/src/stoptimer.cpp Wed Sep 13 17:55:05 2006
@@ -18,10 +18,8 @@
/////////////////////////////////////////////////////////////////////////////
DndShapeStopTimer::DndShapeStopTimer()
- : DndShapeTimer()
+ : DndShapeTimer(StopTimer)
{
- kind = StopTimer;
-
InformationData::iterator it = displayData.begin();
while (it != displayData.end()) {
InformationData::iterator it_del = it;
@@ -55,7 +53,7 @@
{
file.AddLine(" def Stop_Timer(self, sTuple): ");
file.AddLine(" a,b,c = sTuple");
- file.AddLine(" killTimer = self.data[a][\"Timer label\"]");
+ file.AddLine(" killTimer = self.data[a][\"Stop Timer label\"]");
file.AddLine(" self.DeleteThisEvent(killTimer) ");
file.AddLine(" return self.data[a][\"Output\"]");
file.AddLine("");
@@ -65,22 +63,22 @@
bool DndShapeStopTimer::WriteThisShapeInfo(wxTextFile & file)
{
- file.AddLine(wxString::Format("\"%s\" : { ", GetKey().c_str()));
+ file.AddLine(wxString::Format(" \"%s\" : { ", GetKey().c_str()));
wxNode *inputNode = (wxNode *)GetInputPoints().GetFirst();
const wxString & inputLabel = ((LabelledPoint *)inputNode->GetData())->GetFullLabel();
- file.AddLine(wxString::Format(" \"Input\" : "));
- file.AddLine(wxString::Format(" %s, ", inputLabel.c_str()));
+ file.AddLine(wxString::Format(" \"Input\" : "));
+ file.AddLine(wxString::Format(" %s, ", inputLabel.c_str()));
wxNode *outputNode = (wxNode *)GetOutputPoints().GetFirst();
const wxString & outputLabel = ((LabelledPoint *)outputNode->GetData())->GetFullLabel();
- file.AddLine(wxString::Format(" \"Output\" : "));
- file.AddLine(wxString::Format(" %s, ", outputLabel.c_str()));
+ file.AddLine(wxString::Format(" \"Output\" : "));
+ file.AddLine(wxString::Format(" %s, ", outputLabel.c_str()));
- file.AddLine(wxString::Format(" \"Stop Timer label\" : "));
- file.AddLine(wxString::Format(" \"%s\", ", displayData[1].data.c_str()));
+ file.AddLine(wxString::Format(" \"Stop Timer label\" : "));
+ file.AddLine(wxString::Format(" \"%s\", ", displayData[1].data.c_str()));
- file.AddLine(wxString::Format(" },"));
+ file.AddLine(wxString::Format(" },"));
return true;
}
Modified: sofaswitch/trunk/callflow/src/stoptimer.h
==============================================================================
--- sofaswitch/trunk/callflow/src/stoptimer.h (original)
+++ sofaswitch/trunk/callflow/src/stoptimer.h Wed Sep 13 17:55:05 2006
@@ -25,6 +25,9 @@
/** Used to report the name of this particular class. */
static wxString GetKindName() { return wxString("Stop Timer"); }
+ /** Used to report the name of this particular class. */
+ virtual wxString GetName() { return wxString("Stop Timer"); }
+
/**Write the code generic to this End For loop shape */
virtual bool WriteSystemCode(wxTextFile & file);
Modified: sofaswitch/trunk/callflow/src/timer.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/timer.cpp (original)
+++ sofaswitch/trunk/callflow/src/timer.cpp Wed Sep 13 17:55:05 2006
@@ -20,21 +20,33 @@
DndShapeTimer::DndShapeTimer()
: DndShape(Timer)
{
- wxSize newSize(50, 50);
- SetSize(newSize);
-
- relInputPoints.Add(25, 0);
- relOutputPoints.Add(25, 50);
+ Construct();
+}
- displayData[displayData.size()] =
- InformationSection(wxT("Timer period (seconds)"), wxT("2"));
+DndShapeTimer::DndShapeTimer(Kind shapeDrawn)
+ : DndShape(shapeDrawn)
+{
+ Construct();
+}
- displayData[displayData.size()] =
- InformationSection(wxT("Timer label"), wxT("thistimer"));
-
- AdjustIoPoints();
+void DndShapeTimer::Construct()
+{
+ wxSize newSize(50, 50);
+ SetSize(newSize);
+
+ relInputPoints.Add(25, 0);
+ relOutputPoints.Add(25, 50);
+
+ displayData[displayData.size()] =
+ InformationSection(wxT("Timer period (seconds)"), wxT("2"));
+
+ displayData[displayData.size()] =
+ InformationSection(wxT("Timer label"), wxT("thistimer"));
+
+ AdjustIoPoints();
}
+
wxPoint DndShapeTimer::HourLocation(int hour, int radius)
{
double angle = (2 * M_PI * (hour + 9))/12.0;
@@ -104,7 +116,7 @@
file.AddLine(wxString::Format(" %s, ", displayData[1].data.c_str()));
file.AddLine(wxString::Format(" \"Timer label\" : "));
- file.AddLine(wxString::Format(" \"%s\", ", displayData[2].data.c_str()));
+ file.AddLine(wxString::Format(" \"%s\", ", displayData[2].data.c_str()));
file.AddLine(wxString::Format(" },"));
Modified: sofaswitch/trunk/callflow/src/timer.h
==============================================================================
--- sofaswitch/trunk/callflow/src/timer.h (original)
+++ sofaswitch/trunk/callflow/src/timer.h Wed Sep 13 17:55:05 2006
@@ -12,17 +12,28 @@
public:
/**Construtor, Define this shape in terms of size and points etc */
DndShapeTimer();
+
+ /**Construtor, Define this shape in terms of size and points etc. This
+ shape accepts an arguement, which is required to set the kind variable,
+ which is used when we create a descendant of this class. */
+ DndShapeTimer(Kind shapeDrawn);
/**Destroy this shape, and log it */
virtual ~DndShapeTimer()
{
}
+
+ /**Do the work of construction, which is common to the above two constructors */
+ void Construct();
/**Draw this particular shape to the screen..*/
virtual void Draw(wxDC& dc);
/** Used to report the name of this particular class. */
static wxString GetKindName() { return wxString("Timer"); }
+
+ /** Used to report the name of this particular class. */
+ virtual wxString GetName() const { return wxString("Timer"); }
/**Write the code generic to this End For loop shape */
virtual bool WriteSystemCode(wxTextFile & file);
1
0
13 Sep '06
Author: derek
Date: Wed Sep 13 01:22:35 2006
New Revision: 88
Modified:
sofaswitch/trunk/callflow/src/endhere.cpp
sofaswitch/trunk/callflow/src/eventer.cpp
sofaswitch/trunk/callflow/src/shapelist.cpp
sofaswitch/trunk/callflow/src/stoptimer.cpp
sofaswitch/trunk/callflow/src/timer.cpp
Log:
Work on event handling, and get very close to working.
Modified: sofaswitch/trunk/callflow/src/endhere.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/endhere.cpp (original)
+++ sofaswitch/trunk/callflow/src/endhere.cpp Wed Sep 13 01:22:35 2006
@@ -50,11 +50,14 @@
bool DndShapeEndHere::WriteSystemCode(wxTextFile & file)
{
file.AddLine(" def End_Processing(self, sTuple): ");
- file.AddLine(" self.keepGoing = False");
- file.AddLine(" a,b,c = sTuple");
- file.AddLine(" print \"end of processing at \", a ");
- file.AddLine(" return (1,2,3)");
- file.AddLine("");
+ file.AddLine(" \"\"\"Terminate processing of this flow chart, by returning a None structure ");
+ file.AddLine(" Processing on this flow chart may continue if there is an outstanding signal");
+ file.AddLine(" handle. ");
+ file.AddLine(" \"\"\" ");
+ file.AddLine(" a,b,c = sTuple ");
+ file.AddLine(" #print \"end of processing at \", a ");
+ file.AddLine(" return None ");
+ file.AddLine(" ");
return true;
}
Modified: sofaswitch/trunk/callflow/src/eventer.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/eventer.cpp (original)
+++ sofaswitch/trunk/callflow/src/eventer.cpp Wed Sep 13 01:22:35 2006
@@ -83,9 +83,13 @@
bool DndShapeEventer::WriteSystemCode(wxTextFile & file)
{
file.AddLine(" def Eventer(self, sTuple): ");
- file.AddLine(" a,b,c = sTuple");
- file.AddLine(" self.currentHandlers[self.data[a][\"Event\"] = self.data[a][\"Event Handler\"] ");
- file.AddLine(" return self.data[a][\"OutputKeepGoing\"] ");
+ file.AddLine(" \"\"\"Register the left down output as being available to handle a particular event ");
+ file.AddLine(" After registration, continue execution to right horizontal output. Should this ");
+ file.AddLine(" link not be connected, a None value will be returned. ");
+ file.AddLine(" \"\"\" ");
+ file.AddLine(" a,b,c = sTuple ");
+ file.AddLine(" self.currentHandlers[self.data[a][\"Event\"]] = a ");
+ file.AddLine(" return self.data[a][\"OutputKeepGoing\"] ");
file.AddLine("");
return true;
Modified: sofaswitch/trunk/callflow/src/shapelist.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/shapelist.cpp (original)
+++ sofaswitch/trunk/callflow/src/shapelist.cpp Wed Sep 13 01:22:35 2006
@@ -278,22 +278,23 @@
file.AddLine(" ");
file.AddLine("import sys ");
file.AddLine("import os ");
+ file.AddLine("import time ");
file.AddLine("import socket ");
file.AddLine("import distutils ");
- file.AddLine("import random ");
file.AddLine("from twisted.internet import reactor, protocol ");
- file.AddLine(" ");
- file.AddLine("class MyEvent(): ");
- file.AddLine(" self.name = None ");
- file.AddLine(" self.onEvent = None "); /*Go here on receiving event*/
file.AddLine(" ");
file.AddLine("class Controller(protocol.Protocol): ");
+ file.AddLine(" \"\"\" The class which holds all the information on how to manage each entity");
+ file.AddLine(" on the flow chart, how to connect, and does the requisite calls to twisted ");
+ file.AddLine(" ");
+ file.AddLine(" There are two types of events. A) name,data or B)name,handler ");
+ file.AddLine(" \"\"\" ");
file.AddLine(" def __init__(self): ");
file.AddLine(" self.graphSet = False ");
file.AddLine(" self.connectionIsMade = False ");
file.AddLine(" self.endProgramNow = False ");
- file.AddLine(" self.generatedEvents = [] ");
- file.AddLine(" self.pendingEvents = [] ");
+ file.AddLine(" self.generatedEvents = {} ");
+ file.AddLine(" self.pendingEvents = {} ");
file.AddLine(" self.currentHandlers= {} ");
char c= 34;
wxString tString = wxString::Format(" self.quote = \"\\%c\"", c);
@@ -301,68 +302,115 @@
file.AddLine(" ");
file.AddLine(" def setGraphData(self, graphFile): ");
+ file.AddLine(" \"\"\"Read in the file which describes where the flow ");
+ file.AddLine(" of execution goes, and variables associated with ");
+ file.AddLine(" associated with each block on the flow chart. ");
+ file.AddLine(" \"\"\" ");
file.AddLine(" self.gd=open(graphFile, \"r\"); ");
file.AddLine(" self.gdc=self.gd.read() ");
file.AddLine(" self.data = eval(self.gdc) ");
file.AddLine(" self.gd.close() ");
file.AddLine(" ");
file.AddLine(" self.firstNode = None ");
+ file.AddLine(" self.nextNode = None ");
file.AddLine(" for k,v in self.data.iteritems(): ");
file.AddLine(" if k[:16] == \"Start_Processing\": ");
file.AddLine(" self.firstNode = k ");
file.AddLine(" self.nextNode = k ");
- file.AddLine(" print \"first node is \", k ");
file.AddLine(" break ");
file.AddLine(" self.timeout = reactor.callLater(0, self.startTimerExpired, \"graph\")");
+ file.AddLine(" ");
+ file.AddLine(" def startTimerExpired(self, data): ");
+ file.AddLine(" \"\"\"Called during program initialisation. This provies a ");
+ file.AddLine(" way of ensuring execution only happens after two asynchronous");
+ file.AddLine(" events (connected to server, flow chart initialised) ");
+ file.AddLine(" \"\"\" ");
+ file.AddLine(" if data == \"graph\": ");
+ file.AddLine(" self.graphSet = True ");
+ file.AddLine(" if data == \"connected\": ");
+ file.AddLine(" self.connectionIsMade = True ");
+ file.AddLine(" if self.graphSet and self.connectionIsMade: ");
+ file.AddLine(" #print \"start processing now \" ");
+ file.AddLine(" reactor.callLater(0, self.startWorkNow,\"\");");
+ file.AddLine(" ");
+ file.AddLine(" def DeleteThisEvent(self, killEvent): ");
+ file.AddLine(" \"\"\" Remove a particular event from the pending and generated queue ");
+ file.AddLine(" This is required when we (for example) have to to stop a timer ");
+ file.AddLine(" \"\"\" ");
+ file.AddLine(" if self.pendingEvents.has_key(killEvent): ");
+ file.AddLine(" self.pendingEvents.pop(killEvent) ");
+ file.AddLine(" if self.generatedEvents.has_key(killEvent): ");
+ file.AddLine(" self.generatedEvents.pop(killEvent) ");
+ file.AddLine(" ");
+ file.AddLine(" def processQueue(self, data): ");
+ file.AddLine(" \"\"\"This method is called after an event has been detected");
+ file.AddLine(" as happening. It compares the generated events queue with the registered");
+ file.AddLine(" handlers, and dispatches execution to the relevant handler ");
+ file.AddLine(" \"\"\" ");
+ file.AddLine(" #print \"processQueue\" ");
+ file.AddLine(" #print \"current handlers \", self.currentHandlers ");
+ file.AddLine(" #print \"current events \", self.generatedEvents ");
+ file.AddLine(" #print \"pending events \", self.pendingEvents ");
+ file.AddLine(" keys = self.generatedEvents.keys() ");
+ file.AddLine(" for k in range(len(keys)): ");
+ file.AddLine(" if self.currentHandlers.has_key(keys[k]): ");
+ file.AddLine(" eventerNode = self.currentHandlers[keys[k]] ");
+ file.AddLine(" #print \"eventer node is \", eventerNode ");
+ file.AddLine(" self.DoWork(self.data[eventerNode][\"Event Handler\"])");
+ file.AddLine(" self.generatedEvents.pop(keys[k]) ");
file.AddLine(" ");
- file.AddLine(" def startTimerExpired(self, data): ");
- file.AddLine(" if data == \"graph\": ");
- file.AddLine(" self.graphSet = True ");
- file.AddLine(" if data == \"connected\": ");
- file.AddLine(" self.connectionIsMade = True ");
- file.AddLine(" if self.graphSet and self.connectionIsMade:");
- file.AddLine(" print \"start processing now \" ");
+ file.AddLine(" def transferEventToGenerated(self, data): ");
+ file.AddLine(" \"\"\"An event has happened, and now we need to act on it. Consequently, ");
+ file.AddLine(" we take it out of the pending list and put it in the process now list");
+ file.AddLine(" \"\"\" ");
+ file.AddLine(" if self.pendingEvents.has_key(data): ");
+ file.AddLine(" self.generatedEvents[data] = self.pendingEvents.pop(data)");
file.AddLine(" ");
- file.AddLine(" def DeleteThisEvent(self, killEvent): ");
- file.AddLine(" for i in range(len(self.pendingEvents)): ");
- file.AddLine(" if self.pendingEvents[i].name == killEvent: ");
- file.AddLine(" self.pendingEvents.pop(i) ");
- file.AddLine(" break ");
- file.AddLine(" for i in range(len(self.generatedEvents)): ");
- file.AddLine(" if self.generatedEvents[i].name == killEvent:");
- file.AddLine(" self.generatedEvents.pop(i) ");
- file.AddLine(" break ");
- file.AddLine(" ");
-
- file.AddLine(" def transferEventToGenerated(self, data) ");
- file.AddLine(" for i in range(len(self.pendingEvents)) ");
- file.AddLine(" if self.pendingEvents[i].name == data:");
- file.AddLine(" self.generatedEvents.append(self.pendingEvents.pop(i)) ");
- file.AddLine(" break; ");
- file.AddLine(" ");
file.AddLine(" def timerObjectExpired(self, data): ");
- file.AddLine(" eName= data[0 : (len(data)-8)] ");
- file.AddLine(" self.transferEventToGenerated(eName) ");
+ file.AddLine(" \"\"\"Some timer has expired. Move it from the pending list and place ");
+ file.AddLine(" it in the active list. Then activate processing so that things move along");
+ file.AddLine(" \"\"\" ");
+ file.AddLine(" #print \"timer object has expired \", data ");
+ file.AddLine(" self.transferEventToGenerated(data) ");
+ file.AddLine(" reactor.callLater(0, self.processQueue, 0) ");
file.AddLine(" ");
- file.AddLine(" def startWorkNow(): ");
+ file.AddLine(" def startWorkNow(self, notUsed): ");
+ file.AddLine(" \"\"\" Initiate processing on the flow chart");
+ file.AddLine(" \"\"\" ");
file.AddLine(" sTuple = \"(\" + self.quote + self.firstNode + self.quote + \", 0, \" +self.quote + \"Start_Processing\" + self.quote + \")\"");
file.AddLine(" self.DoWork(eval(sTuple)) ");
file.AddLine(" ");
file.AddLine(" def DoWork(self, sTuple): ");
+ file.AddLine(" \"\"\" Call one node in the flow chart, and do the ");
+ file.AddLine(" work of this node (in a separate method. This ");
+ file.AddLine(" is called when a)on startup or b)after an event ");
+ file.AddLine(" \"\"\" ");
file.AddLine(" a,b,c = sTuple ");
file.AddLine(" ");
file.AddLine(" self.keepGoing = True ");
file.AddLine(" ");
file.AddLine(" while self.keepGoing: ");
file.AddLine(" command = \"self.\" + str(c) + \"(\" + str(sTuple) + \")\"");
- file.AddLine(" a,b,c = sTuple = eval(command) ");
+ file.AddLine(" sTuple = eval(command) ");
+ file.AddLine(" if sTuple == None: ");
+ file.AddLine(" self.keepGoing = False ");
+ file.AddLine(" else: ");
+ file.AddLine(" a,b,c = sTuple ");
file.AddLine(" ");
file.AddLine(" def makeConnection(self, transport): ");
- file.AddLine(" self.connected = 1 ");
- file.AddLine(" self.transport = transport ");
- file.AddLine(" self.connectionMade() ");
+ file.AddLine(" \"\"\" A twisted callback that connects to the remote server ");
+ file.AddLine(" The parameters of the connection (port & address) are set");
+ file.AddLine(" elsewhere ");
+ file.AddLine(" \"\"\" ");
+ file.AddLine(" self.connected = 1 ");
+ file.AddLine(" self.transport = transport ");
+ file.AddLine(" self.connectionMade() ");
file.AddLine(" ");
file.AddLine(" def connectionMade(self): ");
+ file.AddLine(" \"\"\"A twisted callback that occurs after we have connected to the remote");
+ file.AddLine(" sofa swerver. After connection, we send a qury to the sofa server to obtain");
+ file.AddLine(" our sofa identity. ");
+ file.AddLine(" \"\"\" ");
file.AddLine(" self.myId = \"\" ");
file.AddLine(" self.countReceived = 0 ");
file.AddLine(" self.transport.write(\"?\\0\") ");
@@ -370,9 +418,18 @@
file.AddLine(" self.colonChar = \':\' ");
file.AddLine(" ");
file.AddLine(" def connectionLost(self, reason): ");
+ file.AddLine(" \"\"\"A twisted callback to tell us the connection to the remote sofa server");
+ file.AddLine(" has been lost. Currently, we do nothing with this information. It could be ");
+ file.AddLine(" used though to connect elsewhere. ");
+ file.AddLine(" \"\"\" ");
file.AddLine(" print \"connection lost\" ");
file.AddLine(" ");
file.AddLine(" def dataReceived(self, data): ");
+ file.AddLine(" \"\"\"A twisted callback which happens each time we receive a message from the sofa ");
+ file.AddLine(" server. This message could be part of the initialisation process. In which case, ");
+ file.AddLine(" initialise, and activate the next step of initialise. Or, it is an ordinary ");
+ file.AddLine(" message that has to be processed ");
+ file.AddLine(" \"\"\" ");
file.AddLine(" ssdata = str(data).split(\'\\0\') ");
file.AddLine(" for oneMessage in ssdata: ");
file.AddLine(" self.countReceived += 1 ");
@@ -382,11 +439,18 @@
file.AddLine(" else: ");
file.AddLine(" self.processReceivedMessage(oneMessage)");
file.AddLine(" ");
- file.AddLine(" def replyNow(self, data):");
- file.AddLine(" self.transport.write(self.tstring) ");
+ file.AddLine(" def replyNow(self, data): ");
+ file.AddLine(" \"\"\" Send a premade message to the remote sofa server. This method has to ");
+ file.AddLine(" send the message only - and not manipulate it in any way ");
+ file.AddLine(" \"\"\" ");
+ file.AddLine(" self.transport.write(self.tstring) ");
file.AddLine(" ");
file.AddLine(" def processReceivedMessage(self, thisMessage): ");
- file.AddLine(" print \"Received \", thisMessage ");
+ file.AddLine(" \"\"\"Handle an ordinary message from the remote sofa server. Break the message up");
+ file.AddLine(" turn it into a MyEvent message, and added to the right ");
+ file.AddLine(" queue. On doing this, spark an event to drive queue processing. ");
+ file.AddLine(" \"\"\" ");
+ file.AddLine(" #print \"Received \", thisMessage ");
file.AddLine(" ");
file.AddLine(" ");
@@ -422,7 +486,6 @@
file.AddLine(" p.factory = self ");
file.AddLine(" self.myController = p ");
file.AddLine(" self.myController.setGraphData(self.myGraphName) ");
- file.AddLine(" print 'finished building Protocol' ");
file.AddLine(" return p ");
file.AddLine(" for key in dir(p): ");
file.AddLine(" if '__' not in key: ");
Modified: sofaswitch/trunk/callflow/src/stoptimer.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/stoptimer.cpp (original)
+++ sofaswitch/trunk/callflow/src/stoptimer.cpp Wed Sep 13 01:22:35 2006
@@ -53,10 +53,10 @@
bool DndShapeStopTimer::WriteSystemCode(wxTextFile & file)
{
- file.AddLine(" def Timer(self, sTuple): ");
- file.AddLine(" killTimer = \"Timer\" + self.data[a][\"Timer label\"]");
- file.AddLine(" self.DeleteThisEvent(killTimer) ");
+ file.AddLine(" def Stop_Timer(self, sTuple): ");
file.AddLine(" a,b,c = sTuple");
+ file.AddLine(" killTimer = self.data[a][\"Timer label\"]");
+ file.AddLine(" self.DeleteThisEvent(killTimer) ");
file.AddLine(" return self.data[a][\"Output\"]");
file.AddLine("");
Modified: sofaswitch/trunk/callflow/src/timer.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/timer.cpp (original)
+++ sofaswitch/trunk/callflow/src/timer.cpp Wed Sep 13 01:22:35 2006
@@ -76,12 +76,10 @@
bool DndShapeTimer::WriteSystemCode(wxTextFile & file)
{
file.AddLine(" def Timer(self, sTuple): ");
- file.AddLine(" event = MyEvent ");
- file.AddLine(" self.r = repr(random.random())[2:10] "); //Last 8 chars of name are "random"
- file.AddLine(" event.name = \"Timer\" + self.data[a][\"Timer label\"] + self.r");
- file.AddLine(" self.pendingEvents.append(event) ");
- file.AddLine(" reactor.callLater(self.data[a][\"Timer period\"], self.timerEventExpired, event.name)");
file.AddLine(" a,b,c = sTuple");
+ file.AddLine(" eName = self.data[a][\"Timer label\"] ");
+ file.AddLine(" self.pendingEvents[eName] = a ");
+ file.AddLine(" reactor.callLater(self.data[a][\"Timer period\"], self.timerObjectExpired, eName)");
file.AddLine(" return self.data[a][\"Output\"]");
file.AddLine("");
1
0
12 Sep '06
Author: derek
Date: Tue Sep 12 01:17:27 2006
New Revision: 87
Modified:
sofaswitch/trunk/callflow/src/dnd.cpp
sofaswitch/trunk/callflow/src/eventer.cpp
sofaswitch/trunk/callflow/src/shapelist.cpp
sofaswitch/trunk/callflow/src/stoptimer.cpp
sofaswitch/trunk/callflow/src/timer.cpp
Log:
Add more system code to handle start and stop of timers, and collect
events. Fix some existing code.
Modified: sofaswitch/trunk/callflow/src/dnd.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/dnd.cpp (original)
+++ sofaswitch/trunk/callflow/src/dnd.cpp Tue Sep 12 01:17:27 2006
@@ -136,15 +136,18 @@
wxString LabelledPoint::GetFullLabel() const
{
- wxString kindLabel = DndShape::GetKindName((DndShape::Kind)otherNodeKind);
- kindLabel.Replace(" ", "_", true); //Replace all spaces with underscores.
+ if (otherNodeKind == DndShape::None)
+ return "None";
- wxString answer = wxString::Format("(\"%s\", %d, \"%s\" )",
- otherNodeLabel.c_str(),
- otherNodeIndex,
- kindLabel.c_str());
+ wxString kindLabel = DndShape::GetKindName((DndShape::Kind)otherNodeKind);
+ kindLabel.Replace(" ", "_", true); //Replace all spaces with underscores.
+
+ wxString answer = wxString::Format("(\"%s\", %d, \"%s\" )",
+ otherNodeLabel.c_str(),
+ otherNodeIndex,
+ kindLabel.c_str());
- return answer;
+ return answer;
}
bool LabelledPoint::SetKindValue(MyListShapesExtended & activeShapes)
Modified: sofaswitch/trunk/callflow/src/eventer.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/eventer.cpp (original)
+++ sofaswitch/trunk/callflow/src/eventer.cpp Tue Sep 12 01:17:27 2006
@@ -84,8 +84,8 @@
{
file.AddLine(" def Eventer(self, sTuple): ");
file.AddLine(" a,b,c = sTuple");
- file.AddLine(" print \"Eventer \", a ");
- file.AddLine(" return (1,2,3)");
+ file.AddLine(" self.currentHandlers[self.data[a][\"Event\"] = self.data[a][\"Event Handler\"] ");
+ file.AddLine(" return self.data[a][\"OutputKeepGoing\"] ");
file.AddLine("");
return true;
@@ -104,7 +104,7 @@
wxNode *outputNode = (wxNode *)GetOutputPoints().GetFirst();
const wxString & outputLabel = ((LabelledPoint *)outputNode->GetData())->GetFullLabel();
- file.AddLine(wxString::Format(" \"OutputFromEvent\" : "));
+ file.AddLine(wxString::Format(" \"Event Handler\" : "));
file.AddLine(wxString::Format(" %s, ", outputLabel.c_str()));
outputNode = outputNode->GetNext();
Modified: sofaswitch/trunk/callflow/src/shapelist.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/shapelist.cpp (original)
+++ sofaswitch/trunk/callflow/src/shapelist.cpp Tue Sep 12 01:17:27 2006
@@ -278,19 +278,23 @@
file.AddLine(" ");
file.AddLine("import sys ");
file.AddLine("import os ");
- file.AddLine("import time ");
file.AddLine("import socket ");
- file.AddLine("import Queue ");
file.AddLine("import distutils ");
- file.AddLine("import thread ");
+ file.AddLine("import random ");
file.AddLine("from twisted.internet import reactor, protocol ");
file.AddLine(" ");
-
+ file.AddLine("class MyEvent(): ");
+ file.AddLine(" self.name = None ");
+ file.AddLine(" self.onEvent = None "); /*Go here on receiving event*/
+ file.AddLine(" ");
file.AddLine("class Controller(protocol.Protocol): ");
file.AddLine(" def __init__(self): ");
file.AddLine(" self.graphSet = False ");
file.AddLine(" self.connectionIsMade = False ");
file.AddLine(" self.endProgramNow = False ");
+ file.AddLine(" self.generatedEvents = [] ");
+ file.AddLine(" self.pendingEvents = [] ");
+ file.AddLine(" self.currentHandlers= {} ");
char c= 34;
wxString tString = wxString::Format(" self.quote = \"\\%c\"", c);
file.AddLine(tString.c_str());
@@ -306,6 +310,7 @@
file.AddLine(" for k,v in self.data.iteritems(): ");
file.AddLine(" if k[:16] == \"Start_Processing\": ");
file.AddLine(" self.firstNode = k ");
+ file.AddLine(" self.nextNode = k ");
file.AddLine(" print \"first node is \", k ");
file.AddLine(" break ");
file.AddLine(" self.timeout = reactor.callLater(0, self.startTimerExpired, \"graph\")");
@@ -317,6 +322,27 @@
file.AddLine(" self.connectionIsMade = True ");
file.AddLine(" if self.graphSet and self.connectionIsMade:");
file.AddLine(" print \"start processing now \" ");
+ file.AddLine(" ");
+ file.AddLine(" def DeleteThisEvent(self, killEvent): ");
+ file.AddLine(" for i in range(len(self.pendingEvents)): ");
+ file.AddLine(" if self.pendingEvents[i].name == killEvent: ");
+ file.AddLine(" self.pendingEvents.pop(i) ");
+ file.AddLine(" break ");
+ file.AddLine(" for i in range(len(self.generatedEvents)): ");
+ file.AddLine(" if self.generatedEvents[i].name == killEvent:");
+ file.AddLine(" self.generatedEvents.pop(i) ");
+ file.AddLine(" break ");
+ file.AddLine(" ");
+
+ file.AddLine(" def transferEventToGenerated(self, data) ");
+ file.AddLine(" for i in range(len(self.pendingEvents)) ");
+ file.AddLine(" if self.pendingEvents[i].name == data:");
+ file.AddLine(" self.generatedEvents.append(self.pendingEvents.pop(i)) ");
+ file.AddLine(" break; ");
+ file.AddLine(" ");
+ file.AddLine(" def timerObjectExpired(self, data): ");
+ file.AddLine(" eName= data[0 : (len(data)-8)] ");
+ file.AddLine(" self.transferEventToGenerated(eName) ");
file.AddLine(" ");
file.AddLine(" def startWorkNow(): ");
file.AddLine(" sTuple = \"(\" + self.quote + self.firstNode + self.quote + \", 0, \" +self.quote + \"Start_Processing\" + self.quote + \")\"");
Modified: sofaswitch/trunk/callflow/src/stoptimer.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/stoptimer.cpp (original)
+++ sofaswitch/trunk/callflow/src/stoptimer.cpp Tue Sep 12 01:17:27 2006
@@ -33,7 +33,7 @@
displayData[displayData.size()] = InformationSection(wxT("Tool Tip"), GetName());
displayData[displayData.size()] =
- InformationSection(wxT("Timer to stop"), wxT("self.label=\"first\""));
+ InformationSection(wxT("Timer to stop"), wxT("thistimer"));
}
@@ -54,8 +54,10 @@
bool DndShapeStopTimer::WriteSystemCode(wxTextFile & file)
{
file.AddLine(" def Timer(self, sTuple): ");
+ file.AddLine(" killTimer = \"Timer\" + self.data[a][\"Timer label\"]");
+ file.AddLine(" self.DeleteThisEvent(killTimer) ");
file.AddLine(" a,b,c = sTuple");
- file.AddLine(" return data[a][\"Output\"]");
+ file.AddLine(" return self.data[a][\"Output\"]");
file.AddLine("");
return true;
Modified: sofaswitch/trunk/callflow/src/timer.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/timer.cpp (original)
+++ sofaswitch/trunk/callflow/src/timer.cpp Tue Sep 12 01:17:27 2006
@@ -27,10 +27,10 @@
relOutputPoints.Add(25, 50);
displayData[displayData.size()] =
- InformationSection(wxT("Timer period"), wxT("self.period = 2000"));
+ InformationSection(wxT("Timer period (seconds)"), wxT("2"));
displayData[displayData.size()] =
- InformationSection(wxT("Timer label"), wxT("self.label=\"first\""));
+ InformationSection(wxT("Timer label"), wxT("thistimer"));
AdjustIoPoints();
}
@@ -76,8 +76,13 @@
bool DndShapeTimer::WriteSystemCode(wxTextFile & file)
{
file.AddLine(" def Timer(self, sTuple): ");
+ file.AddLine(" event = MyEvent ");
+ file.AddLine(" self.r = repr(random.random())[2:10] "); //Last 8 chars of name are "random"
+ file.AddLine(" event.name = \"Timer\" + self.data[a][\"Timer label\"] + self.r");
+ file.AddLine(" self.pendingEvents.append(event) ");
+ file.AddLine(" reactor.callLater(self.data[a][\"Timer period\"], self.timerEventExpired, event.name)");
file.AddLine(" a,b,c = sTuple");
- file.AddLine(" return data[a][\"Output\"]");
+ file.AddLine(" return self.data[a][\"Output\"]");
file.AddLine("");
return true;
@@ -85,25 +90,25 @@
bool DndShapeTimer::WriteThisShapeInfo(wxTextFile & file)
{
- file.AddLine(wxString::Format("\"%s\" : { ", GetKey().c_str()));
+ file.AddLine(wxString::Format(" \"%s\" : { ", GetKey().c_str()));
wxNode *inputNode = (wxNode *)GetInputPoints().GetFirst();
const wxString & inputLabel = ((LabelledPoint *)inputNode->GetData())->GetFullLabel();
- file.AddLine(wxString::Format(" \"Input\" : "));
- file.AddLine(wxString::Format(" %s, ", inputLabel.c_str()));
+ file.AddLine(wxString::Format(" \"Input\" : "));
+ file.AddLine(wxString::Format(" %s, ", inputLabel.c_str()));
wxNode *outputNode = (wxNode *)GetOutputPoints().GetFirst();
const wxString & outputLabel = ((LabelledPoint *)outputNode->GetData())->GetFullLabel();
- file.AddLine(wxString::Format(" \"Output\" : "));
- file.AddLine(wxString::Format(" %s, ", outputLabel.c_str()));
+ file.AddLine(wxString::Format(" \"Output\" : "));
+ file.AddLine(wxString::Format(" %s, ", outputLabel.c_str()));
- file.AddLine(wxString::Format(" \"Timer period\" : "));
- file.AddLine(wxString::Format(" \"%s\", ", displayData[1].data.c_str()));
+ file.AddLine(wxString::Format(" \"Timer period\" : "));
+ file.AddLine(wxString::Format(" %s, ", displayData[1].data.c_str()));
- file.AddLine(wxString::Format(" \"Timer label\" : "));
- file.AddLine(wxString::Format(" \"%s\", ", displayData[2].data.c_str()));
+ file.AddLine(wxString::Format(" \"Timer label\" : "));
+ file.AddLine(wxString::Format(" \"%s\", ", displayData[2].data.c_str()));
- file.AddLine(wxString::Format(" },"));
+ file.AddLine(wxString::Format(" },"));
return true;
}
1
0
[Sofaswitch-svn] [commit] r86 - in sofaswitch/trunk/callflow: bitmaps src
by SofaSWITCH SVN 11 Sep '06
by SofaSWITCH SVN 11 Sep '06
11 Sep '06
Author: derek
Date: Mon Sep 11 19:40:00 2006
New Revision: 86
Added:
sofaswitch/trunk/callflow/bitmaps/stoptimer.xpm
sofaswitch/trunk/callflow/src/stoptimer.cpp
sofaswitch/trunk/callflow/src/stoptimer.h
Modified:
sofaswitch/trunk/callflow/src/Makefile.am
sofaswitch/trunk/callflow/src/Makefile.in
sofaswitch/trunk/callflow/src/callflow.cpp
sofaswitch/trunk/callflow/src/callflow.h
sofaswitch/trunk/callflow/src/dnd.cpp
sofaswitch/trunk/callflow/src/dnd.h
Log:
Add in code to display the icon to stop a running timer.
Added: sofaswitch/trunk/callflow/bitmaps/stoptimer.xpm
==============================================================================
--- (empty file)
+++ sofaswitch/trunk/callflow/bitmaps/stoptimer.xpm Mon Sep 11 19:40:00 2006
@@ -0,0 +1,25 @@
+/* XPM */
+static char *stoptimer[]={
+"16 16 6 1",
+". c None",
+"# c #000000",
+"d c #303030",
+"c c #800000",
+"b c #c0c0c0",
+"a c #ffffff",
+"................",
+"......#####.....",
+"....##aaaaa##...",
+"...#baaa#aaab#..",
+"################",
+"ccc#ccc#ccc#ccc#",
+"c####c##c#c#c#c#",
+"ccc##c##c#c#ccc#",
+"ddc##c##c#c#c###",
+"ccc##c##ccc#c###",
+"##d#############",
+"...#baaaaaaab#..",
+"....##aaaaa##...",
+"......#####.....",
+"................",
+"................"};
Modified: sofaswitch/trunk/callflow/src/Makefile.am
==============================================================================
--- sofaswitch/trunk/callflow/src/Makefile.am (original)
+++ sofaswitch/trunk/callflow/src/Makefile.am Mon Sep 11 19:40:00 2006
@@ -26,6 +26,7 @@
shapeselect.cpp \
startfor.cpp \
starthere.cpp \
+ stoptimer.cpp \
timer.cpp
Modified: sofaswitch/trunk/callflow/src/Makefile.in
==============================================================================
--- sofaswitch/trunk/callflow/src/Makefile.in (original)
+++ sofaswitch/trunk/callflow/src/Makefile.in Mon Sep 11 19:40:00 2006
@@ -55,7 +55,7 @@
listpoints.$(OBJEXT) makecall.$(OBJEXT) python.$(OBJEXT) \
requestnode.$(OBJEXT) shapelist.$(OBJEXT) \
shapeselect.$(OBJEXT) startfor.$(OBJEXT) starthere.$(OBJEXT) \
- timer.$(OBJEXT)
+ stoptimer.$(OBJEXT) timer.$(OBJEXT)
callflow_OBJECTS = $(am_callflow_OBJECTS)
am__DEPENDENCIES_1 =
callflow_DEPENDENCIES = $(am__DEPENDENCIES_1)
@@ -195,6 +195,7 @@
shapeselect.cpp \
startfor.cpp \
starthere.cpp \
+ stoptimer.cpp \
timer.cpp
all: all-am
@@ -287,6 +288,7 @@
@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/shapeselect.Po@am__quote@
@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/startfor.Po@am__quote@
@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/starthere.Po@am__quote@
+@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/stoptimer.Po@am__quote@
@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/timer.Po@am__quote@
.cpp.o:
Modified: sofaswitch/trunk/callflow/src/callflow.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/callflow.cpp (original)
+++ sofaswitch/trunk/callflow/src/callflow.cpp Mon Sep 11 19:40:00 2006
@@ -41,6 +41,7 @@
#include "bitmaps/compile.xpm"
#include "bitmaps/eventer.xpm"
#include "bitmaps/miniclock.xpm"
+#include "bitmaps/stoptimer.xpm"
class MyFrame ;
@@ -77,6 +78,7 @@
EVT_MENU ( wxH_CONTROLSFOR, MyFrame::OnControlsfor)
EVT_MENU ( wxH_CONTROLSIF, MyFrame::OnControlsif)
EVT_MENU ( wxH_CONTROLSTIMER, MyFrame::OnControlsTimer)
+ EVT_MENU ( wxH_CONTROLSSTOPTIMER, MyFrame::OnControlsStopTimer)
EVT_MENU ( wxH_CONTROLSEVENTER, MyFrame::OnControlsEventer)
EVT_MENU ( wxH_CONTROLSEND, MyFrame::OnControlsend)
EVT_MENU ( wxH_CONTROLSSTARTHERE, MyFrame::OnControlsstarthere)
@@ -140,6 +142,7 @@
Controls_menu -> Append ( wxH_CONTROLSEND, wxT("end"), wxT(""));
Controls_menu -> Append ( wxH_CONTROLSIF, wxT("if"), wxT(""));
Controls_menu -> Append ( wxH_CONTROLSTIMER, wxT("timer"), wxT(""));
+ Controls_menu -> Append ( wxH_CONTROLSSTOPTIMER, wxT("stop running timer"), wxT(""));
Controls_menu -> Append ( wxH_CONTROLSEVENTER, wxT("event reg/wait"), wxT(""));
Controls_menu -> Append ( wxH_CONTROLSFOR, wxT("for"), wxT(""));
Controls_menu -> Append ( wxH_CONTROLSEND_FOR, wxT("end for"), wxT(""));
@@ -292,6 +295,7 @@
toolBar->AddTool(wxH_CONTROLSREQUESTNODE, wxBitmap (RequestNode ), wxT("Query Supervisor for worker"));
toolBar->AddTool(wxH_CONTROLSIF, wxBitmap ( ControlsIf_xpm ), wxT("Test a condition"));
toolBar->AddTool(wxH_CONTROLSTIMER, wxBitmap ( miniclock_xpm ), wxT("Start a timer"));
+ toolBar->AddTool(wxH_CONTROLSSTOPTIMER, wxBitmap ( stoptimer ), wxT("Stop specified timer"));
toolBar->AddTool(wxH_CONTROLSEVENTER, wxBitmap ( eventer_xpm ), wxT("Register for & Wait for an event"));
toolBar->AddTool(wxH_CONTROLSFOR, wxBitmap ( Controlsfor_xpm ), wxT("Start a for loop"));
@@ -343,6 +347,12 @@
void MyFrame::OnControlsTimer (wxCommandEvent & WXUNUSED(event))
{
imageTypeForPlacing = DndShape::Timer;
+ canvas->SetEditingMode(MyCanvas::PlaceOneShape);
+}
+
+void MyFrame::OnControlsStopTimer (wxCommandEvent & WXUNUSED(event))
+{
+ imageTypeForPlacing = DndShape::StopTimer;
canvas->SetEditingMode(MyCanvas::PlaceOneShape);
}
Modified: sofaswitch/trunk/callflow/src/callflow.h
==============================================================================
--- sofaswitch/trunk/callflow/src/callflow.h (original)
+++ sofaswitch/trunk/callflow/src/callflow.h Mon Sep 11 19:40:00 2006
@@ -21,6 +21,7 @@
wxH_CONTROLSEND,
wxH_CONTROLSIF,
wxH_CONTROLSTIMER,
+ wxH_CONTROLSSTOPTIMER,
wxH_CONTROLSEVENTER,
wxH_CONTROLSFOR,
wxH_CONTROLSEND_FOR,
@@ -72,6 +73,7 @@
void OnControlsfor (wxCommandEvent & event);
void OnControlsend_for (wxCommandEvent & event);
void OnControlspython (wxCommandEvent & event);
+ void OnControlsStopTimer (wxCommandEvent & event);
void OnControlsTimer (wxCommandEvent & event);
void OnControlsmake_call (wxCommandEvent & event);
void OnControlsjoin_conference (wxCommandEvent & event);
Modified: sofaswitch/trunk/callflow/src/dnd.cpp
==============================================================================
--- sofaswitch/trunk/callflow/src/dnd.cpp (original)
+++ sofaswitch/trunk/callflow/src/dnd.cpp Mon Sep 11 19:40:00 2006
@@ -18,6 +18,7 @@
#include "callflow.h"
#include "information.h"
#include "shapelist.h"
+#include "stoptimer.h"
#include <wx/listimpl.cpp>
WX_DEFINE_LIST(AListPoints);
@@ -383,6 +384,9 @@
if (thisKind == Timer)
return DndShapeTimer::GetKindName();
+ if (thisKind == StopTimer)
+ return DndShapeStopTimer::GetKindName();
+
if (thisKind == Eventer)
return DndShapeEventer::GetKindName();
@@ -482,6 +486,7 @@
case Python: return new DndShapePython();
case RequestNode: return new DndShapeRequestNode();
case Timer: return new DndShapeTimer();
+ case StopTimer: return new DndShapeStopTimer();
case Eventer: return new DndShapeEventer();
default:
printf("Unknown construction of shape %d\n", shapeRequired);
Modified: sofaswitch/trunk/callflow/src/dnd.h
==============================================================================
--- sofaswitch/trunk/callflow/src/dnd.h (original)
+++ sofaswitch/trunk/callflow/src/dnd.h Mon Sep 11 19:40:00 2006
@@ -263,8 +263,9 @@
/* 10*/ Python /**The user can enter arbitary python here */,
/* 11*/ RequestNode /**Query a supervisor for a node to use to talk on*/,
/**12*/ Timer /**Initiate a timer, which runs for some specified time interval */,
- /**13*/ Eventer /**Mark me as registering for an event. Possibly, wait for the registered for event */,
- /* 14*/ KnownShapes /**Indicates the number of known shapes we can manage */
+ /**13*/ StopTimer /**Stop a running timer, so it will not generate an event etc */,
+ /**14*/ Eventer /**Mark me as registering for an event. Possibly, wait for the registered for event */,
+ /* 15*/ KnownShapes /**Indicates the number of known shapes we can manage */
};
/**Constructor to a predefined shape */
Added: sofaswitch/trunk/callflow/src/stoptimer.cpp
==============================================================================
--- (empty file)
+++ sofaswitch/trunk/callflow/src/stoptimer.cpp Mon Sep 11 19:40:00 2006
@@ -0,0 +1,85 @@
+#include "wx/wxprec.h"
+
+#ifdef __BORLANDC__
+#pragma hdrstop
+#endif
+
+
+#ifndef WX_PRECOMP
+#include "wx/wx.h"
+#endif
+#include <wx/textfile.h>
+#include <wx/tokenzr.h>
+#include "shapelist.h"
+
+
+#include "stoptimer.h"
+
+
+/////////////////////////////////////////////////////////////////////////////
+DndShapeStopTimer::DndShapeStopTimer()
+ : DndShapeTimer()
+{
+ kind = StopTimer;
+
+ InformationData::iterator it = displayData.begin();
+ while (it != displayData.end()) {
+ InformationData::iterator it_del = it;
+ it++;
+// delete it_del->second;
+ displayData.erase (it_del);
+ }
+
+ displayData[displayData.size()] = InformationSection(wxT("Tool Tip"), GetName());
+
+ displayData[displayData.size()] =
+ InformationSection(wxT("Timer to stop"), wxT("self.label=\"first\""));
+}
+
+
+void DndShapeStopTimer::Draw(wxDC& dc)
+{
+ wxString text("Stop");
+ dc.SetFont(*wxITALIC_FONT);
+ wxCoord w, h;
+ dc.GetTextExtent(text, &w, &h);
+ int xPos = m_rect.x + 5 + ((40 - w)/2);
+ int yPos = m_rect.y + 15 + ((20 - h)/2);
+ dc.DrawText(text, xPos, yPos);
+ DrawBox(dc, 5, 15, 40, 20);
+
+ DndShapeTimer::Draw(dc);
+}
+
+bool DndShapeStopTimer::WriteSystemCode(wxTextFile & file)
+{
+ file.AddLine(" def Timer(self, sTuple): ");
+ file.AddLine(" a,b,c = sTuple");
+ file.AddLine(" return data[a][\"Output\"]");
+ file.AddLine("");
+
+ return true;
+}
+
+bool DndShapeStopTimer::WriteThisShapeInfo(wxTextFile & file)
+{
+ file.AddLine(wxString::Format("\"%s\" : { ", GetKey().c_str()));
+
+ wxNode *inputNode = (wxNode *)GetInputPoints().GetFirst();
+ const wxString & inputLabel = ((LabelledPoint *)inputNode->GetData())->GetFullLabel();
+ file.AddLine(wxString::Format(" \"Input\" : "));
+ file.AddLine(wxString::Format(" %s, ", inputLabel.c_str()));
+
+ wxNode *outputNode = (wxNode *)GetOutputPoints().GetFirst();
+ const wxString & outputLabel = ((LabelledPoint *)outputNode->GetData())->GetFullLabel();
+ file.AddLine(wxString::Format(" \"Output\" : "));
+ file.AddLine(wxString::Format(" %s, ", outputLabel.c_str()));
+
+ file.AddLine(wxString::Format(" \"Stop Timer label\" : "));
+ file.AddLine(wxString::Format(" \"%s\", ", displayData[1].data.c_str()));
+
+ file.AddLine(wxString::Format(" },"));
+
+ return true;
+}
+
Added: sofaswitch/trunk/callflow/src/stoptimer.h
==============================================================================
--- (empty file)
+++ sofaswitch/trunk/callflow/src/stoptimer.h Mon Sep 11 19:40:00 2006
@@ -0,0 +1,38 @@
+#ifndef SHAPE_STOP_TIMER_H
+#define SHAPE_STOP_TIMER_H
+
+#include "dnd.h"
+#include "timer.h"
+
+//////////////////////////////////////////////////////////////////////////
+/**Define a shape to indicate the stopping of a running timer. The timer will be
+ terminated. Any pending events from that timer will also be removed.
+ */
+class DndShapeStopTimer : public DndShapeTimer
+{
+public:
+ /**Construtor, Define this shape in terms of size and points etc */
+ DndShapeStopTimer();
+
+ /**Destroy this shape, and log it */
+ virtual ~DndShapeStopTimer()
+ {
+ }
+
+ /**Draw this particular shape to the screen..*/
+ virtual void Draw(wxDC& dc);
+
+ /** Used to report the name of this particular class. */
+ static wxString GetKindName() { return wxString("Stop Timer"); }
+
+ /**Write the code generic to this End For loop shape */
+ virtual bool WriteSystemCode(wxTextFile & file);
+
+ /**Write the dictionary containing relevant points for this shape */
+ virtual bool WriteThisShapeInfo(wxTextFile & file);
+};
+
+
+
+
+#endif //SHAPE_STOP_TIMER_H
1
0