Skip to content
This repository was archived by the owner on Sep 29, 2023. It is now read-only.

Commit 8c87c40

Browse files
tjohnston-softdevtjohnston-softdev
committed
Result Control Split
Split output result control code into different files for easier readability.
1 parent 1eef0ba commit 8c87c40

20 files changed

+426
-316
lines changed

‎changelog.md‎

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,30 @@
11
# Changelog
22

3-
**./info/commands/**
4-
* Created new files for Relative conversion commands:
5-
* absolute-to-relative.md
6-
* grid-to-relative.md
7-
* image-to-relative.md
8-
* Added links to new command files inside readme.md
3+
**./src/output/result-control.js**
4+
* Split into different files, containing the respective functions:
5+
* res-ctrl-txt-graph.js
6+
* callTextGraphOutputTasks - Renamed to 'callOutputTasks'
7+
* handleTextFileClean
8+
* res-ctrl-img-graph.js
9+
* callImageGraphOutputTasks - Renamed to 'callOutputTasks'
10+
* handleImageFileClean
11+
* res-ctrl-txt-conv.js
12+
* callGridToAbsoluteOutputTask
13+
* callAbsoluteGridToRelativeOutputTasks - Renamed to '...OutputTask'
14+
* handleTextConversionFileClean
15+
* res-ctrl-img-conv.js
16+
* callImageToAbsoluteOutputTasks
17+
* callImageToGridOutputTasks
18+
* callImageToRelativeOutputTasks
19+
* handleImageConversionFileClean
20+
* res-ctrl-img-config.js
21+
* callCreateImageConfigOutputTasks - Renamed to 'callOutputTask'
22+
* handleCreateImageConfigFileClean
23+
* This file is now empty except for requirements.
24+
25+
---
26+
27+
**./src/%command%.js**
28+
* Removed './output/result-control' requirement and replaced with the respective split output file.
29+
* For example, in 'absolute-to-relative-main.js', the requirement is replaced with: './output/res-ctrl-txt-conv'
30+
* The requirement variable itself is only renamed where there is ambiguity.

‎src/absolute-to-relative-main.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ const ioTargetPath = require("./io-paths/target-path");
77
const textFileRead = require("./parsing/text-file-read");
88
const parseStructureIntegrity = require("./parsing/parse-structure-integrity");
99
const automaticHeuristics = require("./parsing/automatic-heuristics");
10-
const resultControl = require("./output/result-control");
10+
const resultControl = require("./output/res-ctrl-txt-conv");
1111

1212

1313
/*
@@ -80,7 +80,7 @@ function executeGraphTasks(pArguments, parsedGraph)
8080
}
8181
else
8282
{
83-
resultControl.callAbsoluteGridToRelativeOutput(pArguments.preparedPaths.writePath, parsedGraph, "Absolute to Relative Conversion");
83+
resultControl.callAbsoluteGridToRelative(pArguments.preparedPaths.writePath, parsedGraph, "Absolute to Relative Conversion");
8484
}
8585
});
8686
}

‎src/create-image-config-main.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ const createConfigValidation = require("./input/create-image-config-validation")
55
const imageEntryValidation = require("./input/image-entry-validation");
66
const imageOptionsValidation = require("./input/image-options-validation");
77
const ioTargetPath = require("./io-paths/target-path");
8-
const resultControl = require("./output/result-control");
8+
const imgConfigResCtrl = require("./output/res-ctrl-img-config");
99

1010

1111
/*
@@ -49,7 +49,7 @@ function executePreperationTasks(optArgsObj, prepArgsObj)
4949
}
5050
else
5151
{
52-
resultControl.callCreateImageConfigOutput(prepArgsObj);
52+
imgConfigResCtrl.callOutput(prepArgsObj);
5353
}
5454
});
5555

‎src/grid-to-absolute-main.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ const textFileRead = require("./parsing/text-file-read");
88
const initializeGrid = require("./parsing/initialize-grid");
99
const gridTraverse = require("./traverse/grid-traverse");
1010
const parseStructureIntegrity = require("./parsing/parse-structure-integrity");
11-
const resultControl = require("./output/result-control");
11+
const resultControl = require("./output/res-ctrl-txt-conv");
1212

1313

1414
/*
@@ -98,7 +98,7 @@ function executeGraphTasks(pArguments, readGrid, parsedGraph)
9898
}
9999
else
100100
{
101-
resultControl.callGridToAbsoluteOutput(pArguments.preparedPaths.writePath, parsedGraph, "Grid to Absolute Conversion");
101+
resultControl.callGridToAbsolute(pArguments.preparedPaths.writePath, parsedGraph, "Grid to Absolute Conversion");
102102
}
103103
});
104104
}

‎src/grid-to-relative-main.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ const initializeGrid = require("./parsing/initialize-grid");
99
const gridTraverse = require("./traverse/grid-traverse");
1010
const parseStructureIntegrity = require("./parsing/parse-structure-integrity");
1111
const automaticHeuristics = require("./parsing/automatic-heuristics");
12-
const resultControl = require("./output/result-control");
12+
const resultControl = require("./output/res-ctrl-txt-conv");
1313

1414

1515

@@ -102,7 +102,7 @@ function executeGraphTasks(pArguments, readGrid, parsedGraph)
102102
}
103103
else
104104
{
105-
resultControl.callAbsoluteGridToRelativeOutput(pArguments.preparedPaths.writePath, parsedGraph, "Grid to Relative Conversion");
105+
resultControl.callAbsoluteGridToRelative(pArguments.preparedPaths.writePath, parsedGraph, "Grid to Relative Conversion");
106106
}
107107
});
108108
}

‎src/image-to-absolute-main.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ const imageFileRead = require("./parsing/image-file-read");
1212
const initializeGrid = require("./parsing/initialize-grid");
1313
const gridTraverse = require("./traverse/grid-traverse");
1414
const parseStructureIntegrity = require("./parsing/parse-structure-integrity");
15-
const resultControl = require("./output/result-control");
15+
const resultControl = require("./output/res-ctrl-img-conv");
1616

1717

1818
/*
@@ -140,7 +140,7 @@ function executeGraphTasks(pArgs, readGrid, parsedGraph)
140140
}
141141
else
142142
{
143-
resultControl.callImageToAbsoluteOutput(pArgs, parsedGraph, "Image to Absolute Conversion");
143+
resultControl.callImageToAbsolute(pArgs, parsedGraph, "Image to Absolute Conversion");
144144
}
145145
});
146146
}

‎src/image-to-grid-main.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ const imageColourValidation = require("./input/image-colour-validation");
1111
const imageFileRead = require("./parsing/image-file-read");
1212
const initializeGrid = require("./parsing/initialize-grid");
1313
const binaryGrid = require("./parsing/binary-grid");
14-
const resultControl = require("./output/result-control");
14+
const resultControl = require("./output/res-ctrl-img-conv");
1515

1616

1717
/*
@@ -123,7 +123,7 @@ function executeGridPreperationTasks(pArguments, rGridObject)
123123
}
124124
else
125125
{
126-
resultControl.callImageToGridOutput(pArguments, rGridObject, gridTaskRes.graphObject, "Image to Grid Conversion");
126+
resultControl.callImageToGrid(pArguments, rGridObject, gridTaskRes.graphObject, "Image to Grid Conversion");
127127
}
128128
});
129129
}

‎src/image-to-relative-main.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ const initializeGrid = require("./parsing/initialize-grid");
1313
const gridTraverse = require("./traverse/grid-traverse");
1414
const parseStructureIntegrity = require("./parsing/parse-structure-integrity");
1515
const automaticHeuristics = require("./parsing/automatic-heuristics");
16-
const resultControl = require("./output/result-control");
16+
const resultControl = require("./output/res-ctrl-img-conv");
1717

1818

1919

@@ -145,7 +145,7 @@ function executeGraphTasks(pArgs, readGrid, parsedGraph)
145145
}
146146
else
147147
{
148-
resultControl.callImageToRelativeOutput(pArgs, parsedGraph, "Image to Relative Conversion");
148+
resultControl.callImageToRelative(pArgs, parsedGraph, "Image to Relative Conversion");
149149
}
150150
});
151151
}

‎src/map-absolute-main.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ const textFileRead = require("./parsing/text-file-read");
88
const parseStructureIntegrity = require("./parsing/parse-structure-integrity");
99
const routeFind = require("./pathfinding/route-find");
1010
const resultFolder = require("./output/result-folder");
11-
const resultControl = require("./output/result-control");
11+
const txtGraphResCtrl = require("./output/res-ctrl-txt-graph");
1212

1313

1414
/*
@@ -92,7 +92,7 @@ function executePathfindingTasks(pArgsObj, parsedGraph)
9292

9393
function executeOutputTasks(pArgs, pGraph, pPathResult)
9494
{
95-
resultControl.callTextGraphOutput(pArgs.preparedPaths, pArgs.mapModeFlag, pGraph, pPathResult, "Absolute Text File");
95+
txtGraphResCtrl.callOutput(pArgs.preparedPaths, pArgs.mapModeFlag, pGraph, pPathResult, "Absolute Text File");
9696
}
9797

9898

‎src/map-grid-main.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const gridTraverse = require("./traverse/grid-traverse");
1010
const parseStructureIntegrity = require("./parsing/parse-structure-integrity");
1111
const routeFind = require("./pathfinding/route-find");
1212
const resultFolder = require("./output/result-folder");
13-
const resultControl = require("./output/result-control");
13+
const txtGraphResCtrl = require("./output/res-ctrl-txt-graph");
1414

1515

1616
/*
@@ -117,7 +117,7 @@ function executeGraphTasks(pArguments, readGrid, parsedGraph)
117117

118118
function executeOutputTasks(pArgs, pGraph, pPathResult)
119119
{
120-
resultControl.callTextGraphOutput(pArgs.preparedPaths, pArgs.mapModeFlag, pGraph, pPathResult, "Grid Text File");
120+
txtGraphResCtrl.callOutput(pArgs.preparedPaths, pArgs.mapModeFlag, pGraph, pPathResult, "Grid Text File");
121121
}
122122

123123

0 commit comments

Comments
 (0)