Converting to Linux new lines before final publish.

This commit is contained in:
Lukasz Baldyga committed 2021-02-10 05:27:50 +00:00
1 parent ab94e98508
commit ea2360f2a6
667 files changed
+68755 -8530

No files matched your search

@@ -0,0 +1,77 @@
.TH "Advanced_Software_Engineering" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering
.SH SYNOPSIS
.br
.PP
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBAbout_Window\fP"
.br
.RI "Auto generated code "
.ti -1c
.RI "class \fBCommandAndParameterParserResult\fP"
.br
.RI "This class is a direct replacement to the dictionaries that were returned by \fBHelperFunctions\&.CommandAndParameterParser(string)\fP\&. This class provides better intraface to the output\&. "
.ti -1c
.RI "class \fBCommander\fP"
.br
.RI "The commander class takes care of commands\&. It also takes control of the drawer\&. "
.ti -1c
.RI "class \fBCommandHelp\fP"
.br
.RI "This class is resposible for the command help window\&. The command help window shows help for the commands\&. "
.ti -1c
.RI "class \fBConverters\fP"
.br
.ti -1c
.RI "class \fBDetailsWindow\fP"
.br
.RI "This form is reponsible for showing details\&. It is essentially a textbox in a form\&. "
.ti -1c
.RI "class \fBDraw_Preview\fP"
.br
.RI "Auto Generated Code "
.ti -1c
.RI "class \fBDrawer\fP"
.br
.RI "The drawer is responsible for drawing on the graphics object\&. "
.ti -1c
.RI "class \fBErrorWindow\fP"
.br
.RI "The error window that can show errors, warnings and messages\&. "
.ti -1c
.RI "class \fBHelperFunctions\fP"
.br
.RI "This class simply provides settings and some functions that are used across many components\&. "
.ti -1c
.RI "interface \fBIVerb\fP"
.br
.RI "\fBIVerb\fP is an interface for executing and getting the descriptions of \fBVerbs\fP\&. Some \fBVerbs\fP draw lines, some verbs will assign "
.ti -1c
.RI "class \fBMenu\fP"
.br
.RI "Auto generated code\&. "
.ti -1c
.RI "class \fBMenuManager\fP"
.br
.RI "\fBMenu\fP manager manages if the menu is shown to the user\&. It is a static class because every Form should be able to see it\&. See \fBMenu\fP\&. "
.ti -1c
.RI "class \fBProgram\fP"
.br
.ti -1c
.RI "class \fBTextEditor\fP"
.br
.RI "Auto generated code "
.ti -1c
.RI "class \fBVerbFactory\fP"
.br
.RI "This class is responsible for creating \fBVerbs\fP\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,49 @@
.TH "Advanced_Software_Engineering.About_Window" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.About_Window \- Auto generated code
.SH SYNOPSIS
.br
.PP
.PP
Inherits Form\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBAbout_Window\fP ()"
.br
.RI "Creates an About Window which shows details about the program\&. /summary> "
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "override void \fBDispose\fP (bool disposing)"
.br
.RI "Clean up any resources being used\&. "
.in -1c
.SH "Detailed Description"
.PP
Auto generated code
.SH "Member Function Documentation"
.PP
.SS "override void Advanced_Software_Engineering\&.About_Window\&.Dispose (bool disposing)\fC [protected]\fP"
.PP
Clean up any resources being used\&.
.PP
\fBParameters\fP
.RS 4
\fIdisposing\fP true if managed resources should be disposed; otherwise, false\&.
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,73 @@
.TH "Advanced_Software_Engineering.CommandAndParameterParserResult" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.CommandAndParameterParserResult \- This class is a direct replacement to the dictionaries that were returned by \fBHelperFunctions\&.CommandAndParameterParser(string)\fP\&. This class provides better intraface to the output\&.
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBCommandAndParameterParserResult\fP (string command, string[] parameters)"
.br
.RI "Generates a new Result "
.ti -1c
.RI "string \fBGetCommand\fP ()"
.br
.RI "Gets the command from the result "
.ti -1c
.RI "string[] \fBGetParameters\fP ()"
.br
.RI "Gets the command parameters "
.in -1c
.SH "Detailed Description"
.PP
This class is a direct replacement to the dictionaries that were returned by \fBHelperFunctions\&.CommandAndParameterParser(string)\fP\&. This class provides better intraface to the output\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.CommandAndParameterParserResult\&.CommandAndParameterParserResult (string command, string[] parameters)"
.PP
Generates a new Result
.PP
\fBParameters\fP
.RS 4
\fIcommand\fP The command
.br
\fIparameters\fP The parameters
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "string Advanced_Software_Engineering\&.CommandAndParameterParserResult\&.GetCommand ()"
.PP
Gets the command from the result
.PP
\fBReturns\fP
.RS 4
the command
.RE
.PP
.SS "string [] Advanced_Software_Engineering\&.CommandAndParameterParserResult\&.GetParameters ()"
.PP
Gets the command parameters
.PP
\fBReturns\fP
.RS 4
command parameters
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,55 @@
.TH "Advanced_Software_Engineering.CommandHelp" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.CommandHelp \- This class is resposible for the command help window\&. The command help window shows help for the commands\&.
.SH SYNOPSIS
.br
.PP
.PP
Inherits Form\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBCommandHelp\fP ()"
.br
.RI "Initilize \fBCommandHelp\fP\&. "
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "override void \fBDispose\fP (bool disposing)"
.br
.RI "Clean up any resources being used\&. "
.in -1c
.SH "Detailed Description"
.PP
This class is resposible for the command help window\&. The command help window shows help for the commands\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.CommandHelp\&.CommandHelp ()"
.PP
Initilize \fBCommandHelp\fP\&.
.SH "Member Function Documentation"
.PP
.SS "override void Advanced_Software_Engineering\&.CommandHelp\&.Dispose (bool disposing)\fC [protected]\fP"
.PP
Clean up any resources being used\&.
.PP
\fBParameters\fP
.RS 4
\fIdisposing\fP true if managed resources should be disposed; otherwise, false\&.
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,181 @@
.TH "Advanced_Software_Engineering.Commander" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Commander \- The commander class takes care of commands\&. It also takes control of the drawer\&.
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "void \fBDrawAllCommands\fP (Graphics updateGraphicsElement)"
.br
.RI "This command updates the graphics element (usually) when the page repaints\&. "
.ti -1c
.RI "\fBCommander\fP (Graphics graphics)"
.br
.RI "Create a new \fBCommander\fP instance\&. "
.ti -1c
.RI "\fBCommander\fP ()"
.br
.RI "Creates a new \fBCommander\fP instance without a context\&. Should only be used for testing purpouses\&. "
.ti -1c
.RI "\fBCommander\fP (Graphics graphics, string rawCommands)"
.br
.RI "Creates a new \fBCommander\fP instance with a graphics context and commands to process right off the bat\&. "
.ti -1c
.RI "void \fBAddCommand\fP (\fBIVerb\fP command)"
.br
.RI "Adds a \fBIVerb\fP to the command list to be executed\&. "
.ti -1c
.RI "void \fBProcessCommands\fP (string rawCommands, bool pardonCommands=false)"
.br
.RI "processes commands\&. Removes all commands if it fails parsing the raw commands\&. "
.ti -1c
.RI "void \fBProcessCommandsAndExecute\fP (string rawCommands, bool pardonCommands=false)"
.br
.RI "Processes the commands and executes them at the same time\&. It's the same as "
.ti -1c
.RI "void \fBRemoveAllCommands\fP ()"
.br
.RI "Removes all commands from the \fBCommander\fP and resets the drawer\&. "
.ti -1c
.RI "string \fBExplainCommands\fP ()"
.br
.RI "Explains all of the commands in order "
.ti -1c
.RI "bool \fBGetLastStatus\fP ()"
.br
.RI "Gets the status of the code that was processed "
.in -1c
.SH "Detailed Description"
.PP
The commander class takes care of commands\&. It also takes control of the drawer\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Commander\&.Commander (Graphics graphics)"
.PP
Create a new \fBCommander\fP instance\&.
.PP
\fBParameters\fP
.RS 4
\fIgraphics\fP initial graphics object
.RE
.PP
.SS "Advanced_Software_Engineering\&.Commander\&.Commander ()"
.PP
Creates a new \fBCommander\fP instance without a context\&. Should only be used for testing purpouses\&.
.SS "Advanced_Software_Engineering\&.Commander\&.Commander (Graphics graphics, string rawCommands)"
.PP
Creates a new \fBCommander\fP instance with a graphics context and commands to process right off the bat\&.
.PP
\fBParameters\fP
.RS 4
\fIgraphics\fP Graphics contetx
.br
\fIrawCommands\fP Commands to process
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Commander\&.AddCommand (\fBIVerb\fP command)"
.PP
Adds a \fBIVerb\fP to the command list to be executed\&.
.PP
\fBParameters\fP
.RS 4
\fIcommand\fP \fBIVerb\fP to be added\&.
.PP
\fBSee also\fP
.RS 4
\fBIVerb\fP
.PP
.RE
.PP
.RE
.PP
.SS "void Advanced_Software_Engineering\&.Commander\&.DrawAllCommands (Graphics updateGraphicsElement)"
.PP
This command updates the graphics element (usually) when the page repaints\&.
.PP
\fBParameters\fP
.RS 4
\fIupdateGraphicsElement\fP The graphics element to be updated
.RE
.PP
.SS "string Advanced_Software_Engineering\&.Commander\&.ExplainCommands ()"
.PP
Explains all of the commands in order
.PP
\fBReturns\fP
.RS 4
Explanation of all the commands
.RE
.PP
.SS "bool Advanced_Software_Engineering\&.Commander\&.GetLastStatus ()"
.PP
Gets the status of the code that was processed
.PP
\fBReturns\fP
.RS 4
False if there was no error\&. True if there was an error
.RE
.PP
.SS "void Advanced_Software_Engineering\&.Commander\&.ProcessCommands (string rawCommands, bool pardonCommands = \fCfalse\fP)"
.PP
processes commands\&. Removes all commands if it fails parsing the raw commands\&.
.PP
\fBParameters\fP
.RS 4
\fIrawCommands\fP Processes commands seperated by
.br
or \\r
.br
.br
\fIpardonCommands\fP If the command is wrong, don't remove all of the commands
.RE
.PP
.SS "void Advanced_Software_Engineering\&.Commander\&.ProcessCommandsAndExecute (string rawCommands, bool pardonCommands = \fCfalse\fP)"
.PP
Processes the commands and executes them at the same time\&. It's the same as
.PP
\fBParameters\fP
.RS 4
\fIrawCommands\fP Processes commands seperated by
.br
or \\r
.br
.br
\fIpardonCommands\fP If the command is wrong, don't remove all of the commands
.RE
.PP
.SS "void Advanced_Software_Engineering\&.Commander\&.RemoveAllCommands ()"
.PP
Removes all commands from the \fBCommander\fP and resets the drawer\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,79 @@
.TH "Advanced_Software_Engineering.DetailsWindow" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.DetailsWindow \- This form is reponsible for showing details\&. It is essentially a textbox in a form\&.
.SH SYNOPSIS
.br
.PP
.PP
Inherits Form\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBDetailsWindow\fP (string details)"
.br
.RI "A details window dedicated to showing details\&. "
.ti -1c
.RI "\fBDetailsWindow\fP (string details, string title)"
.br
.RI "A details window that shows details in the textbox and title as the window title\&. "
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "override void \fBDispose\fP (bool disposing)"
.br
.RI "Clean up any resources being used\&. "
.in -1c
.SH "Detailed Description"
.PP
This form is reponsible for showing details\&. It is essentially a textbox in a form\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.DetailsWindow\&.DetailsWindow (string details)"
.PP
A details window dedicated to showing details\&.
.PP
\fBParameters\fP
.RS 4
\fIdetails\fP The textbox text
.RE
.PP
.SS "Advanced_Software_Engineering\&.DetailsWindow\&.DetailsWindow (string details, string title)"
.PP
A details window that shows details in the textbox and title as the window title\&.
.PP
\fBParameters\fP
.RS 4
\fIdetails\fP the details to be shown in the textbox
.br
\fItitle\fP the title of the window
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "override void Advanced_Software_Engineering\&.DetailsWindow\&.Dispose (bool disposing)\fC [protected]\fP"
.PP
Clean up any resources being used\&.
.PP
\fBParameters\fP
.RS 4
\fIdisposing\fP true if managed resources should be disposed; otherwise, false\&.
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,124 @@
.TH "Advanced_Software_Engineering.Draw_Preview" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Draw_Preview \- Auto Generated Code
.SH SYNOPSIS
.br
.PP
.PP
Inherits Form\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBDraw_Preview\fP ()"
.br
.RI "The draw preview window\&. Spawns the basic DrawPreview\&. "
.ti -1c
.RI "\fBDraw_Preview\fP (string commands)"
.br
.RI "The draw preview window\&. Spawns the DrawPreview with commands locked\&. "
.ti -1c
.RI "void \fBSubmitCommands\fP (string comamnds)"
.br
.RI "Submit commands to the commander to execute on the form\&. "
.ti -1c
.RI "void \fBRemoveAllCommands\fP ()"
.br
.RI "Removes all the commands from the form "
.ti -1c
.RI "void \fBReleaseCommandLock\fP ()"
.br
.RI "Enables the textbox and submit button to allow the user to interract with the preview directly "
.ti -1c
.RI "string \fBDescribeAllCommands\fP ()"
.br
.RI "Describes all of the current commands stored inside commander\&. "
.ti -1c
.RI "bool \fBIsSuccess\fP ()"
.br
.RI "Returns weather there were any errors in the commander\&. "
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "override void \fBDispose\fP (bool disposing)"
.br
.RI "Clean up any resources being used\&. "
.in -1c
.SH "Detailed Description"
.PP
Auto Generated Code
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Draw_Preview\&.Draw_Preview ()"
.PP
The draw preview window\&. Spawns the basic DrawPreview\&. This window is responsible for showing what has been drawn\&.
.SS "Advanced_Software_Engineering\&.Draw_Preview\&.Draw_Preview (string commands)"
.PP
The draw preview window\&. Spawns the DrawPreview with commands locked\&. This window is responsible for showing what has been drawn\&.
.SH "Member Function Documentation"
.PP
.SS "string Advanced_Software_Engineering\&.Draw_Preview\&.DescribeAllCommands ()"
.PP
Describes all of the current commands stored inside commander\&.
.PP
\fBReturns\fP
.RS 4
A string with all the command descriptions
.RE
.PP
.SS "override void Advanced_Software_Engineering\&.Draw_Preview\&.Dispose (bool disposing)\fC [protected]\fP"
.PP
Clean up any resources being used\&.
.PP
\fBParameters\fP
.RS 4
\fIdisposing\fP true if managed resources should be disposed; otherwise, false\&.
.RE
.PP
.SS "bool Advanced_Software_Engineering\&.Draw_Preview\&.IsSuccess ()"
.PP
Returns weather there were any errors in the commander\&.
.PP
\fBReturns\fP
.RS 4
A boolean describing the success of command phrasing
.RE
.PP
.SS "void Advanced_Software_Engineering\&.Draw_Preview\&.ReleaseCommandLock ()"
.PP
Enables the textbox and submit button to allow the user to interract with the preview directly
.SS "void Advanced_Software_Engineering\&.Draw_Preview\&.RemoveAllCommands ()"
.PP
Removes all the commands from the form
.SS "void Advanced_Software_Engineering\&.Draw_Preview\&.SubmitCommands (string comamnds)"
.PP
Submit commands to the commander to execute on the form\&.
.PP
\fBParameters\fP
.RS 4
\fIcomamnds\fP Commands seperated by new lines
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,386 @@
.TH "Advanced_Software_Engineering.Drawer" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Drawer \- The drawer is responsible for drawing on the graphics object\&.
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBDrawer\fP (Graphics \fBgraphics\fP)"
.br
.RI "Creates a new drawer object\&. "
.ti -1c
.RI "void \fBResetDrawer\fP ()"
.br
.RI "Restart the drawer\&. "
.ti -1c
.RI "void \fBSetGraphics\fP (Graphics \fBgraphics\fP)"
.br
.RI "Set thhe graphics context\&. "
.ti -1c
.RI "void \fBMovePen\fP (Point point)"
.br
.RI "Move the pen to the point\&. "
.ti -1c
.RI "Point \fBGetPenPosition\fP ()"
.br
.RI "Returns the current pen position "
.ti -1c
.RI "bool \fBGetFill\fP ()"
.br
.RI "Get current fill status "
.ti -1c
.RI "void \fBEnableFill\fP ()"
.br
.RI "Allows the filling of objects\&. "
.ti -1c
.RI "void \fBDisableFill\fP ()"
.br
.RI "Disables the filling of objects\&. "
.ti -1c
.RI "void \fBSetFill\fP (bool \fBfill\fP)"
.br
.RI "Set the filling of objects "
.ti -1c
.RI "void \fBSetPenColor\fP (Color color)"
.br
.RI "Set the pen color "
.ti -1c
.RI "void \fBSetPenWidth\fP (float width)"
.br
.RI "Set the width of the pen "
.ti -1c
.RI "void \fBSetFillColor\fP (Color color)"
.br
.RI "Set fill color "
.ti -1c
.RI "void \fBDrawLine\fP (Point point)"
.br
.RI "Draws a line from the current pen position to the one specified in the parameter\&. This also sets the pens new position\&. "
.ti -1c
.RI "void \fBDrawLines\fP (Point[] points)"
.br
.RI "Draws multiple lines to multiple points\&. This doesn't change the pens position\&. "
.ti -1c
.RI "void \fBDrawLines\fP (GraphicsPath path)"
.br
.RI "Draws multiple lines to multiple points\&. This doesn't change the pens position\&. "
.ti -1c
.RI "void \fBDrawCircle\fP (double scale)"
.br
.RI "Draws a circle of a scale ath the pen's position "
.ti -1c
.RI "void \fBClearCanvas\fP ()"
.br
.RI "Clears the canvas "
.ti -1c
.RI "void \fBDrawDot\fP ()"
.br
.RI "Draws a single pixel with the pen's color at the pen's position\&. "
.ti -1c
.RI "\fBValueStorage\fP \fBGetValueStorage\fP ()"
.br
.RI "Gets the valueStorage object "
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "List< \fBIVerbChunk\fP > \fBverbChunks\fP = new List<\fBIVerbChunk\fP>()"
.br
.RI "List of verbChunks used to create for loops, if statements, while loops and methods\&. See ForChunk, IfChunk, MethodChunk, WhileChunk and
.PP
\fBSee also\fP
.RS 4
IVerbChunk
.PP
.RE
.PP
\&. "
.ti -1c
.RI "bool \fBverbChunkGeneratingMethod\fP = false"
.br
.RI "A veriable that represents wether the last verbchunk is a method\&. See MethodChunk "
.ti -1c
.RI "Dictionary< string, \fBMethodChunk\fP > \fBMethods\fP = new Dictionary<string, \fBMethodChunk\fP>()"
.br
.RI "A list of methods\&. See MethodChunk "
.in -1c
.SS "Protected Attributes"
.in +1c
.ti -1c
.RI "bool \fBfill\fP = false"
.br
.RI "Weather enclosed spaces will have fill\&. "
.ti -1c
.RI "SolidBrush \fBbrush\fP"
.br
.RI "The Brush object "
.ti -1c
.RI "Pen \fBpen\fP"
.br
.RI "The Pen object "
.ti -1c
.RI "Point \fBpenPosition\fP"
.br
.RI "The current position of the pen\&. "
.ti -1c
.RI "Graphics \fBgraphics\fP"
.br
.RI "The graphics object "
.in -1c
.SS "Static Protected Attributes"
.in +1c
.ti -1c
.RI "static Color \fBdefaultColor\fP = Color\&.Black"
.br
.RI "The starting color of the pen / brush "
.ti -1c
.RI "static float \fBdefaultWidth\fP = 1f"
.br
.RI "The deafult width of the pen "
.in -1c
.SH "Detailed Description"
.PP
The drawer is responsible for drawing on the graphics object\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Drawer\&.Drawer (Graphics graphics)"
.PP
Creates a new drawer object\&.
.PP
\fBParameters\fP
.RS 4
\fIgraphics\fP Graphics context
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Drawer\&.ClearCanvas ()"
.PP
Clears the canvas
.SS "void Advanced_Software_Engineering\&.Drawer\&.DisableFill ()"
.PP
Disables the filling of objects\&.
.SS "void Advanced_Software_Engineering\&.Drawer\&.DrawCircle (double scale)"
.PP
Draws a circle of a scale ath the pen's position
.PP
\fBParameters\fP
.RS 4
\fIscale\fP Scale of the circle
.RE
.PP
.SS "void Advanced_Software_Engineering\&.Drawer\&.DrawDot ()"
.PP
Draws a single pixel with the pen's color at the pen's position\&.
.SS "void Advanced_Software_Engineering\&.Drawer\&.DrawLine (Point point)"
.PP
Draws a line from the current pen position to the one specified in the parameter\&. This also sets the pens new position\&.
.PP
\fBParameters\fP
.RS 4
\fIpoint\fP Draw to point
.RE
.PP
.SS "void Advanced_Software_Engineering\&.Drawer\&.DrawLines (GraphicsPath path)"
.PP
Draws multiple lines to multiple points\&. This doesn't change the pens position\&.
.PP
\fBParameters\fP
.RS 4
\fIpath\fP GraphicsPath to draw to
.RE
.PP
.SS "void Advanced_Software_Engineering\&.Drawer\&.DrawLines (Point[] points)"
.PP
Draws multiple lines to multiple points\&. This doesn't change the pens position\&.
.PP
\fBParameters\fP
.RS 4
\fIpoints\fP Points to draw to
.RE
.PP
.SS "void Advanced_Software_Engineering\&.Drawer\&.EnableFill ()"
.PP
Allows the filling of objects\&.
.SS "bool Advanced_Software_Engineering\&.Drawer\&.GetFill ()"
.PP
Get current fill status
.PP
\fBReturns\fP
.RS 4
current fill satus
.RE
.PP
.SS "Point Advanced_Software_Engineering\&.Drawer\&.GetPenPosition ()"
.PP
Returns the current pen position
.PP
\fBReturns\fP
.RS 4
The curren pen position
.RE
.PP
.SS "\fBValueStorage\fP Advanced_Software_Engineering\&.Drawer\&.GetValueStorage ()"
.PP
Gets the valueStorage object
.PP
\fBReturns\fP
.RS 4
.RE
.PP
.SS "void Advanced_Software_Engineering\&.Drawer\&.MovePen (Point point)"
.PP
Move the pen to the point\&.
.PP
\fBParameters\fP
.RS 4
\fIpoint\fP Position to move the pen to
.RE
.PP
.SS "void Advanced_Software_Engineering\&.Drawer\&.ResetDrawer ()"
.PP
Restart the drawer\&.
.SS "void Advanced_Software_Engineering\&.Drawer\&.SetFill (bool fill)"
.PP
Set the filling of objects
.PP
\fBParameters\fP
.RS 4
\fIfill\fP Set fill
.RE
.PP
.SS "void Advanced_Software_Engineering\&.Drawer\&.SetFillColor (Color color)"
.PP
Set fill color
.PP
\fBParameters\fP
.RS 4
\fIcolor\fP Fill color
.RE
.PP
.SS "void Advanced_Software_Engineering\&.Drawer\&.SetGraphics (Graphics graphics)"
.PP
Set thhe graphics context\&.
.PP
\fBParameters\fP
.RS 4
\fIgraphics\fP
.RE
.PP
.SS "void Advanced_Software_Engineering\&.Drawer\&.SetPenColor (Color color)"
.PP
Set the pen color
.PP
\fBParameters\fP
.RS 4
\fIcolor\fP Pen color
.RE
.PP
.SS "void Advanced_Software_Engineering\&.Drawer\&.SetPenWidth (float width)"
.PP
Set the width of the pen
.PP
\fBParameters\fP
.RS 4
\fIwidth\fP Pen width
.RE
.PP
.SH "Member Data Documentation"
.PP
.SS "SolidBrush Advanced_Software_Engineering\&.Drawer\&.brush\fC [protected]\fP"
.PP
The Brush object
.SS "Color Advanced_Software_Engineering\&.Drawer\&.defaultColor = Color\&.Black\fC [static]\fP, \fC [protected]\fP"
.PP
The starting color of the pen / brush
.SS "float Advanced_Software_Engineering\&.Drawer\&.defaultWidth = 1f\fC [static]\fP, \fC [protected]\fP"
.PP
The deafult width of the pen
.SS "bool Advanced_Software_Engineering\&.Drawer\&.fill = false\fC [protected]\fP"
.PP
Weather enclosed spaces will have fill\&.
.SS "Graphics Advanced_Software_Engineering\&.Drawer\&.graphics\fC [protected]\fP"
.PP
The graphics object
.SS "Dictionary<string, \fBMethodChunk\fP> Advanced_Software_Engineering\&.Drawer\&.Methods = new Dictionary<string, \fBMethodChunk\fP>()"
.PP
A list of methods\&. See MethodChunk
.SS "Pen Advanced_Software_Engineering\&.Drawer\&.pen\fC [protected]\fP"
.PP
The Pen object
.SS "Point Advanced_Software_Engineering\&.Drawer\&.penPosition\fC [protected]\fP"
.PP
The current position of the pen\&.
.SS "bool Advanced_Software_Engineering\&.Drawer\&.verbChunkGeneratingMethod = false"
.PP
A veriable that represents wether the last verbchunk is a method\&. See MethodChunk
.SS "List<\fBIVerbChunk\fP> Advanced_Software_Engineering\&.Drawer\&.verbChunks = new List<\fBIVerbChunk\fP>()"
.PP
List of verbChunks used to create for loops, if statements, while loops and methods\&. See ForChunk, IfChunk, MethodChunk, WhileChunk and
.PP
\fBSee also\fP
.RS 4
IVerbChunk
.PP
.RE
.PP
\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,141 @@
.TH "Advanced_Software_Engineering.ErrorWindow" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.ErrorWindow \- The error window that can show errors, warnings and messages\&.
.SH SYNOPSIS
.br
.PP
.PP
Inherits Form\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBErrorWindow\fP ()"
.br
.RI "The default error window constructor\&. Creates an error window with the title 'Error', short description 'An error has occured', a long description of 'None' and message type of ERROR\&. "
.ti -1c
.RI "\fBErrorWindow\fP (string title, string brief, string desc, int type)"
.br
.RI "The error window constructor\&. It is responsible for creating an error form which shows the user information depending on the parameters\&. "
.ti -1c
.RI "void \fBSetPicture\fP (int type)"
.br
.RI "Sets the picture of the window\&. "
.in -1c
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "const int \fBERROR_MESSAGE\fP = 0"
.br
.RI "The error message type\&. "
.ti -1c
.RI "const int \fBWARNING_MESSAGE\fP = 1"
.br
.RI "The warning message type "
.ti -1c
.RI "const int \fBINFO_MESSAGE\fP = 2"
.br
.RI "The info message type "
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "override void \fBDispose\fP (bool disposing)"
.br
.RI "Clean up any resources being used\&. "
.in -1c
.SS "Protected Attributes"
.in +1c
.ti -1c
.RI "Dictionary< int, Image > \fBIMAGEDIR\fP"
.br
.RI "The image directory which links the message types to the image to display\&. "
.in -1c
.SH "Detailed Description"
.PP
The error window that can show errors, warnings and messages\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.ErrorWindow\&.ErrorWindow ()"
.PP
The default error window constructor\&. Creates an error window with the title 'Error', short description 'An error has occured', a long description of 'None' and message type of ERROR\&.
.SS "Advanced_Software_Engineering\&.ErrorWindow\&.ErrorWindow (string title, string brief, string desc, int type)"
.PP
The error window constructor\&. It is responsible for creating an error form which shows the user information depending on the parameters\&.
.PP
\fBParameters\fP
.RS 4
\fItitle\fP Title of the window
.br
\fIbrief\fP A brief description of the message
.br
\fIdesc\fP A detailed description of the message
.br
\fItype\fP The type of message (can either be: ERROR_MESSAGE, WARNING_MESSAGE or INFO_MESSAGE
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "override void Advanced_Software_Engineering\&.ErrorWindow\&.Dispose (bool disposing)\fC [protected]\fP"
.PP
Clean up any resources being used\&.
.PP
\fBParameters\fP
.RS 4
\fIdisposing\fP true if managed resources should be disposed; otherwise, false\&.
.RE
.PP
.SS "void Advanced_Software_Engineering\&.ErrorWindow\&.SetPicture (int type)"
.PP
Sets the picture of the window\&.
.PP
\fBParameters\fP
.RS 4
\fItype\fP The type of message (can either be: ERROR_MESSAGE, WARNING_MESSAGE or INFO_MESSAGE
.RE
.PP
.SH "Member Data Documentation"
.PP
.SS "const int Advanced_Software_Engineering\&.ErrorWindow\&.ERROR_MESSAGE = 0\fC [static]\fP"
.PP
The error message type\&.
.SS "Dictionary<int, Image> Advanced_Software_Engineering\&.ErrorWindow\&.IMAGEDIR\fC [protected]\fP"
\fBInitial value:\fP
.PP
.nf
= new Dictionary<int, Image> {
{ ERROR_MESSAGE, Properties\&.Resources\&.error },
{ WARNING_MESSAGE, Properties\&.Resources\&.warning },
{ INFO_MESSAGE, Properties\&.Resources\&.info }
}
.fi
.PP
The image directory which links the message types to the image to display\&.
.SS "const int Advanced_Software_Engineering\&.ErrorWindow\&.INFO_MESSAGE = 2\fC [static]\fP"
.PP
The info message type
.SS "const int Advanced_Software_Engineering\&.ErrorWindow\&.WARNING_MESSAGE = 1\fC [static]\fP"
.PP
The warning message type
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,105 @@
.TH "Advanced_Software_Engineering.HelperFunctions" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.HelperFunctions \- This class simply provides settings and some functions that are used across many components\&.
.SH SYNOPSIS
.br
.PP
.SS "Static Public Member Functions"
.in +1c
.ti -1c
.RI "static string \fBStrip\fP (string text)"
.br
.RI "This function removes spaces from the start and the end of the text\&. This should be unit tested\&. "
.ti -1c
.RI "static List< string > \fBStripStringArray\fP (string[] array)"
.br
.RI "Strips the strings of the full array\&. See \fBStrip(string)\fP "
.ti -1c
.RI "static \fBCommandAndParameterParserResult\fP \fBCommandAndParameterParser\fP (string text)"
.br
.RI "Parses the commands into a directry that \fBCommander\fP can use\&. See \fBCommander\fP "
.in -1c
.SH "Detailed Description"
.PP
This class simply provides settings and some functions that are used across many components\&.
.SH "Member Function Documentation"
.PP
.SS "static \fBCommandAndParameterParserResult\fP Advanced_Software_Engineering\&.HelperFunctions\&.CommandAndParameterParser (string text)\fC [static]\fP"
.PP
Parses the commands into a directry that \fBCommander\fP can use\&. See \fBCommander\fP
.PP
\fBParameters\fP
.RS 4
\fItext\fP A string command
.RE
.PP
\fBReturns\fP
.RS 4
Directory with the command and its parameters cleanly separated
.RE
.PP
.SS "static string Advanced_Software_Engineering\&.HelperFunctions\&.Strip (string text)\fC [static]\fP"
.PP
This function removes spaces from the start and the end of the text\&. This should be unit tested\&.
.PP
\fBParameters\fP
.RS 4
\fItext\fP Simply any string of any size
.RE
.PP
\fBReturns\fP
.RS 4
A string without spaces at the begining or the end
.RE
.PP
.PP
For example
.PP
.nf
string a = " a simple sentence surrounded by spaces ";
string b = StripSpaces(a);
Console\&.WriteLine(b); // => "a simple sentence surrounded by spaces";
.fi
.PP
.PP
The code won't remove internal double spaces:
.PP
.nf
string a = " a simple sentence surrounded by spaces ";
string b = StripSpaces(a);
Console\&.WriteLine(b); // => "a simple sentence surrounded by spaces";
.fi
.PP
.SS "static List<string> Advanced_Software_Engineering\&.HelperFunctions\&.StripStringArray (string[] array)\fC [static]\fP"
.PP
Strips the strings of the full array\&. See \fBStrip(string)\fP string[] tmp = {' text ', ' ', ' with', 'spaces ', ''}; Console\&.WriteLine(StripStringArray(tmp)); // => {'text', 'with', 'spaces'}
.PP
\fBParameters\fP
.RS 4
\fIarray\fP Dirty array with spaces
.RE
.PP
\fBReturns\fP
.RS 4
A stripped aray
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,53 @@
.TH "Advanced_Software_Engineering.IVerb" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.IVerb \- \fBIVerb\fP is an interface for executing and getting the descriptions of \fBVerbs\fP\&. Some \fBVerbs\fP draw lines, some verbs will assign
.SH SYNOPSIS
.br
.PP
.PP
Inherited by Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Actions\&.NoOp, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Circle\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Clear\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Dot\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.DrawLines\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.DrawTo\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Fill\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.FillColor\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.MoveTo\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.PenColor\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Quadrilateral\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Rectangle\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.RegularPolygon\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.ResetPen\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Square\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Triangle\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.DeclareMethod\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.ForChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IfChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.VerbChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.WhileChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.DeclareVariable\fP, and \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.UpdateVariable\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "This executes the \fBIVerb\fP to the drawer inside it\&. "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "The description of what the \fBIVerb\fP will do\&. "
.in -1c
.SH "Detailed Description"
.PP
\fBIVerb\fP is an interface for executing and getting the descriptions of \fBVerbs\fP\&. Some \fBVerbs\fP draw lines, some verbs will assign
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.IVerb\&.ExecuteVerb ()"
.PP
This executes the \fBIVerb\fP to the drawer inside it\&.
.PP
Implemented in \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.UpdateVariable\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.DeclareVariable\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.WhileChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.VerbChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IfChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.ForChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.DeclareMethod\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Triangle\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Square\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.RegularPolygon\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Rectangle\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Quadrilateral\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.MoveTo\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.DrawTo\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Dot\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Circle\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.PenColor\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.FillColor\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Fill\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.ResetPen\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.DrawLines\fP, and \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Clear\fP\&.
.SS "string Advanced_Software_Engineering\&.IVerb\&.GetDescription ()"
.PP
The description of what the \fBIVerb\fP will do\&.
.PP
\fBReturns\fP
.RS 4
A string description of what the \fBIVerb\fP will do
.RE
.PP
.PP
Implemented in \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.UpdateVariable\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.DeclareVariable\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.VerbChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.DeclareMethod\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Triangle\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Square\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.RegularPolygon\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Rectangle\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Quadrilateral\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.MoveTo\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.DrawTo\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Dot\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Circle\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.PenColor\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.FillColor\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Fill\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.ResetPen\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.DrawLines\fP, and \fBAdvanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Clear\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,55 @@
.TH "Advanced_Software_Engineering.Menu" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Menu \- Auto generated code\&.
.SH SYNOPSIS
.br
.PP
.PP
Inherits Form\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBMenu\fP ()"
.br
.RI "This creates the main menu window you see when launching the program\&. "
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "override void \fBDispose\fP (bool disposing)"
.br
.RI "Clean up any resources being used\&. "
.in -1c
.SH "Detailed Description"
.PP
Auto generated code\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Menu\&.Menu ()"
.PP
This creates the main menu window you see when launching the program\&. This program window is only meant to show at launch and when all of the other windows are closed\&. It launches all windows independently of each other, so a theoretically unlimited number of windows can exist\&.
.SH "Member Function Documentation"
.PP
.SS "override void Advanced_Software_Engineering\&.Menu\&.Dispose (bool disposing)\fC [protected]\fP"
.PP
Clean up any resources being used\&.
.PP
\fBParameters\fP
.RS 4
\fIdisposing\fP true if managed resources should be disposed; otherwise, false\&.
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,22 @@
.TH "Advanced_Software_Engineering.Properties" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Properties
.SH SYNOPSIS
.br
.PP
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBResources\fP"
.br
.RI "A strongly-typed resource class, for looking up localized strings, etc\&. "
.ti -1c
.RI "class \fBSettings\fP"
.br
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,27 @@
.TH "Advanced_Software_Engineering_Tests" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering_Tests
.SH SYNOPSIS
.br
.PP
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBCommandTester\fP"
.br
.RI "The \fBCommandTester\fP class tests the commands possible, mostly by getting a IVerb and checking it's description\&.\&. "
.ti -1c
.RI "class \fBHelperFunctionsTester\fP"
.br
.RI "This class tests HelperFunctions methods\&. It uses a combination of manual and random tests\&. "
.ti -1c
.RI "class \fBValueHelperTester\fP"
.br
.RI "This class tests ValueHelper methods\&. It uses a combination of manual and random tests\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,242 @@
.TH "Advanced_Software_Engineering_Tests.CommandTester" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering_Tests.CommandTester \- The \fBCommandTester\fP class tests the commands possible, mostly by getting a IVerb and checking it's description\&.\&.
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "void \fBVerbFactoryTester_Automatic1\fP ()"
.br
.RI "Automatically tests: "
.ti -1c
.RI "void \fBMoveToTester_Manual1\fP ()"
.br
.RI "tests the 'move' command\&. See MoveTo\&. "
.ti -1c
.RI "void \fBMoveToTester_Manual2\fP ()"
.br
.RI "tests the 'moveto' command\&. See MoveTo\&. "
.ti -1c
.RI "void \fBDrawToTester_Manual1\fP ()"
.br
.RI "tests the 'drawto' command\&. See DrawTo\&. "
.ti -1c
.RI "void \fBDrawToTester_Manual2\fP ()"
.br
.RI "tests the 'line' command\&. See DrawTo\&. "
.ti -1c
.RI "void \fBDrawToTester_Manual3\fP ()"
.br
.RI "tests the 'lineto' command\&. See DrawTo\&. "
.ti -1c
.RI "void \fBRegularPolygonTester_Manual1\fP ()"
.br
.RI "tests the 'regularpolygon' command\&. See RegularPolygon\&. "
.ti -1c
.RI "void \fBRegularPolygonTester_Manual2\fP ()"
.br
.RI "tests the 'rp' command\&. See RegularPolygon\&. "
.ti -1c
.RI "void \fBRegularPolygonTester_Manual3\fP ()"
.br
.RI "tests the 'regularpolygon' command\&. See RegularPolygon\&. "
.ti -1c
.RI "void \fBRegularPolygonTester_Manual4\fP ()"
.br
.RI "tests the 'rp' command\&. See RegularPolygon\&. "
.ti -1c
.RI "void \fBSquareTester_Manual1\fP ()"
.br
.RI "tests the 'square' command\&. See Square\&. "
.ti -1c
.RI "void \fBSquareTester_Manual2\fP ()"
.br
.RI "tests the 'square' command\&. See Square\&. "
.ti -1c
.RI "void \fBCircleTester_Manual1\fP ()"
.br
.RI "Tests the 'circle' command\&. See Circle\&. "
.ti -1c
.RI "void \fBTriangleTester_Manual1\fP ()"
.br
.RI "tests the 'triangle' command\&. See Triangle\&. "
.ti -1c
.RI "void \fBTriangleTester_Manual2\fP ()"
.br
.RI "tests the 'triangle' command\&. See Triangle\&. "
.ti -1c
.RI "void \fBDotTester_Manual1\fP ()"
.br
.RI "test the 'dot' command\&. See Dot\&. "
.ti -1c
.RI "void \fBClearTester_Manual1\fP ()"
.br
.RI "tests the 'clear' command\&. See Circle\&. "
.ti -1c
.RI "void \fBResetPenTester_Manual1\fP ()"
.br
.RI "Tests the 'reset' command\&. See ResetPen "
.ti -1c
.RI "void \fBResetPenTester_Manual2\fP ()"
.br
.RI "Tests the 'resetpen' command\&. See ResetPen\&. "
.ti -1c
.RI "void \fBPenTester_Manual1\fP ()"
.br
.RI "Tests the command 'pen'\&. See PenColor "
.ti -1c
.RI "void \fBFillTester_Manual1\fP ()"
.br
.RI "Tests the command 'fill'\&. See FillColor\&. "
.ti -1c
.RI "void \fBIfTester_Manual1\fP ()"
.br
.RI "Tests the 'if' command\&. It hasn't been implemented yet\&. "
.ti -1c
.RI "void \fBMethodTester_Manual1\fP ()"
.br
.RI "Tests the 'def' command\&. It hasn't been implemented yet\&. "
.ti -1c
.RI "void \fBValueTester_Manual1\fP ()"
.br
.RI "Tests the 'int' declaration and assignment\&. It hasn't been implemented yet\&. "
.in -1c
.SH "Detailed Description"
.PP
The \fBCommandTester\fP class tests the commands possible, mostly by getting a IVerb and checking it's description\&.\&.
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.CircleTester_Manual1 ()"
.PP
Tests the 'circle' command\&. See Circle\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.ClearTester_Manual1 ()"
.PP
tests the 'clear' command\&. See Circle\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.DotTester_Manual1 ()"
.PP
test the 'dot' command\&. See Dot\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.DrawToTester_Manual1 ()"
.PP
tests the 'drawto' command\&. See DrawTo\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.DrawToTester_Manual2 ()"
.PP
tests the 'line' command\&. See DrawTo\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.DrawToTester_Manual3 ()"
.PP
tests the 'lineto' command\&. See DrawTo\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.FillTester_Manual1 ()"
.PP
Tests the command 'fill'\&. See FillColor\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.IfTester_Manual1 ()"
.PP
Tests the 'if' command\&. It hasn't been implemented yet\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.MethodTester_Manual1 ()"
.PP
Tests the 'def' command\&. It hasn't been implemented yet\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.MoveToTester_Manual1 ()"
.PP
tests the 'move' command\&. See MoveTo\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.MoveToTester_Manual2 ()"
.PP
tests the 'moveto' command\&. See MoveTo\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.PenTester_Manual1 ()"
.PP
Tests the command 'pen'\&. See PenColor
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.RegularPolygonTester_Manual1 ()"
.PP
tests the 'regularpolygon' command\&. See RegularPolygon\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.RegularPolygonTester_Manual2 ()"
.PP
tests the 'rp' command\&. See RegularPolygon\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.RegularPolygonTester_Manual3 ()"
.PP
tests the 'regularpolygon' command\&. See RegularPolygon\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.RegularPolygonTester_Manual4 ()"
.PP
tests the 'rp' command\&. See RegularPolygon\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.ResetPenTester_Manual1 ()"
.PP
Tests the 'reset' command\&. See ResetPen
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.ResetPenTester_Manual2 ()"
.PP
Tests the 'resetpen' command\&. See ResetPen\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.SquareTester_Manual1 ()"
.PP
tests the 'square' command\&. See Square\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.SquareTester_Manual2 ()"
.PP
tests the 'square' command\&. See Square\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.TriangleTester_Manual1 ()"
.PP
tests the 'triangle' command\&. See Triangle\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.TriangleTester_Manual2 ()"
.PP
tests the 'triangle' command\&. See Triangle\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.ValueTester_Manual1 ()"
.PP
Tests the 'int' declaration and assignment\&. It hasn't been implemented yet\&.
.SS "void Advanced_Software_Engineering_Tests\&.CommandTester\&.VerbFactoryTester_Automatic1 ()"
.PP
Automatically tests:
.IP "\(bu" 2
moveto
.IP "\(bu" 2
drawto
.IP "\(bu" 2
line
.IP "\(bu" 2
rp Current todo list:
.IP "\(bu" 2
square
.IP "\(bu" 2
rectangle
.IP "\(bu" 2
circle
.IP "\(bu" 2
triangle
.IP "\(bu" 2
dot
.IP "\(bu" 2
clear
.IP "\(bu" 2
pen
.IP "\(bu" 2
fill
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,104 @@
.TH "Advanced_Software_Engineering_Tests.HelperFunctionsTester" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering_Tests.HelperFunctionsTester \- This class tests HelperFunctions methods\&. It uses a combination of manual and random tests\&.
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "void \fBStrip_Random1\fP ()"
.br
.RI "Random strip spaces test "
.ti -1c
.RI "void \fBStrip_Manual1\fP ()"
.br
.RI "Manual HelperFunctions\&.Strip(string) test "
.ti -1c
.RI "void \fBStrip_Manual2\fP ()"
.br
.RI "Manual HelperFunctions\&.Strip(string) test "
.ti -1c
.RI "void \fBStripStringArray_Manual1\fP ()"
.br
.RI "Manual HelperFunctions\&.StripStringArray(string[]) test\&. "
.ti -1c
.RI "void \fBStripStringArray_Manual2\fP ()"
.br
.RI "Manual HelperFunctions\&.StripStringArray(string[]) test\&. "
.ti -1c
.RI "void \fBCommandAndParameterParser_Manual1\fP ()"
.br
.RI "Manual HelperFunctions\&.CommandAndParameterParser(string) test\&. "
.ti -1c
.RI "void \fBCommandAndParameterParser_Manual2\fP ()"
.br
.RI "Manual HelperFunctions\&.CommandAndParameterParser(string) test\&. "
.ti -1c
.RI "void \fBCommandAndParameterParser_Manual3\fP ()"
.br
.RI "Manual HelperFunctions\&.CommandAndParameterParser(string) test\&. "
.ti -1c
.RI "void \fBCommandAndParameterParser_Manual4\fP ()"
.br
.RI "Manual HelperFunctions\&.CommandAndParameterParser(string) test\&. "
.ti -1c
.RI "void \fBCommandAndParameterParser_Random1\fP ()"
.br
.RI "Random HelperFunctions\&.CommandAndParameterParser(string) test\&. "
.in -1c
.SH "Detailed Description"
.PP
This class tests HelperFunctions methods\&. It uses a combination of manual and random tests\&.
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering_Tests\&.HelperFunctionsTester\&.CommandAndParameterParser_Manual1 ()"
.PP
Manual HelperFunctions\&.CommandAndParameterParser(string) test\&.
.SS "void Advanced_Software_Engineering_Tests\&.HelperFunctionsTester\&.CommandAndParameterParser_Manual2 ()"
.PP
Manual HelperFunctions\&.CommandAndParameterParser(string) test\&.
.SS "void Advanced_Software_Engineering_Tests\&.HelperFunctionsTester\&.CommandAndParameterParser_Manual3 ()"
.PP
Manual HelperFunctions\&.CommandAndParameterParser(string) test\&.
.SS "void Advanced_Software_Engineering_Tests\&.HelperFunctionsTester\&.CommandAndParameterParser_Manual4 ()"
.PP
Manual HelperFunctions\&.CommandAndParameterParser(string) test\&.
.SS "void Advanced_Software_Engineering_Tests\&.HelperFunctionsTester\&.CommandAndParameterParser_Random1 ()"
.PP
Random HelperFunctions\&.CommandAndParameterParser(string) test\&.
.SS "void Advanced_Software_Engineering_Tests\&.HelperFunctionsTester\&.Strip_Manual1 ()"
.PP
Manual HelperFunctions\&.Strip(string) test
.SS "void Advanced_Software_Engineering_Tests\&.HelperFunctionsTester\&.Strip_Manual2 ()"
.PP
Manual HelperFunctions\&.Strip(string) test
.SS "void Advanced_Software_Engineering_Tests\&.HelperFunctionsTester\&.Strip_Random1 ()"
.PP
Random strip spaces test
.SS "void Advanced_Software_Engineering_Tests\&.HelperFunctionsTester\&.StripStringArray_Manual1 ()"
.PP
Manual HelperFunctions\&.StripStringArray(string[]) test\&.
.SS "void Advanced_Software_Engineering_Tests\&.HelperFunctionsTester\&.StripStringArray_Manual2 ()"
.PP
Manual HelperFunctions\&.StripStringArray(string[]) test\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,19 @@
.TH "Advanced_Software_Engineering_Tests.Properties" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering_Tests.Properties
.SH SYNOPSIS
.br
.PP
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBResources\fP"
.br
.RI "A strongly-typed resource class, for looking up localized strings, etc\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,78 @@
.TH "Advanced_Software_Engineering.TextEditor" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.TextEditor \- Auto generated code
.SH SYNOPSIS
.br
.PP
.PP
Inherits Form\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBTextEditor\fP ()"
.br
.RI "The text editor is the main window that the user will be using for writing code\&. "
.ti -1c
.RI "\fBTextEditor\fP (OpenFileDialog openFile)"
.br
.RI "The text editor is the main window that the user will be using for writing code\&. "
.ti -1c
.RI "void \fBCheckCode\fP ()"
.br
.RI "This function checks if the code written is OK "
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "override void \fBDispose\fP (bool disposing)"
.br
.RI "Clean up any resources being used\&. "
.in -1c
.SH "Detailed Description"
.PP
Auto generated code
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.TextEditor\&.TextEditor ()"
.PP
The text editor is the main window that the user will be using for writing code\&.
.SS "Advanced_Software_Engineering\&.TextEditor\&.TextEditor (OpenFileDialog openFile)"
.PP
The text editor is the main window that the user will be using for writing code\&.
.PP
\fBParameters\fP
.RS 4
\fIopenFile\fP File dialog which points to the file to open
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.TextEditor\&.CheckCode ()"
.PP
This function checks if the code written is OK
.SS "override void Advanced_Software_Engineering\&.TextEditor\&.Dispose (bool disposing)\fC [protected]\fP"
.PP
Clean up any resources being used\&.
.PP
\fBParameters\fP
.RS 4
\fIdisposing\fP true if managed resources should be disposed; otherwise, false\&.
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,46 @@
.TH "Advanced_Software_Engineering.VerbFactory" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.VerbFactory \- This class is responsible for creating \fBVerbs\fP\&.
.SH SYNOPSIS
.br
.PP
.SS "Static Public Member Functions"
.in +1c
.ti -1c
.RI "static \fBIVerb\fP \fBMakeVerb\fP (\fBDrawer\fP drawer, string fullCommand)"
.br
.RI "This function returns a \fBIVerb\fP from a command and drawer\&. "
.in -1c
.SH "Detailed Description"
.PP
This class is responsible for creating \fBVerbs\fP\&.
.SH "Member Function Documentation"
.PP
.SS "static \fBIVerb\fP Advanced_Software_Engineering\&.VerbFactory\&.MakeVerb (\fBDrawer\fP drawer, string fullCommand)\fC [static]\fP"
.PP
This function returns a \fBIVerb\fP from a command and drawer\&. This factory is specifically useful since it automatically converts the parameters to what they should be\&.
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP The drawer to affect
.br
\fIfullCommand\fP The command as a string
.RE
.PP
\fBReturns\fP
.RS 4
A \fBIVerb\fP that maches the command
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,11 @@
.TH "Advanced_Software_Engineering.Verbs" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs
.SH SYNOPSIS
.br
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,75 @@
.TH "Advanced_Software_Engineering.Verbs.DrawingVerbs" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.DrawingVerbs
.SH SYNOPSIS
.br
.PP
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBCircle\fP"
.br
.RI "\fBCircle\fP \fBIVerb\fP class\&. "
.ti -1c
.RI "class \fBClear\fP"
.br
.RI "The \fBClear\fP \fBIVerb\fP class\&. "
.ti -1c
.RI "class \fBDot\fP"
.br
.RI "The \fBDot\fP \fBIVerb\fP class "
.ti -1c
.RI "class \fBDrawLines\fP"
.br
.RI "\fBDrawLines\fP \fBIVerb\fP class "
.ti -1c
.RI "class \fBDrawTo\fP"
.br
.RI "\fBDrawTo\fP \fBIVerb\fP class "
.ti -1c
.RI "class \fBFill\fP"
.br
.RI "\fBFill\fP \fBIVerb\fP class "
.ti -1c
.RI "class \fBFillColor\fP"
.br
.RI "The \fBFillColor\fP \fBIVerb\fP class "
.ti -1c
.RI "class \fBMoveTo\fP"
.br
.RI "\fBMoveTo\fP \fBIVerb\fP class "
.ti -1c
.RI "class \fBPenColor\fP"
.br
.RI "The \fBPenColor\fP \fBIVerb\fP class "
.ti -1c
.RI "class \fBQuadrilateral\fP"
.br
.RI "The \fBQuadrilateral\fP \fBIVerb\fP class "
.ti -1c
.RI "class \fBRectangle\fP"
.br
.RI "\fBRectangle\fP \fBIVerb\fP class "
.ti -1c
.RI "class \fBRegularPolygon\fP"
.br
.RI "A class that generates a \fBRegularPolygon\fP \fBIVerb\fP\&. "
.ti -1c
.RI "class \fBResetPen\fP"
.br
.RI "Setsets the pen to the initial position\&. "
.ti -1c
.RI "class \fBSquare\fP"
.br
.RI "The \fBSquare\fP \fBIVerb\fP class "
.ti -1c
.RI "class \fBTriangle\fP"
.br
.RI "The \fBTriangle\fP \fBIVerb\fP class "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,18 @@
.TH "Advanced_Software_Engineering.Verbs.DrawingVerbs.Actions" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.DrawingVerbs.Actions
.SH SYNOPSIS
.br
.PP
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBNoOp\fP"
.br
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,72 @@
.TH "Advanced_Software_Engineering.Verbs.DrawingVerbs.Circle" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.DrawingVerbs.Circle \- \fBCircle\fP \fBIVerb\fP class\&.
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBCircle\fP (\fBDrawer\fP drawer, \fBIValue\fP scale)"
.br
.RI "\fBCircle\fP constructor creates the \fBCircle\fP \fBIVerb\fP\&. "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "Execute the \fBCircle\fP \fBIVerb\fP, which is to draw a circle with the drawer\&. "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Describes how the circle will be drawn\&. "
.in -1c
.SH "Detailed Description"
.PP
\fBCircle\fP \fBIVerb\fP class\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Circle\&.Circle (\fBDrawer\fP drawer, \fBIValue\fP scale)"
.PP
\fBCircle\fP constructor creates the \fBCircle\fP \fBIVerb\fP\&.
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP drawer
.br
\fIscale\fP scale of the circle
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Circle\&.ExecuteVerb ()"
.PP
Execute the \fBCircle\fP \fBIVerb\fP, which is to draw a circle with the drawer\&.
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Circle\&.GetDescription ()"
.PP
Describes how the circle will be drawn\&.
.PP
\fBReturns\fP
.RS 4
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,70 @@
.TH "Advanced_Software_Engineering.Verbs.DrawingVerbs.Clear" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.DrawingVerbs.Clear \- The \fBClear\fP \fBIVerb\fP class\&.
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBClear\fP (\fBDrawer\fP drawer)"
.br
.RI "Create the clear \fBIVerb\fP "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "Execute the clear \fBIVerb\fP\&. It clears the drawer\&. "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Describes the clearing\&. "
.in -1c
.SH "Detailed Description"
.PP
The \fBClear\fP \fBIVerb\fP class\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Clear\&.Clear (\fBDrawer\fP drawer)"
.PP
Create the clear \fBIVerb\fP
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Clear\&.ExecuteVerb ()"
.PP
Execute the clear \fBIVerb\fP\&. It clears the drawer\&.
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Clear\&.GetDescription ()"
.PP
Describes the clearing\&.
.PP
\fBReturns\fP
.RS 4
A description of clearing
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,70 @@
.TH "Advanced_Software_Engineering.Verbs.DrawingVerbs.Dot" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.DrawingVerbs.Dot \- The \fBDot\fP \fBIVerb\fP class
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBDot\fP (\fBDrawer\fP drawer)"
.br
.RI "Creates the \fBDot\fP \fBIVerb\fP "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "Draws a dot where the pen currently is\&. "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Gets the description of the command "
.in -1c
.SH "Detailed Description"
.PP
The \fBDot\fP \fBIVerb\fP class
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Dot\&.Dot (\fBDrawer\fP drawer)"
.PP
Creates the \fBDot\fP \fBIVerb\fP
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Dot\&.ExecuteVerb ()"
.PP
Draws a dot where the pen currently is\&.
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Dot\&.GetDescription ()"
.PP
Gets the description of the command
.PP
\fBReturns\fP
.RS 4
The description of the command
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,72 @@
.TH "Advanced_Software_Engineering.Verbs.DrawingVerbs.DrawLines" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.DrawingVerbs.DrawLines \- \fBDrawLines\fP \fBIVerb\fP class
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBDrawLines\fP (\fBDrawer\fP drawer, \fBPointValue\fP[] points)"
.br
.RI "\fBDrawLines\fP constructor "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "Draws all the lines "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Gets description of the command\&. "
.in -1c
.SH "Detailed Description"
.PP
\fBDrawLines\fP \fBIVerb\fP class
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.DrawLines\&.DrawLines (\fBDrawer\fP drawer, \fBPointValue\fP[] points)"
.PP
\fBDrawLines\fP constructor
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP drawer
.br
\fIpoints\fP All of the points to visit
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.DrawLines\&.ExecuteVerb ()"
.PP
Draws all the lines
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.DrawLines\&.GetDescription ()"
.PP
Gets description of the command\&.
.PP
\fBReturns\fP
.RS 4
A generic description of the command
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,72 @@
.TH "Advanced_Software_Engineering.Verbs.DrawingVerbs.DrawTo" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.DrawingVerbs.DrawTo \- \fBDrawTo\fP \fBIVerb\fP class
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBDrawTo\fP (\fBDrawer\fP drawer, \fBPointValue\fP point)"
.br
.RI "Creates the \fBDrawTo\fP intstance "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "Draws the line "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Describes how the line is going to be drawn "
.in -1c
.SH "Detailed Description"
.PP
\fBDrawTo\fP \fBIVerb\fP class
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.DrawTo\&.DrawTo (\fBDrawer\fP drawer, \fBPointValue\fP point)"
.PP
Creates the \fBDrawTo\fP intstance
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP drawer
.br
\fIpoint\fP Position to move to
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.DrawTo\&.ExecuteVerb ()"
.PP
Draws the line
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.DrawTo\&.GetDescription ()"
.PP
Describes how the line is going to be drawn
.PP
\fBReturns\fP
.RS 4
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,72 @@
.TH "Advanced_Software_Engineering.Verbs.DrawingVerbs.Fill" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.DrawingVerbs.Fill \- \fBFill\fP \fBIVerb\fP class
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBFill\fP (\fBDrawer\fP drawer, bool enable)"
.br
.RI "\fBFill\fP enables or disables the fill insider drawer "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "Sets the fill status "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Describes what the command will do "
.in -1c
.SH "Detailed Description"
.PP
\fBFill\fP \fBIVerb\fP class
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Fill\&.Fill (\fBDrawer\fP drawer, bool enable)"
.PP
\fBFill\fP enables or disables the fill insider drawer
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP drawer
.br
\fIenable\fP Enable fill?
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Fill\&.ExecuteVerb ()"
.PP
Sets the fill status
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Fill\&.GetDescription ()"
.PP
Describes what the command will do
.PP
\fBReturns\fP
.RS 4
Description of what the \fBIVerb\fP will do
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,72 @@
.TH "Advanced_Software_Engineering.Verbs.DrawingVerbs.FillColor" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.DrawingVerbs.FillColor \- The \fBFillColor\fP \fBIVerb\fP class
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBFillColor\fP (\fBDrawer\fP drawer, \fBIValue\fP color)"
.br
.RI "Create the \fBFillColor\fP instance "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "Set the fill color "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Get description of the color that the drawer will use "
.in -1c
.SH "Detailed Description"
.PP
The \fBFillColor\fP \fBIVerb\fP class
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.FillColor\&.FillColor (\fBDrawer\fP drawer, \fBIValue\fP color)"
.PP
Create the \fBFillColor\fP instance
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP drawer
.br
\fIcolor\fP The color of the fill
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.FillColor\&.ExecuteVerb ()"
.PP
Set the fill color
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.FillColor\&.GetDescription ()"
.PP
Get description of the color that the drawer will use
.PP
\fBReturns\fP
.RS 4
Description of the fill color
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,72 @@
.TH "Advanced_Software_Engineering.Verbs.DrawingVerbs.MoveTo" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.DrawingVerbs.MoveTo \- \fBMoveTo\fP \fBIVerb\fP class
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBMoveTo\fP (\fBDrawer\fP drawer, \fBPointValue\fP point)"
.br
.RI "Creates a \fBMoveTo\fP instance "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "Moves the pen to the position "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Describes where the pen will move\&. "
.in -1c
.SH "Detailed Description"
.PP
\fBMoveTo\fP \fBIVerb\fP class
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.MoveTo\&.MoveTo (\fBDrawer\fP drawer, \fBPointValue\fP point)"
.PP
Creates a \fBMoveTo\fP instance
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP drawer
.br
\fIpoint\fP Position to move to
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.MoveTo\&.ExecuteVerb ()"
.PP
Moves the pen to the position
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.MoveTo\&.GetDescription ()"
.PP
Describes where the pen will move\&.
.PP
\fBReturns\fP
.RS 4
Description where the pen will move to
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,72 @@
.TH "Advanced_Software_Engineering.Verbs.DrawingVerbs.PenColor" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.DrawingVerbs.PenColor \- The \fBPenColor\fP \fBIVerb\fP class
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBPenColor\fP (\fBDrawer\fP drawer, \fBIValue\fP color)"
.br
.RI "Creates a \fBPenColor\fP instance "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "Sets the pen color "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Describes the pen color "
.in -1c
.SH "Detailed Description"
.PP
The \fBPenColor\fP \fBIVerb\fP class
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.PenColor\&.PenColor (\fBDrawer\fP drawer, \fBIValue\fP color)"
.PP
Creates a \fBPenColor\fP instance
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP drawer
.br
\fIcolor\fP Pen color
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.PenColor\&.ExecuteVerb ()"
.PP
Sets the pen color
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.PenColor\&.GetDescription ()"
.PP
Describes the pen color
.PP
\fBReturns\fP
.RS 4
The description pen color
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,78 @@
.TH "Advanced_Software_Engineering.Verbs.DrawingVerbs.Quadrilateral" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.DrawingVerbs.Quadrilateral \- The \fBQuadrilateral\fP \fBIVerb\fP class
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBQuadrilateral\fP (\fBDrawer\fP drawer, \fBPointValue\fP point1, \fBPointValue\fP point2, \fBPointValue\fP point3, \fBPointValue\fP point4)"
.br
.RI "Creates a \fBQuadrilateral\fP instances "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "Draws a quadrilateral from the points "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Describes all of the points "
.in -1c
.SH "Detailed Description"
.PP
The \fBQuadrilateral\fP \fBIVerb\fP class
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Quadrilateral\&.Quadrilateral (\fBDrawer\fP drawer, \fBPointValue\fP point1, \fBPointValue\fP point2, \fBPointValue\fP point3, \fBPointValue\fP point4)"
.PP
Creates a \fBQuadrilateral\fP instances
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP drawer
.br
\fIpoint1\fP first point
.br
\fIpoint2\fP second point
.br
\fIpoint3\fP third point
.br
\fIpoint4\fP fourth point
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Quadrilateral\&.ExecuteVerb ()"
.PP
Draws a quadrilateral from the points
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Quadrilateral\&.GetDescription ()"
.PP
Describes all of the points
.PP
\fBReturns\fP
.RS 4
Description of the quadrilateral points
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,74 @@
.TH "Advanced_Software_Engineering.Verbs.DrawingVerbs.Rectangle" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.DrawingVerbs.Rectangle \- \fBRectangle\fP \fBIVerb\fP class
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBRectangle\fP (\fBDrawer\fP drawer, \fBIValue\fP width, \fBIValue\fP height)"
.br
.RI "Create a rectangle instance\&. Makes sure that "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Gets the description from the rectangle "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "Draws the rectangle "
.in -1c
.SH "Detailed Description"
.PP
\fBRectangle\fP \fBIVerb\fP class
<todo> Correct </todo>
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Rectangle\&.Rectangle (\fBDrawer\fP drawer, \fBIValue\fP width, \fBIValue\fP height)"
.PP
Create a rectangle instance\&. Makes sure that
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP drawer
.br
\fIwidth\fP rectangle width
.br
\fIheight\fP rectangle height
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Rectangle\&.ExecuteVerb ()"
.PP
Draws the rectangle
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Rectangle\&.GetDescription ()"
.PP
Gets the description from the rectangle
.PP
\fBReturns\fP
.RS 4
Describes the rectangle
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,78 @@
.TH "Advanced_Software_Engineering.Verbs.DrawingVerbs.RegularPolygon" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.DrawingVerbs.RegularPolygon \- A class that generates a \fBRegularPolygon\fP \fBIVerb\fP\&.
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBRegularPolygon\fP (\fBDrawer\fP drawer, \fBIValue\fP sides, \fBIValue\fP scale, \fBIValue\fP offset, \fBIValue\fP degMode)"
.br
.RI "Draws a regular polygon\&. See \&. See also \&. "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "Draws the regular polygons "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Describes how the regular polygon will be drawn "
.in -1c
.SH "Detailed Description"
.PP
A class that generates a \fBRegularPolygon\fP \fBIVerb\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.RegularPolygon\&.RegularPolygon (\fBDrawer\fP drawer, \fBIValue\fP sides, \fBIValue\fP scale, \fBIValue\fP offset, \fBIValue\fP degMode)"
.PP
Draws a regular polygon\&. See \&. See also \&.
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP drawer
.br
\fIsides\fP Number of sides in the regular polygon
.br
\fIscale\fP The scale of the regular polygon
.br
\fIoffset\fP Rotation offset of the regular polygon
.br
\fIdegMode\fP Default is true\&. If true, offset is in degrees\&. If false, offset is in gradians\&.
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.RegularPolygon\&.ExecuteVerb ()"
.PP
Draws the regular polygons
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.RegularPolygon\&.GetDescription ()"
.PP
Describes how the regular polygon will be drawn
.PP
\fBReturns\fP
.RS 4
A description of how the polygon will be drawn
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,70 @@
.TH "Advanced_Software_Engineering.Verbs.DrawingVerbs.ResetPen" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.DrawingVerbs.ResetPen \- Setsets the pen to the initial position\&.
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBResetPen\fP (\fBDrawer\fP drawer)"
.br
.RI "Creates the \fBResetPen\fP \fBIVerb\fP "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "Moves the pen to 0, 0 "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Gets the description of the command\&. "
.in -1c
.SH "Detailed Description"
.PP
Setsets the pen to the initial position\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.ResetPen\&.ResetPen (\fBDrawer\fP drawer)"
.PP
Creates the \fBResetPen\fP \fBIVerb\fP
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP drawer
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.ResetPen\&.ExecuteVerb ()"
.PP
Moves the pen to 0, 0
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.ResetPen\&.GetDescription ()"
.PP
Gets the description of the command\&.
.PP
\fBReturns\fP
.RS 4
The description of the command
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,91 @@
.TH "Advanced_Software_Engineering.Verbs.DrawingVerbs.Square" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.DrawingVerbs.Square \- The \fBSquare\fP \fBIVerb\fP class
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBSquare\fP (\fBDrawer\fP drawer, \fBIValue\fP scale)"
.br
.RI "A new Squre instance\&. Draws squares using \fBRegularPolygon\fP "
.ti -1c
.RI "\fBSquare\fP (\fBDrawer\fP drawer, \fBIValue\fP scale, \fBIValue\fP offset)"
.br
.RI "A new Squre instance\&. Draws squares using \fBRegularPolygon\fP "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "Draws the regular polygon (square) "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Gets description of how it will draw the regular polygon (square) "
.in -1c
.SH "Detailed Description"
.PP
The \fBSquare\fP \fBIVerb\fP class
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Square\&.Square (\fBDrawer\fP drawer, \fBIValue\fP scale)"
.PP
A new Squre instance\&. Draws squares using \fBRegularPolygon\fP
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP drawer
.br
\fIscale\fP size of the square
.RE
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Square\&.Square (\fBDrawer\fP drawer, \fBIValue\fP scale, \fBIValue\fP offset)"
.PP
A new Squre instance\&. Draws squares using \fBRegularPolygon\fP
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP drawer
.br
\fIscale\fP size of the square
.br
\fIoffset\fP rotation offset in degrees
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Square\&.ExecuteVerb ()"
.PP
Draws the regular polygon (square)
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Square\&.GetDescription ()"
.PP
Gets description of how it will draw the regular polygon (square)
.PP
\fBReturns\fP
.RS 4
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,112 @@
.TH "Advanced_Software_Engineering.Verbs.DrawingVerbs.Triangle" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.DrawingVerbs.Triangle \- The \fBTriangle\fP \fBIVerb\fP class
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBTriangle\fP (\fBDrawer\fP drawer, \fBIValue\fP scale)"
.br
.RI "Creates a new \fBTriangle\fP instance using \fBRegularPolygon\fP\&. "
.ti -1c
.RI "\fBTriangle\fP (\fBDrawer\fP drawer, \fBIValue\fP scale, \fBIValue\fP offset)"
.br
.RI "Creates a new \fBTriangle\fP instance using \fBRegularPolygon\fP\&. "
.ti -1c
.RI "\fBTriangle\fP (\fBDrawer\fP drawer, \fBPointValue\fP point1, \fBPointValue\fP point2, \fBPointValue\fP point3)"
.br
.RI "Creates a new \fBTriangle\fP instance using \fBDrawLines\fP\&. It draws lines to the points provided "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "Executes the created \fBIVerb\fP, either \fBRegularPolygon\fP or \fBDrawLines\fP\&. "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Describes how the triangle will be drawn "
.in -1c
.SH "Detailed Description"
.PP
The \fBTriangle\fP \fBIVerb\fP class
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Triangle\&.Triangle (\fBDrawer\fP drawer, \fBIValue\fP scale)"
.PP
Creates a new \fBTriangle\fP instance using \fBRegularPolygon\fP\&.
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP drawer
.br
\fIscale\fP the scale of the triangle
.RE
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Triangle\&.Triangle (\fBDrawer\fP drawer, \fBIValue\fP scale, \fBIValue\fP offset)"
.PP
Creates a new \fBTriangle\fP instance using \fBRegularPolygon\fP\&.
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP drawer
.br
\fIscale\fP the scale of the triangle
.br
\fIoffset\fP the offset of the triangle in degrees
.RE
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Triangle\&.Triangle (\fBDrawer\fP drawer, \fBPointValue\fP point1, \fBPointValue\fP point2, \fBPointValue\fP point3)"
.PP
Creates a new \fBTriangle\fP instance using \fBDrawLines\fP\&. It draws lines to the points provided
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP drawer
.br
\fIpoint1\fP first point
.br
\fIpoint2\fP second point
.br
\fIpoint3\fP third point
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Triangle\&.ExecuteVerb ()"
.PP
Executes the created \fBIVerb\fP, either \fBRegularPolygon\fP or \fBDrawLines\fP\&.
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.DrawingVerbs\&.Triangle\&.GetDescription ()"
.PP
Describes how the triangle will be drawn
.PP
\fBReturns\fP
.RS 4
Description of how the triangle will be drawn
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,43 @@
.TH "Advanced_Software_Engineering.Verbs.Flow" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Flow
.SH SYNOPSIS
.br
.PP
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBDeclareMethod\fP"
.br
.RI "Declares a method\&. See DrawingVerbs\&.Actions\&.NoOp because these classes behave similarly "
.ti -1c
.RI "class \fBForChunk\fP"
.br
.RI "A \fBForChunk\fP is similar to a \fBWhileChunk\fP\&. It executes a specific number of times\&. "
.ti -1c
.RI "class \fBIfChunk\fP"
.br
.RI "A simple If Object "
.ti -1c
.RI "interface \fBIVerbChunk\fP"
.br
.RI "A Collection of chunks to be executed\&. They extend \fBIVerb\fP because they should be interchangable\&. "
.ti -1c
.RI "class \fBMethodChunk\fP"
.br
.RI "The method chunk class "
.ti -1c
.RI "class \fBVerbChunk\fP"
.br
.RI "A simple \fBVerbChunk\fP\&. Used for storing and executing a bunch of verbs "
.ti -1c
.RI "class \fBWhileChunk\fP"
.br
.RI "A Chunk that loops over its code "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,89 @@
.TH "Advanced_Software_Engineering.Verbs.Flow.DeclareMethod" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Flow.DeclareMethod \- Declares a method\&. See DrawingVerbs\&.Actions\&.NoOp because these classes behave similarly
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP, and \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBDeclareMethod\fP (\fBDrawer\fP drawer, string methodName)"
.br
.RI "Creates a new \fBDeclareMethod\fP object "
.ti -1c
.RI "void \fBAddVerb\fP (\fBIVerb\fP verb)"
.br
.RI "Adds a verb to the verb list\&. More specifically, the verb list of the \fBMethodChunk\fP\&. See \fBMethodChunk\fP "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "This method quite literally does nothing upon execution because the declaration of method happens at parse time "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Gets the description of what the chunk will do "
.in -1c
.SH "Detailed Description"
.PP
Declares a method\&. See DrawingVerbs\&.Actions\&.NoOp because these classes behave similarly
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.Flow\&.DeclareMethod\&.DeclareMethod (\fBDrawer\fP drawer, string methodName)"
.PP
Creates a new \fBDeclareMethod\fP object
.PP
\fBParameters\fP
.RS 4
\fIdrawer\fP The drawer is used for getting the method specifically
.br
\fImethodName\fP The name of the method
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.Flow\&.DeclareMethod\&.AddVerb (\fBIVerb\fP verb)"
.PP
Adds a verb to the verb list\&. More specifically, the verb list of the \fBMethodChunk\fP\&. See \fBMethodChunk\fP
.PP
\fBParameters\fP
.RS 4
\fIverb\fP The verb to add
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\fP\&.
.SS "void Advanced_Software_Engineering\&.Verbs\&.Flow\&.DeclareMethod\&.ExecuteVerb ()"
.PP
This method quite literally does nothing upon execution because the declaration of method happens at parse time
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.Flow\&.DeclareMethod\&.GetDescription ()"
.PP
Gets the description of what the chunk will do
.PP
\fBReturns\fP
.RS 4
A description of the chunk's actions
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,74 @@
.TH "Advanced_Software_Engineering.Verbs.Flow.ForChunk" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Flow.ForChunk \- A \fBForChunk\fP is similar to a \fBWhileChunk\fP\&. It executes a specific number of times\&.
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.VerbChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\fP, and \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBForChunk\fP (\fBValueStorage\fP valueStorage, \fBIValue\fP conditional)"
.br
.RI "A For Loop object "
.ti -1c
.RI "\fBForChunk\fP (\fBValueStorage\fP valueStorage, \fBIValue\fP conditional, \fBIVerb\fP oneLineVerb)"
.br
.RI "A For Loop object "
.ti -1c
.RI "new void \fBExecuteVerb\fP ()"
.br
.RI "Executes the chunk the number of specified times "
.in -1c
.SH "Detailed Description"
.PP
A \fBForChunk\fP is similar to a \fBWhileChunk\fP\&. It executes a specific number of times\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.Flow\&.ForChunk\&.ForChunk (\fBValueStorage\fP valueStorage, \fBIValue\fP conditional)"
.PP
A For Loop object
.PP
\fBParameters\fP
.RS 4
\fIvalueStorage\fP The ValueStorage for increasing and decreasing the stack
.br
\fIconditional\fP Preferably Value\&.ValueTypes\&.IntValue, the number of times the loop should execute\&.
.RE
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.Flow\&.ForChunk\&.ForChunk (\fBValueStorage\fP valueStorage, \fBIValue\fP conditional, \fBIVerb\fP oneLineVerb)"
.PP
A For Loop object
.PP
\fBParameters\fP
.RS 4
\fIvalueStorage\fP The ValueStorage for increasing and decreasing the stack
.br
\fIconditional\fP Preferably Value\&.ValueTypes\&.IntValue, the number of times the loop should execute\&.
.br
\fIoneLineVerb\fP A verb to execute in a single line
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "new void Advanced_Software_Engineering\&.Verbs\&.Flow\&.ForChunk\&.ExecuteVerb ()"
.PP
Executes the chunk the number of specified times
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,76 @@
.TH "Advanced_Software_Engineering.Verbs.Flow.IVerbChunk" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Flow.IVerbChunk \- A Collection of chunks to be executed\&. They extend \fBIVerb\fP because they should be interchangable\&.
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.PP
Inherited by \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.DeclareMethod\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.ForChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IfChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.VerbChunk\fP, and \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.WhileChunk\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "void \fBAddVerb\fP (\fBIVerb\fP verb)"
.br
.RI "Adds a verb to the verb list "
.ti -1c
.RI "new void \fBExecuteVerb\fP ()"
.br
.RI "Execute the whole chunk "
.ti -1c
.RI "new string \fBGetDescription\fP ()"
.br
.RI "Gets the description of what the chunk will do "
.in -1c
.SH "Detailed Description"
.PP
A Collection of chunks to be executed\&. They extend \fBIVerb\fP because they should be interchangable\&.
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\&.AddVerb (\fBIVerb\fP verb)"
.PP
Adds a verb to the verb list
.PP
\fBParameters\fP
.RS 4
\fIverb\fP The verb to add
.RE
.PP
.PP
Implemented in \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.VerbChunk\fP, and \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.DeclareMethod\fP\&.
.SS "new void Advanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\&.ExecuteVerb ()"
.PP
Execute the whole chunk
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.PP
Implemented in \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.WhileChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.VerbChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IfChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.ForChunk\fP, and \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.DeclareMethod\fP\&.
.SS "new string Advanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\&.GetDescription ()"
.PP
Gets the description of what the chunk will do
.PP
\fBReturns\fP
.RS 4
A description of the chunk's actions
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.PP
Implemented in \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.VerbChunk\fP, and \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.DeclareMethod\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,74 @@
.TH "Advanced_Software_Engineering.Verbs.Flow.IfChunk" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Flow.IfChunk \- A simple If Object
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.VerbChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\fP, and \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBIfChunk\fP (\fBValueStorage\fP valueStorage, \fBIValue\fP conditional)"
.br
.RI "Create a new if object "
.ti -1c
.RI "\fBIfChunk\fP (\fBValueStorage\fP valueStorage, \fBIValue\fP conditional, \fBIVerb\fP oneLineVerb)"
.br
.RI "Create a new if object "
.ti -1c
.RI "new void \fBExecuteVerb\fP ()"
.br
.RI "Executes the chunk if the conditional is true "
.in -1c
.SH "Detailed Description"
.PP
A simple If Object
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.Flow\&.IfChunk\&.IfChunk (\fBValueStorage\fP valueStorage, \fBIValue\fP conditional)"
.PP
Create a new if object
.PP
\fBParameters\fP
.RS 4
\fIvalueStorage\fP The ValueStorage for increasing and decreasing the stack
.br
\fIconditional\fP Preferably Value\&.ValueTypes\&.BoolValue, if the chunk should execute\&.
.RE
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.Flow\&.IfChunk\&.IfChunk (\fBValueStorage\fP valueStorage, \fBIValue\fP conditional, \fBIVerb\fP oneLineVerb)"
.PP
Create a new if object
.PP
\fBParameters\fP
.RS 4
\fIvalueStorage\fP The ValueStorage for increasing and decreasing the stack
.br
\fIconditional\fP Preferably Value\&.ValueTypes\&.BoolValue, if the chunk should execute\&.
.br
\fIoneLineVerb\fP A verb to execute in a single line
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "new void Advanced_Software_Engineering\&.Verbs\&.Flow\&.IfChunk\&.ExecuteVerb ()"
.PP
Executes the chunk if the conditional is true
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,234 @@
.TH "Advanced_Software_Engineering.Verbs.Flow.MethodChunk" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Flow.MethodChunk \- The method chunk class
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.VerbChunk\fP, \fBAdvanced_Software_Engineering\&.IVerb\fP, and \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBMethodChunk\fP (\fBValueStorage\fP valueStorage, \fBDeclareVariable\fP[] variables)"
.br
.RI "The method chunk "
.ti -1c
.RI "List< string > \fBGetVariableNames\fP ()"
.br
.RI "Gets all of the variable names "
.ti -1c
.RI "void \fBSetVariableValues\fP (\fBUpdateVariable\fP[] updateVariables)"
.br
.RI "MUST BE CALLED\&. This method is really important for setting the updated values into the method's stack\&. "
.ti -1c
.RI "\fBMethodChunk\fP \fBDuplicateForExecution\fP ()"
.br
.RI "This method allows the method chunk to replicate itself before being ran\&. Essential for recursion\&. "
.ti -1c
.RI "new void \fBExecuteVerb\fP ()"
.br
.RI "Executes the method chunk\&. "
.ti -1c
.RI "\fBIValue\fP \fBGetResult\fP ()"
.br
.RI "Gets a result from the method\&. (Experimental) "
.ti -1c
.RI "\fBIValue\fP \fBClone\fP ()"
.br
.RI "Clones the result of the method (Experimental) "
.ti -1c
.RI "string \fBGetOriginalType\fP ()"
.br
.RI "Gets the original type of the result of the method (Experimental) "
.ti -1c
.RI "bool \fBIsInitialised\fP ()"
.br
.RI "Checks if the result is initilised (Experimental) "
.ti -1c
.RI "bool \fBToBool\fP ()"
.br
.RI "Converts the result to boolean (Experimental) "
.ti -1c
.RI "Color \fBToColor\fP ()"
.br
.RI "Converts the result to color (Experimental) "
.ti -1c
.RI "double \fBToDouble\fP ()"
.br
.RI "Converts the result to double (Experimental) "
.ti -1c
.RI "int \fBToInt\fP ()"
.br
.RI "Converts the result to integer (Experimental) "
.in -1c
.SH "Detailed Description"
.PP
The method chunk class
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\&.MethodChunk (\fBValueStorage\fP valueStorage, \fBDeclareVariable\fP[] variables)"
.PP
The method chunk
.PP
\fBParameters\fP
.RS 4
\fIvalueStorage\fP The ValueStorage for increasing and decreasing the stack
.br
\fIvariables\fP The variables to pass into the method
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "\fBIValue\fP Advanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\&.Clone ()"
.PP
Clones the result of the method (Experimental)
.PP
\fBReturns\fP
.RS 4
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "\fBMethodChunk\fP Advanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\&.DuplicateForExecution ()"
.PP
This method allows the method chunk to replicate itself before being ran\&. Essential for recursion\&.
.PP
\fBReturns\fP
.RS 4
A method chunk with the exact same values and verbs
.RE
.PP
.SS "new void Advanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\&.ExecuteVerb ()"
.PP
Executes the method chunk\&.
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\&.GetOriginalType ()"
.PP
Gets the original type of the result of the method (Experimental)
.PP
\fBReturns\fP
.RS 4
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "\fBIValue\fP Advanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\&.GetResult ()"
.PP
Gets a result from the method\&. (Experimental)
.PP
\fBReturns\fP
.RS 4
the result
.RE
.PP
.SS "List<string> Advanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\&.GetVariableNames ()"
.PP
Gets all of the variable names
.PP
\fBReturns\fP
.RS 4
The names of all the variables
.RE
.PP
.SS "bool Advanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\&.IsInitialised ()"
.PP
Checks if the result is initilised (Experimental)
.PP
\fBReturns\fP
.RS 4
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "void Advanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\&.SetVariableValues (\fBUpdateVariable\fP[] updateVariables)"
.PP
MUST BE CALLED\&. This method is really important for setting the updated values into the method's stack\&.
.PP
\fBParameters\fP
.RS 4
\fIupdateVariables\fP The new values of the method
.RE
.PP
.SS "bool Advanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\&.ToBool ()"
.PP
Converts the result to boolean (Experimental)
.PP
\fBReturns\fP
.RS 4
boolean representation of the result
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "Color Advanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\&.ToColor ()"
.PP
Converts the result to color (Experimental)
.PP
\fBReturns\fP
.RS 4
color representation of the result
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "double Advanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\&.ToDouble ()"
.PP
Converts the result to double (Experimental)
.PP
\fBReturns\fP
.RS 4
double representation of the result
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "int Advanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\&.ToInt ()"
.PP
Converts the result to integer (Experimental)
.PP
\fBReturns\fP
.RS 4
integer representation of the result
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,112 @@
.TH "Advanced_Software_Engineering.Verbs.Flow.VerbChunk" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Flow.VerbChunk \- A simple \fBVerbChunk\fP\&. Used for storing and executing a bunch of verbs
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\fP, and \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.PP
Inherited by \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.ForChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IfChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\fP, and \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.WhileChunk\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBVerbChunk\fP (List< \fBIVerb\fP > verbs)"
.br
.RI "Create a new \fBVerbChunk\fP with verbs in it\&. "
.ti -1c
.RI "\fBVerbChunk\fP ()"
.br
.RI "Create an empty \fBVerbChunk\fP "
.ti -1c
.RI "void \fBAddVerb\fP (\fBIVerb\fP verb)"
.br
.RI "Adds a verb to the verb list "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "Executes all of the verbs in order "
.ti -1c
.RI "\fBIVerb\fP[] \fBGetVerbs\fP ()"
.br
.RI "Returns all of the verbs stored "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Gets a description of every verb "
.in -1c
.SH "Detailed Description"
.PP
A simple \fBVerbChunk\fP\&. Used for storing and executing a bunch of verbs
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.Flow\&.VerbChunk\&.VerbChunk (List< \fBIVerb\fP > verbs)"
.PP
Create a new \fBVerbChunk\fP with verbs in it\&.
.PP
\fBParameters\fP
.RS 4
\fIverbs\fP \fBVerbs\fP to be added to the verb chunk
.RE
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.Flow\&.VerbChunk\&.VerbChunk ()"
.PP
Create an empty \fBVerbChunk\fP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.Flow\&.VerbChunk\&.AddVerb (\fBIVerb\fP verb)"
.PP
Adds a verb to the verb list
.PP
\fBParameters\fP
.RS 4
\fIverb\fP
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\fP\&.
.SS "void Advanced_Software_Engineering\&.Verbs\&.Flow\&.VerbChunk\&.ExecuteVerb ()"
.PP
Executes all of the verbs in order
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.Flow\&.VerbChunk\&.GetDescription ()"
.PP
Gets a description of every verb
.PP
\fBReturns\fP
.RS 4
The descriptions of every verb
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\fP\&.
.SS "\fBIVerb\fP [] Advanced_Software_Engineering\&.Verbs\&.Flow\&.VerbChunk\&.GetVerbs ()"
.PP
Returns all of the verbs stored
.PP
\fBReturns\fP
.RS 4
the verbs stored
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,74 @@
.TH "Advanced_Software_Engineering.Verbs.Flow.WhileChunk" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Flow.WhileChunk \- A Chunk that loops over its code
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.VerbChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\fP, and \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBWhileChunk\fP (\fBValueStorage\fP valueStorage, \fBIValue\fP conditional)"
.br
.RI "A For Loop object "
.ti -1c
.RI "\fBWhileChunk\fP (\fBValueStorage\fP valueStorage, \fBIValue\fP conditional, \fBIVerb\fP oneLineVerb)"
.br
.RI "Create a new if object "
.ti -1c
.RI "new void \fBExecuteVerb\fP ()"
.br
.RI "Executes every verb in the chunk "
.in -1c
.SH "Detailed Description"
.PP
A Chunk that loops over its code
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.Flow\&.WhileChunk\&.WhileChunk (\fBValueStorage\fP valueStorage, \fBIValue\fP conditional)"
.PP
A For Loop object
.PP
\fBParameters\fP
.RS 4
\fIvalueStorage\fP The ValueStorage for increasing and decreasing the stack
.br
\fIconditional\fP Preferably Value\&.ValueTypes\&.BoolValue, weather the loop should continue to execute\&.
.RE
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.Flow\&.WhileChunk\&.WhileChunk (\fBValueStorage\fP valueStorage, \fBIValue\fP conditional, \fBIVerb\fP oneLineVerb)"
.PP
Create a new if object
.PP
\fBParameters\fP
.RS 4
\fIvalueStorage\fP The ValueStorage for increasing and decreasing the stack
.br
\fIconditional\fP Preferably Value\&.ValueTypes\&.BoolValue, weather the loop should continue to execute\&.
.br
\fIoneLineVerb\fP A verb to execute in a single line\&. (Probably a bad idea)
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "new void Advanced_Software_Engineering\&.Verbs\&.Flow\&.WhileChunk\&.ExecuteVerb ()"
.PP
Executes every verb in the chunk
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.IVerbChunk\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,46 @@
.TH "Advanced_Software_Engineering.Verbs.Value" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Value
.SH SYNOPSIS
.br
.PP
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBDeclareVariable\fP"
.br
.RI "Declares a variable "
.ti -1c
.RI "class \fBExpressionValue\fP"
.br
.RI "Expression values are used when there are two IValues that need to be added or subtracted or anything from each other\&. "
.ti -1c
.RI "interface \fBIValue\fP"
.br
.RI "A value "
.ti -1c
.RI "class \fBUpdateVariable\fP"
.br
.RI "Used for updating the variables "
.ti -1c
.RI "class \fBValueContainer\fP"
.br
.ti -1c
.RI "class \fBValueFactory\fP"
.br
.RI "\fBValue\fP factory creates values "
.ti -1c
.RI "class \fBValueHelper\fP"
.br
.RI "This class contains a large amount of useful conversions "
.ti -1c
.RI "class \fBValueStorage\fP"
.br
.RI "The storage for all the values "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,87 @@
.TH "Advanced_Software_Engineering.Verbs.Value.DeclareVariable" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Value.DeclareVariable \- Declares a variable
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBDeclareVariable\fP (\fBValueStorage\fP storage, string assignment)"
.br
.RI "Creates a new Declare variable "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "Sets the variable to null "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Gets the description of the verb "
.ti -1c
.RI "string \fBGetName\fP ()"
.br
.RI "Gets the name of the variable to assign "
.in -1c
.SH "Detailed Description"
.PP
Declares a variable
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.Value\&.DeclareVariable\&.DeclareVariable (\fBValueStorage\fP storage, string assignment)"
.PP
Creates a new Declare variable
.PP
\fBParameters\fP
.RS 4
\fIstorage\fP The storage to use
.br
\fIassignment\fP The assignment
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.Value\&.DeclareVariable\&.ExecuteVerb ()"
.PP
Sets the variable to null
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.Value\&.DeclareVariable\&.GetDescription ()"
.PP
Gets the description of the verb
.PP
\fBReturns\fP
.RS 4
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.Value\&.DeclareVariable\&.GetName ()"
.PP
Gets the name of the variable to assign
.PP
\fBReturns\fP
.RS 4
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,240 @@
.TH "Advanced_Software_Engineering.Verbs.Value.ExpressionValue" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Value.ExpressionValue \- Expression values are used when there are two IValues that need to be added or subtracted or anything from each other\&.
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBExpressionValue\fP (\fBIValue\fP variable1, \fBIValue\fP variable2, int operation)"
.br
.RI "Create a new Expression \fBValue\fP based on the two IValues "
.ti -1c
.RI "\fBExpressionValue\fP (\fBIValue\fP variable1, \fBIValue\fP variable2, string operation)"
.br
.RI "Create a new Expression \fBValue\fP based on the two IValues "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Describes the expression "
.ti -1c
.RI "string \fBGetOriginalType\fP ()"
.br
.RI "Get the type of the expression "
.ti -1c
.RI "bool \fBIsInitialised\fP ()"
.br
.RI "Expressions are always initialised "
.ti -1c
.RI "bool \fBToBool\fP ()"
.br
.RI "Gets the bool of the result "
.ti -1c
.RI "Color \fBToColor\fP ()"
.br
.RI "Gets the color of the result "
.ti -1c
.RI "double \fBToDouble\fP ()"
.br
.RI "Gets the double value of the result "
.ti -1c
.RI "int \fBToInt\fP ()"
.br
.RI "Gets the int of the result "
.ti -1c
.RI "\fBIValue\fP \fBClone\fP ()"
.br
.RI "Clones the value of the result "
.in -1c
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "const int \fBADD\fP = 0"
.br
.RI "An operation denoting addition "
.ti -1c
.RI "const int \fBSUBTRACT\fP = 1"
.br
.RI "An operation denoting subtraction "
.ti -1c
.RI "const int \fBMULTIPLY\fP = 2"
.br
.RI "An operation denoting multiplication "
.ti -1c
.RI "const int \fBDIVIDE\fP = 3"
.br
.RI "An operation denoting division "
.in -1c
.SH "Detailed Description"
.PP
Expression values are used when there are two IValues that need to be added or subtracted or anything from each other\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\&.ExpressionValue (\fBIValue\fP variable1, \fBIValue\fP variable2, int operation)"
.PP
Create a new Expression \fBValue\fP based on the two IValues
.PP
\fBParameters\fP
.RS 4
\fIvariable1\fP \fBIValue\fP to perform the operation on
.br
\fIvariable2\fP \fBIValue\fP to perform the operation on
.br
\fIoperation\fP The operation\&. Can be \fBADD\fP, \fBSUBTRACT\fP, \fBMULTIPLY\fP or \fBDIVIDE\fP\&.
.RE
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\&.ExpressionValue (\fBIValue\fP variable1, \fBIValue\fP variable2, string operation)"
.PP
Create a new Expression \fBValue\fP based on the two IValues
.PP
\fBParameters\fP
.RS 4
\fIvariable1\fP \fBIValue\fP to perform the operation on
.br
\fIvariable2\fP \fBIValue\fP to perform the operation on
.br
\fIoperation\fP The operation\&. Can be '+'(\fBADD\fP), '-'(\fBSUBTRACT\fP), '*'(\fBMULTIPLY\fP) or '/'(\fBDIVIDE\fP)\&.
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "\fBIValue\fP Advanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\&.Clone ()"
.PP
Clones the value of the result
.PP
\fBReturns\fP
.RS 4
A new \fBIValue\fP
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\&.GetDescription ()"
.PP
Describes the expression
.PP
\fBReturns\fP
.RS 4
A string description of the expression
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\&.GetOriginalType ()"
.PP
Get the type of the expression
.PP
\fBReturns\fP
.RS 4
'expression'
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "bool Advanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\&.IsInitialised ()"
.PP
Expressions are always initialised
.PP
\fBReturns\fP
.RS 4
true
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "bool Advanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\&.ToBool ()"
.PP
Gets the bool of the result
.PP
\fBReturns\fP
.RS 4
bool value of the result
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "Color Advanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\&.ToColor ()"
.PP
Gets the color of the result
.PP
\fBReturns\fP
.RS 4
color value of the result
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "double Advanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\&.ToDouble ()"
.PP
Gets the double value of the result
.PP
\fBReturns\fP
.RS 4
double value of the result
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "int Advanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\&.ToInt ()"
.PP
Gets the int of the result
.PP
\fBReturns\fP
.RS 4
int value of the result
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SH "Member Data Documentation"
.PP
.SS "const int Advanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\&.ADD = 0\fC [static]\fP"
.PP
An operation denoting addition
.SS "const int Advanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\&.DIVIDE = 3\fC [static]\fP"
.PP
An operation denoting division
.SS "const int Advanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\&.MULTIPLY = 2\fC [static]\fP"
.PP
An operation denoting multiplication
.SS "const int Advanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\&.SUBTRACT = 1\fC [static]\fP"
.PP
An operation denoting subtraction
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,162 @@
.TH "Advanced_Software_Engineering.Verbs.Value.IValue" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Value.IValue \- A value
.SH SYNOPSIS
.br
.PP
.PP
Inherited by \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\fP, Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueObjects\&.ColorValue, Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.BoolValue, Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.ComparisonValue, Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.DoubleValue, Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.IntValue, and \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.VariableValue\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "The description of the value "
.ti -1c
.RI "int \fBToInt\fP ()"
.br
.RI "Converts the value to an integer "
.ti -1c
.RI "double \fBToDouble\fP ()"
.br
.RI "Get the double representation if the \fBIValue\fP "
.ti -1c
.RI "bool \fBToBool\fP ()"
.br
.RI "Get the boolean representation if the \fBIValue\fP "
.ti -1c
.RI "Color \fBToColor\fP ()"
.br
.RI "Get the color representation if the \fBIValue\fP "
.ti -1c
.RI "string \fBGetOriginalType\fP ()"
.br
.RI "Gets the original type of the \fBIValue\fP "
.ti -1c
.RI "bool \fBIsInitialised\fP ()"
.br
.RI "Checks if the \fBIValue\fP is initialised "
.ti -1c
.RI "\fBIValue\fP \fBClone\fP ()"
.br
.RI "Clones the \fBIValue\fP "
.in -1c
.SH "Detailed Description"
.PP
A value
.SH "Member Function Documentation"
.PP
.SS "\fBIValue\fP Advanced_Software_Engineering\&.Verbs\&.Value\&.IValue\&.Clone ()"
.PP
Clones the \fBIValue\fP
.PP
\fBReturns\fP
.RS 4
.RE
.PP
.PP
Implemented in \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.VariableValue\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\fP, and \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.Value\&.IValue\&.GetDescription ()"
.PP
The description of the value
.PP
\fBReturns\fP
.RS 4
The description of the \fBIValue\fP
.RE
.PP
.PP
Implemented in \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.VariableValue\fP, and \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.Value\&.IValue\&.GetOriginalType ()"
.PP
Gets the original type of the \fBIValue\fP
.PP
\fBReturns\fP
.RS 4
original type of the \fBIValue\fP
.RE
.PP
.PP
Implemented in \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.VariableValue\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\fP, and \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\fP\&.
.SS "bool Advanced_Software_Engineering\&.Verbs\&.Value\&.IValue\&.IsInitialised ()"
.PP
Checks if the \fBIValue\fP is initialised
.PP
\fBReturns\fP
.RS 4
True if \fBIValue\fP is initialised
.RE
.PP
.PP
Implemented in \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.VariableValue\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\fP, and \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\fP\&.
.SS "bool Advanced_Software_Engineering\&.Verbs\&.Value\&.IValue\&.ToBool ()"
.PP
Get the boolean representation if the \fBIValue\fP
.PP
\fBReturns\fP
.RS 4
the boolean representation if the \fBIValue\fP
.RE
.PP
.PP
Implemented in \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.VariableValue\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\fP, and \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\fP\&.
.SS "Color Advanced_Software_Engineering\&.Verbs\&.Value\&.IValue\&.ToColor ()"
.PP
Get the color representation if the \fBIValue\fP
.PP
\fBReturns\fP
.RS 4
the color representation if the \fBIValue\fP
.RE
.PP
.PP
Implemented in \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.VariableValue\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\fP, and \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\fP\&.
.SS "double Advanced_Software_Engineering\&.Verbs\&.Value\&.IValue\&.ToDouble ()"
.PP
Get the double representation if the \fBIValue\fP
.PP
\fBReturns\fP
.RS 4
the double representation if the \fBIValue\fP
.RE
.PP
.PP
Implemented in \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.VariableValue\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\fP, and \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\fP\&.
.SS "int Advanced_Software_Engineering\&.Verbs\&.Value\&.IValue\&.ToInt ()"
.PP
Converts the value to an integer
.PP
\fBReturns\fP
.RS 4
the integer representation if the \fBIValue\fP
.RE
.PP
.PP
Implemented in \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.VariableValue\fP, \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.ExpressionValue\fP, and \fBAdvanced_Software_Engineering\&.Verbs\&.Flow\&.MethodChunk\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,93 @@
.TH "Advanced_Software_Engineering.Verbs.Value.UpdateVariable" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Value.UpdateVariable \- Used for updating the variables
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBUpdateVariable\fP (\fBValueStorage\fP storage, string name, \fBIValue\fP value)"
.br
.RI "Create a new \fBUpdateVariable\fP object "
.ti -1c
.RI "\fBUpdateVariable\fP (\fBValueStorage\fP storage, string name, string value)"
.br
.RI "Create a new \fBUpdateVariable\fP object "
.ti -1c
.RI "void \fBExecuteVerb\fP ()"
.br
.RI "Executes the verb and updates the variable "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Gets the description of the update "
.in -1c
.SH "Detailed Description"
.PP
Used for updating the variables
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.Value\&.UpdateVariable\&.UpdateVariable (\fBValueStorage\fP storage, string name, \fBIValue\fP value)"
.PP
Create a new \fBUpdateVariable\fP object
.PP
\fBParameters\fP
.RS 4
\fIstorage\fP The storage object
.br
\fIname\fP The name of the variable
.br
\fIvalue\fP The value of the variable
.RE
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.Value\&.UpdateVariable\&.UpdateVariable (\fBValueStorage\fP storage, string name, string value)"
.PP
Create a new \fBUpdateVariable\fP object
.PP
\fBParameters\fP
.RS 4
\fIstorage\fP The storage object
.br
\fIname\fP The name of the variable
.br
\fIvalue\fP The expression of the value
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.Value\&.UpdateVariable\&.ExecuteVerb ()"
.PP
Executes the verb and updates the variable
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.Value\&.UpdateVariable\&.GetDescription ()"
.PP
Gets the description of the update
.PP
\fBReturns\fP
.RS 4
A string representation of the description of the update
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.IVerb\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,25 @@
.TH "Advanced_Software_Engineering.Verbs.Value.ValueContainer" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Value.ValueContainer
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "void \fBSetVariable\fP (string variableName, \fBIValue\fP iValue)"
.br
.ti -1c
.RI "void \fBDeclareVariable\fP (string variableName, \fBIValue\fP iValue)"
.br
.ti -1c
.RI "void \fBDeclareAndSetVariable\fP (string variableName, \fBIValue\fP iValue)"
.br
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,186 @@
.TH "Advanced_Software_Engineering.Verbs.Value.ValueFactory" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Value.ValueFactory \- \fBValue\fP factory creates values
.SH SYNOPSIS
.br
.PP
.SS "Static Public Member Functions"
.in +1c
.ti -1c
.RI "static \fBIValue\fP \fBCreateValue\fP (string value, string type)"
.br
.RI "Creates a constant \fBValue\fP to be used later during execution "
.ti -1c
.RI "static \fBIValue\fP \fBCreateValue\fP (\fBValueStorage\fP storage, string paramater1, string paramater2, string parameter3, string parameter4, string type)"
.br
.RI "Creates a constant \fBValue\fP to be used later during execution\&. Only used for Color "
.ti -1c
.RI "static \fBIValue\fP \fBCreateValue\fP (\fBValueStorage\fP storage, string paramater1, string paramater2, string parameter3, string type)"
.br
.RI "Creates a constant \fBValue\fP to be used later during execution\&. Only used for Color "
.ti -1c
.RI "static \fBIValue\fP \fBCreateValue\fP (\fBValueStorage\fP storage, string value)"
.br
.RI "Creates a constant \fBValue\fP to be used later during execution "
.ti -1c
.RI "static \fBIValue\fP \fBCreateValue\fP (bool b)"
.br
.RI "Create a new boolean \fBIValue\fP "
.ti -1c
.RI "static \fBIValue\fP \fBCreateValue\fP (double d)"
.br
.RI "Create a new double \fBIValue\fP "
.ti -1c
.RI "static \fBIValue\fP \fBCreateValue\fP (int i)"
.br
.RI "Create a new int \fBIValue\fP "
.in -1c
.SH "Detailed Description"
.PP
\fBValue\fP factory creates values
.SH "Member Function Documentation"
.PP
.SS "static \fBIValue\fP Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueFactory\&.CreateValue (bool b)\fC [static]\fP"
.PP
Create a new boolean \fBIValue\fP
.PP
\fBParameters\fP
.RS 4
\fIb\fP boolean input
.RE
.PP
\fBReturns\fP
.RS 4
BoolValue
.RE
.PP
.SS "static \fBIValue\fP Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueFactory\&.CreateValue (double d)\fC [static]\fP"
.PP
Create a new double \fBIValue\fP
.PP
\fBParameters\fP
.RS 4
\fId\fP double input
.RE
.PP
\fBReturns\fP
.RS 4
DoubleValue
.RE
.PP
.SS "static \fBIValue\fP Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueFactory\&.CreateValue (int i)\fC [static]\fP"
.PP
Create a new int \fBIValue\fP
.PP
\fBParameters\fP
.RS 4
\fIi\fP int input
.RE
.PP
\fBReturns\fP
.RS 4
IntValue
.RE
.PP
.SS "static \fBIValue\fP Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueFactory\&.CreateValue (string value, string type)\fC [static]\fP"
.PP
Creates a constant \fBValue\fP to be used later during execution
.PP
\fBParameters\fP
.RS 4
\fIvalue\fP Text representation of the value
.br
\fItype\fP What type the value should be
.RE
.PP
\fBReturns\fP
.RS 4
a new \fBIValue\fP
.RE
.PP
.SS "static \fBIValue\fP Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueFactory\&.CreateValue (\fBValueStorage\fP storage, string paramater1, string paramater2, string parameter3, string parameter4, string type)\fC [static]\fP"
.PP
Creates a constant \fBValue\fP to be used later during execution\&. Only used for Color
.PP
\fBParameters\fP
.RS 4
\fIstorage\fP The storage
.br
\fIparamater1\fP First parameter
.br
\fIparamater2\fP Second parameter
.br
\fIparameter3\fP Third parameter
.br
\fIparameter4\fP Fourth parameter
.br
\fItype\fP the type
.RE
.PP
\fBReturns\fP
.RS 4
a new \fBIValue\fP
.RE
.PP
.SS "static \fBIValue\fP Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueFactory\&.CreateValue (\fBValueStorage\fP storage, string paramater1, string paramater2, string parameter3, string type)\fC [static]\fP"
.PP
Creates a constant \fBValue\fP to be used later during execution\&. Only used for Color
.PP
\fBParameters\fP
.RS 4
\fIstorage\fP The storage
.br
\fIparamater1\fP First parameter
.br
\fIparamater2\fP Second parameter
.br
\fIparameter3\fP Third parameter
.br
\fItype\fP the type
.RE
.PP
\fBReturns\fP
.RS 4
a new \fBIValue\fP
.RE
.PP
.SS "static \fBIValue\fP Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueFactory\&.CreateValue (\fBValueStorage\fP storage, string value)\fC [static]\fP"
.PP
Creates a constant \fBValue\fP to be used later during execution
.PP
\fBParameters\fP
.RS 4
\fIvalue\fP Text representation of the value
.br
\fIstorage\fP The value storage to check
.RE
.PP
\fBReturns\fP
.RS 4
a new \fBIValue\fP
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,209 @@
.TH "Advanced_Software_Engineering.Verbs.Value.ValueHelper" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Value.ValueHelper \- This class contains a large amount of useful conversions
.SH SYNOPSIS
.br
.PP
.SS "Static Public Member Functions"
.in +1c
.ti -1c
.RI "static int \fBConvertToInt\fP (string text)"
.br
.RI "Converts string to int (if possible) "
.ti -1c
.RI "static double \fBConvertToDouble\fP (string text)"
.br
.RI "Converts string to double (if possible) "
.ti -1c
.RI "static Point \fBConvertToPoint\fP (string text1, string text2)"
.br
.RI "Converts two strings to a point object\&. "
.ti -1c
.RI "static Color \fBTextToColor\fP (string text)"
.br
.RI "This function convers text to Color\&. "
.ti -1c
.RI "static Color \fBIntsToColor\fP (int r, int g, int b, int a=255)"
.br
.RI "Generate a color from RGB(A) int values "
.ti -1c
.RI "static bool \fBConvertToBool\fP (string text)"
.br
.RI "Convert to boolean "
.ti -1c
.RI "static \fBIValue\fP \fBConvertToIValue\fP (string text, \fBValueStorage\fP storage=null)"
.br
.RI "Converts the text to \fBIValue\fP "
.in -1c
.SH "Detailed Description"
.PP
This class contains a large amount of useful conversions
.SH "Member Function Documentation"
.PP
.SS "static bool Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueHelper\&.ConvertToBool (string text)\fC [static]\fP"
.PP
Convert to boolean
.PP
\fBParameters\fP
.RS 4
\fItext\fP A text boolean
.RE
.PP
\fBReturns\fP
.RS 4
boolean representation of the text
.RE
.PP
.SS "static double Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueHelper\&.ConvertToDouble (string text)\fC [static]\fP"
.PP
Converts string to double (if possible)
.PP
\fBParameters\fP
.RS 4
\fItext\fP String to be converted to double
.RE
.PP
\fBReturns\fP
.RS 4
Double representation of string
.RE
.PP
.SS "static int Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueHelper\&.ConvertToInt (string text)\fC [static]\fP"
.PP
Converts string to int (if possible)
.PP
\fBParameters\fP
.RS 4
\fItext\fP String to be converted to int
.RE
.PP
\fBReturns\fP
.RS 4
Integer representation of string
.RE
.PP
.SS "static \fBIValue\fP Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueHelper\&.ConvertToIValue (string text, \fBValueStorage\fP storage = \fCnull\fP)\fC [static]\fP"
.PP
Converts the text to \fBIValue\fP
.PP
\fBParameters\fP
.RS 4
\fItext\fP text to convert
.br
\fIstorage\fP storage to use (can be null) (optional)
.RE
.PP
\fBReturns\fP
.RS 4
An \fBIValue\fP representation of the text
.RE
.PP
.SS "static Point Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueHelper\&.ConvertToPoint (string text1, string text2)\fC [static]\fP"
.PP
Converts two strings to a point object\&.
.PP
\fBParameters\fP
.RS 4
\fItext1\fP X parameter
.br
\fItext2\fP Y parameter
.RE
.PP
\fBReturns\fP
.RS 4
A Point object
.RE
.PP
<todo>Make unit tests for this function</todo>
.SS "static Color Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueHelper\&.IntsToColor (int r, int g, int b, int a = \fC255\fP)\fC [static]\fP"
.PP
Generate a color from RGB(A) int values
.PP
\fBParameters\fP
.RS 4
\fIr\fP Red
.br
\fIg\fP Green
.br
\fIb\fP Blue
.br
\fIa\fP Optional: Alpha/Transparancy (default is 255, 0 is transparent)
.RE
.PP
\fBReturns\fP
.RS 4
.RE
.PP
.SS "static Color Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueHelper\&.TextToColor (string text)\fC [static]\fP"
.PP
This function convers text to Color\&. It can parse several different types of strings\&. Types of string accepted:
.IP "\(bu" 2
A string that is the name of a predefined color\&. See Color class for full list\&.
.IP "\(bu" 2
A string that represents a Hex Triplet (
.PP
.nf
#rrggbb
.fi
.PP
)\&. See \&.
.IP "\(bu" 2
A string that represents a Hex Quadruplet (
.PP
.nf
#rrggbbaa
.fi
.PP
, where
.PP
.nf
aa
.fi
.PP
represents alpha)\&.
.PP
.PP
Color tmp = TextToColor('red'); Console\&.WriteLine('Name: ' + tmp\&.toString()) //=> 'red'
.PP
tmp = TextToColor('deadbe'); Console\&.WriteLine('Name: ' + tmp\&.toString()) //=> '00deadbe'
.PP
//It's important to remember that C# doesn't work like HTML colors, putting alpha first, rather than last\&.
.PP
tmp = TextToColor('deadbeef'); Console\&.WriteLine('Name: ' + tmp\&.toString()) //=> 'efdeadbe'
.PP
\fBParameters\fP
.RS 4
\fItext\fP a string with a valid name or format
.RE
.PP
\fBReturns\fP
.RS 4
color of the string
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,22 @@
.TH "Advanced_Software_Engineering.Verbs.Value.ValueObjects" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Value.ValueObjects
.SH SYNOPSIS
.br
.PP
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBColorValue\fP"
.br
.ti -1c
.RI "class \fBPointValue\fP"
.br
.RI "A point \fBIValue\fP\&. Simply the same as Point but with IValues intstead of ints\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,88 @@
.TH "Advanced_Software_Engineering.Verbs.Value.ValueObjects.PointValue" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Value.ValueObjects.PointValue \- A point \fBIValue\fP\&. Simply the same as Point but with IValues intstead of ints\&.
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBPointValue\fP (\fBIValue\fP x, \fBIValue\fP y)"
.br
.RI "Create a new \fBPointValue\fP "
.ti -1c
.RI "int \fBGetX\fP ()"
.br
.RI "Get the X component "
.ti -1c
.RI "int \fBGetY\fP ()"
.br
.RI "Get the Y component "
.ti -1c
.RI "Point \fBGetPoint\fP ()"
.br
.RI "Get the Point\&. "
.in -1c
.SH "Detailed Description"
.PP
A point \fBIValue\fP\&. Simply the same as Point but with IValues intstead of ints\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueObjects\&.PointValue\&.PointValue (\fBIValue\fP x, \fBIValue\fP y)"
.PP
Create a new \fBPointValue\fP
.PP
\fBParameters\fP
.RS 4
\fIx\fP X \fBIValue\fP
.br
\fIy\fP Y \fBIValue\fP
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "Point Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueObjects\&.PointValue\&.GetPoint ()"
.PP
Get the Point\&.
.PP
\fBReturns\fP
.RS 4
Point
.RE
.PP
.SS "int Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueObjects\&.PointValue\&.GetX ()"
.PP
Get the X component
.PP
\fBReturns\fP
.RS 4
the X component
.RE
.PP
.SS "int Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueObjects\&.PointValue\&.GetY ()"
.PP
Get the Y component
.PP
\fBReturns\fP
.RS 4
the Y component
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,115 @@
.TH "Advanced_Software_Engineering.Verbs.Value.ValueStorage" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Value.ValueStorage \- The storage for all the values
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBValueStorage\fP ()"
.br
.RI "Create a new \fBValueStorage\fP "
.ti -1c
.RI "void \fBReset\fP ()"
.br
.RI "Reset the \fBValueStorage\fP "
.ti -1c
.RI "void \fBIncreaseStack\fP ()"
.br
.RI "Increase the stack "
.ti -1c
.RI "void \fBDecreaseStack\fP ()"
.br
.RI "Decrease the stack "
.ti -1c
.RI "void \fBSetVariable\fP (string name, \fBIValue\fP value)"
.br
.RI "Set a variable "
.ti -1c
.RI "\fBIValue\fP \fBGetVariable\fP (string name)"
.br
.RI "Gets the variable at the first available stack "
.ti -1c
.RI "bool \fBCheckVariableExists\fP (string name)"
.br
.RI "Check if the variable exists in the first available stack "
.in -1c
.SH "Detailed Description"
.PP
The storage for all the values
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueStorage\&.ValueStorage ()"
.PP
Create a new \fBValueStorage\fP
.SH "Member Function Documentation"
.PP
.SS "bool Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueStorage\&.CheckVariableExists (string name)"
.PP
Check if the variable exists in the first available stack
.PP
\fBParameters\fP
.RS 4
\fIname\fP variable name
.RE
.PP
\fBReturns\fP
.RS 4
\fBIValue\fP
.RE
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueStorage\&.DecreaseStack ()"
.PP
Decrease the stack
.SS "\fBIValue\fP Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueStorage\&.GetVariable (string name)"
.PP
Gets the variable at the first available stack
.PP
\fBParameters\fP
.RS 4
\fIname\fP the names of the variable
.RE
.PP
\fBReturns\fP
.RS 4
\fBIValue\fP
.RE
.PP
.SS "void Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueStorage\&.IncreaseStack ()"
.PP
Increase the stack
.SS "void Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueStorage\&.Reset ()"
.PP
Reset the \fBValueStorage\fP
.SS "void Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueStorage\&.SetVariable (string name, \fBIValue\fP value)"
.PP
Set a variable
.PP
\fBParameters\fP
.RS 4
\fIname\fP Variable name
.br
\fIvalue\fP the \fBIValue\fP
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,31 @@
.TH "Advanced_Software_Engineering.Verbs.Value.ValueTypes" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Value.ValueTypes
.SH SYNOPSIS
.br
.PP
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBBoolValue\fP"
.br
.ti -1c
.RI "class \fBComparisonValue\fP"
.br
.ti -1c
.RI "class \fBDoubleValue\fP"
.br
.ti -1c
.RI "class \fBIntValue\fP"
.br
.ti -1c
.RI "class \fBVariableValue\fP"
.br
.RI "Variable value is responsible for setting up values for \fBUpdateVariable\fP to then update "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.
@@ -0,0 +1,181 @@
.TH "Advanced_Software_Engineering.Verbs.Value.ValueTypes.VariableValue" 3 "Sat Dec 12 2020" "Advanced Software Engineering" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Advanced_Software_Engineering.Verbs.Value.ValueTypes.VariableValue \- Variable value is responsible for setting up values for \fBUpdateVariable\fP to then update
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBVariableValue\fP (\fBValueStorage\fP storage, string variableName)"
.br
.RI "The new \fBVariableValue\fP "
.ti -1c
.RI "string \fBGetDescription\fP ()"
.br
.RI "Gets the description of the \fBIValue\fP "
.ti -1c
.RI "string \fBGetOriginalType\fP ()"
.br
.RI "Gets the original type of the \fBIValue\fP "
.ti -1c
.RI "bool \fBIsInitialised\fP ()"
.br
.RI "Get the initialised state of the \fBIValue\fP "
.ti -1c
.RI "bool \fBToBool\fP ()"
.br
.RI "Converts the \fBIValue\fP to a boolean "
.ti -1c
.RI "Color \fBToColor\fP ()"
.br
.RI "Converts the \fBIValue\fP to a color "
.ti -1c
.RI "double \fBToDouble\fP ()"
.br
.RI "Converts the \fBIValue\fP to a double "
.ti -1c
.RI "int \fBToInt\fP ()"
.br
.RI "Converts the \fBIValue\fP to an integer "
.ti -1c
.RI "\fBIValue\fP \fBClone\fP ()"
.br
.RI "Clone the value and return it "
.in -1c
.SH "Detailed Description"
.PP
Variable value is responsible for setting up values for \fBUpdateVariable\fP to then update
.SH "Constructor & Destructor Documentation"
.PP
.SS "Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.VariableValue\&.VariableValue (\fBValueStorage\fP storage, string variableName)"
.PP
The new \fBVariableValue\fP
.PP
\fBParameters\fP
.RS 4
\fIstorage\fP the storage to use
.br
\fIvariableName\fP variable name
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "\fBIValue\fP Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.VariableValue\&.Clone ()"
.PP
Clone the value and return it
.PP
\fBReturns\fP
.RS 4
Cloned \fBIValue\fP
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.VariableValue\&.GetDescription ()"
.PP
Gets the description of the \fBIValue\fP
.PP
\fBReturns\fP
.RS 4
description of the \fBIValue\fP
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "string Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.VariableValue\&.GetOriginalType ()"
.PP
Gets the original type of the \fBIValue\fP
.PP
\fBReturns\fP
.RS 4
original type of the \fBIValue\fP
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "bool Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.VariableValue\&.IsInitialised ()"
.PP
Get the initialised state of the \fBIValue\fP
.PP
\fBReturns\fP
.RS 4
initialised state of the \fBIValue\fP
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "bool Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.VariableValue\&.ToBool ()"
.PP
Converts the \fBIValue\fP to a boolean
.PP
\fBReturns\fP
.RS 4
Boolean value of the \fBIValue\fP
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "Color Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.VariableValue\&.ToColor ()"
.PP
Converts the \fBIValue\fP to a color
.PP
\fBReturns\fP
.RS 4
Color value of the \fBIValue\fP
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "double Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.VariableValue\&.ToDouble ()"
.PP
Converts the \fBIValue\fP to a double
.PP
\fBReturns\fP
.RS 4
Double value of the \fBIValue\fP
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SS "int Advanced_Software_Engineering\&.Verbs\&.Value\&.ValueTypes\&.VariableValue\&.ToInt ()"
.PP
Converts the \fBIValue\fP to an integer
.PP
\fBReturns\fP
.RS 4
Int value of the \fBIValue\fP
.RE
.PP
.PP
Implements \fBAdvanced_Software_Engineering\&.Verbs\&.Value\&.IValue\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Advanced Software Engineering from the source code\&.