File CSdraw Documentation

Automatically generated with Code Structure Viewer (CS), Project Version: 3o4d 17-November-2020

Copyright © 2020, BAI Research. All Rights Reserved.

File Name: CSdraw.cpp/.hpp

File Description: CS draw

File Function List


File Diagram (functions hierarchy)


Function CSdrawClass::initiateMaxXatParticularY()

Function Summary
namereturn typedescription
initiateMaxXatParticularYvoidinitiate max xat particular Y

Function Reference List
N/A


Function Trace
locationcurrent function being traced
CSexecflow.hppinitiateMaxXatParticularY
CSmain.hppgenerateCodeStructure
CSgenerateHTMLdocumentation.hppinitiateMaxXatParticularY
CSgenerateHTMLdocumentation.hppgenerateFileDiagramFunctionsHeirachy
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions

Trace Diagram (magenta)


Function CSdrawClass::createFileObjectListBoxes()

Function Summary
namereturn typedescription
createFileObjectListBoxesLDreference*create file object list boxes

Function Arguments
nametypedescription
currentReferenceInPrintListLDreference* current reference in print list
firstObjectInAboveLevelBelowListContainer CSfileContainer* first object in above level below list container
firstObjectInTopLevelBelowListContainer CSfileContainer* first object in top level below list container
currentTag XMLparserTag** current tag
outputFunctionsConnectivity const bool output functions connectivity
traceFunctionUpwards const bool trace function upwards
firstTagInGridTag XMLparserTag* first tag in grid tag
usePredefinedGrid const bool use predefined grid

Function Reference List


Function Trace
locationcurrent function being traced
CSexecflow.hppcreateFileObjectListBoxes
CSmain.hppgenerateCodeStructure

Trace Diagram (magenta)


Function CSdrawClass::createFileObjectListBoxesPrintedReset()

Function Summary
namereturn typedescription
createFileObjectListBoxesPrintedResetvoidcreate file object list boxes printed reset

Function Arguments
nametypedescription
firstObjectInAboveLevelBelowListContainerCSfileContainer* first object in above level below list container

Function Reference List


Function Trace
locationcurrent function being traced
CSexecflow.hppcreateFileObjectListBoxesPrintedReset
CSmain.hppgenerateCodeStructure

Trace Diagram (magenta)


Function CSdrawClass::hasPreviousReferenceWithThisNameHasBeenPrinted()

Function Summary
namereturn typedescription
hasPreviousReferenceWithThisNameHasBeenPrintedboolhas previous reference with this name has been printed

Function Arguments
nametypedescription
namestring name
firstObjectInTopLevelBelowListContainer CSfileContainer* first object in top level below list container
*maxYPos int *max YP os

Function Reference List


Function Trace
locationcurrent function being traced
CSdraw.hpphasPreviousReferenceWithThisNameHasBeenPrinted
CSexecflow.hppcreateFileObjectListBoxes
CSmain.hppgenerateCodeStructure

Trace Diagram (magenta)


Function CSdrawClass::hasPreviousReferenceWithThisNameHasBeenPrintedReset()

Function Summary
namereturn typedescription
hasPreviousReferenceWithThisNameHasBeenPrintedResetvoidhas previous reference with this name has been printed reset

Function Arguments
nametypedescription
firstObjectInTopLevelBelowListContainerCSfileContainer* first object in top level below list container

Function Reference List


Function Trace
locationcurrent function being traced
CSdraw.hpphasPreviousReferenceWithThisNameHasBeenPrintedReset
CSexecflow.hppcreateFileObjectListBoxes
CSmain.hppgenerateCodeStructure

Trace Diagram (magenta)


Function CSdrawClass::createFileObjectListConnections()

Function Summary
namereturn typedescription
createFileObjectListConnectionsLDreference*create file object list connections

Function Arguments
nametypedescription
currentReferenceInPrintListLDreference* current reference in print list
firstObjectInAboveLevelBelowListContainer CSfileContainer* first object in above level below list container
aboveLevelObject CSfile* above level object
currentTag XMLparserTag** current tag
traceFunctionUpwards const bool trace function upwards

Function Reference List


Function Trace
locationcurrent function being traced
CSexecflow.hppcreateFileObjectListConnections
CSmain.hppgenerateCodeStructure

Trace Diagram (magenta)


Function CSdrawClass::createFileObjectConnection()

Function Summary
namereturn typedescription
createFileObjectConnectionLDreference*create file object connection

Function Arguments
nametypedescription
currentReferenceInPrintListLDreference* current reference in print list
reference CSfile* reference
currentReferenceInAboveList CSfile* current reference in above list
colour int colour
traceAFunctionUpwardsAndNotCurrentlyTracing const bool trace AF unction upwards and not currently tracing
currentTag XMLparserTag** current tag

Function Reference List


Function Trace
locationcurrent function being traced
CSdraw.hppcreateFileObjectConnection
CSexecflow.hppcreateFileObjectListConnections
CSmain.hppgenerateCodeStructure

Trace Diagram (magenta)


Function CSdrawClass::createFunctionObjectListBoxesAndConnections()

Function Summary
namereturn typedescription
createFunctionObjectListBoxesAndConnectionsLDreference*create function object list boxes and connections

Function Arguments
nametypedescription
currentReferenceInPrintListLDreference* current reference in print list
aboveLevelFileObject CSfile* above level file object
aboveLevelFunctionObject CSfunction* above level function object
firstObjectInTopLevelBelowListContainer CSfileContainer* first object in top level below list container
functionLevel const int function level
functionReference const CSfunction* function reference
currentTag XMLparserTag** current tag
traceFunctionUpwards const bool trace function upwards
useSingleFileOnly const bool use single file only
singleFileName string* single file name
usePredefinedGrid const bool use predefined grid
isTopLevelFunction const bool is top level function

Function Reference List


Function Trace
locationcurrent function being traced
CSexecflow.hppcreateFunctionObjectListBoxesAndConnections
CSmain.hppgenerateCodeStructure
CSgenerateHTMLdocumentation.hppcreateFunctionObjectListBoxesAndConnections
CSgenerateHTMLdocumentation.hppgenerateFileDiagramFunctionsHeirachy
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions

Trace Diagram (magenta)


Function CSdrawClass::printFunctionBox()

Function Summary
namereturn typedescription
printFunctionBoxLDreference*print function box

Function Arguments
nametypedescription
currentReferenceInPrintListLDreference* current reference in print list
currentTag XMLparserTag** current tag
functionObject CSfunction* function object
colour int colour

Function Reference List


Function Trace
locationcurrent function being traced
CSdraw.hppprintFunctionBox
CSexecflow.hppcreateFunctionObjectListBoxesAndConnections
CSmain.hppgenerateCodeStructure
CSgenerateHTMLdocumentation.hppcreateFunctionObjectListBoxesAndConnections
CSgenerateHTMLdocumentation.hppgenerateFileDiagramFunctionsHeirachy
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions

Trace Diagram (magenta)


Function CSdrawClass::printFunctionBoxText()

Function Summary
namereturn typedescription
printFunctionBoxTextLDreference*print function box text

Function Arguments
nametypedescription
currentReferenceInPrintListLDreference* current reference in print list
currentTag XMLparserTag** current tag
functionObject CSfunction* function object
colour const int colour
useSingleFileOnly const bool use single file only

Function Reference List


Function Trace
locationcurrent function being traced
CSdraw.hppprintFunctionBoxText
CSexecflow.hppcreateFunctionObjectListBoxesAndConnections
CSmain.hppgenerateCodeStructure
CSgenerateHTMLdocumentation.hppcreateFunctionObjectListBoxesAndConnections
CSgenerateHTMLdocumentation.hppgenerateFileDiagramFunctionsHeirachy
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions

Trace Diagram (magenta)


Function CSdrawClass::resetPrintedFunctionConnections()

Function Summary
namereturn typedescription
resetPrintedFunctionConnectionsvoidreset printed function connections

Function Arguments
nametypedescription
aboveLevelFileObjectconstEffective CSfile* above level file object
aboveLevelFunctionObject CSfunction* above level function object
useSingleFileOnly const bool use single file only
singleFileName const string* single file name

Function Reference List


Function Trace
locationcurrent function being traced
CSexecflow.hppresetPrintedFunctionConnections
CSmain.hppgenerateCodeStructure
CSgenerateHTMLdocumentation.hppresetPrintedFunctionConnections
CSgenerateHTMLdocumentation.hppgenerateFileDiagramFunctionsHeirachy
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions

Trace Diagram (magenta)


Function CSdrawClass::createFunctionObjectConnection()

Function Summary
namereturn typedescription
createFunctionObjectConnectionLDreference*create function object connection

Function Arguments
nametypedescription
currentReferenceInPrintListLDreference* current reference in print list
reference CSfunction* reference
currentReferenceInAboveList CSfunction* current reference in above list
colour int colour
traceAFunctionUpwardsAndNotCurrentlyTracing const bool trace AF unction upwards and not currently tracing
prepareForTrace const bool prepare for trace
currentTag XMLparserTag** current tag
fileObject const CSfile* file object
currentFileObjectInAboveList CSfile* current file object in above list

Function Reference List


Function Trace
locationcurrent function being traced
CSdraw.hppcreateFunctionObjectConnection
CSexecflow.hppcreateFunctionObjectListBoxesAndConnections
CSmain.hppgenerateCodeStructure
CSgenerateHTMLdocumentation.hppcreateFunctionObjectListBoxesAndConnections
CSgenerateHTMLdocumentation.hppgenerateFileDiagramFunctionsHeirachy
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions
CSdraw.hppcreateFunctionObjectConnection
CSgenerateHTMLdocumentation.hpptraceFunctionsUpwardsAndDrawOrHighLightThese

Trace Diagram (magenta)


Function CSdrawClass::configureFileOrFunctionObjectConnection()

Function Summary
namereturn typedescription
configureFileOrFunctionObjectConnectionLDreference*configure file or function object connection

Function Arguments
nametypedescription
currentReferenceInPrintListLDreference* current reference in print list
referencePrintPos vec* reference print pos
currentReferenceInAboveListPrintPos vec* current reference in above list print pos
colour int colour
fileOrFunction const bool file or function
traceAFunctionUpwardsAndNotCurrentlyTracing const bool trace AF unction upwards and not currently tracing
currentTag XMLparserTag** current tag
startGroupID const string* start group ID
endGroupID const string* end group ID

Function Reference List


Function Trace
locationcurrent function being traced
CSdraw.hppconfigureFileOrFunctionObjectConnection
CSdraw.hppcreateFileObjectConnection
CSexecflow.hppcreateFileObjectListConnections
CSmain.hppgenerateCodeStructure
CSdraw.hppconfigureFileOrFunctionObjectConnection
CSdraw.hppcreateFunctionObjectConnection
CSgenerateHTMLdocumentation.hppcreateFunctionObjectListBoxesAndConnections
CSgenerateHTMLdocumentation.hppgenerateFileDiagramFunctionsHeirachy
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions
CSdraw.hppcreateFunctionObjectConnection
CSgenerateHTMLdocumentation.hpptraceFunctionsUpwardsAndDrawOrHighLightThese

Trace Diagram (magenta)


Function CSdrawClass::createFileOrFunctionObjectBox()

Function Summary
namereturn typedescription
createFileOrFunctionObjectBoxLDreference*create file or function object box

Function Arguments
nametypedescription
currentReferenceInPrintListLDreference* current reference in print list
referencePrintPos vec* reference print pos
referenceName string* reference name
scaleFactor double scale factor
colour int colour
maxTextLength double max text length
zPosition double zPosition

Function Reference List
N/A


Function Trace
locationcurrent function being traced
CSdraw.hppcreateFileOrFunctionObjectBox
CSexecflow.hppcreateFileObjectListBoxes
CSmain.hppgenerateCodeStructure
CSdraw.hppcreateFileOrFunctionObjectBox
CSdraw.hppprintFunctionBox
CSgenerateHTMLdocumentation.hppcreateFunctionObjectListBoxesAndConnections
CSgenerateHTMLdocumentation.hppgenerateFileDiagramFunctionsHeirachy
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions
CSdraw.hppcreateFileOrFunctionObjectBox
CSgenerateHTMLdocumentation.hpptraceFunctionsUpwardsAndDrawOrHighLightThese

Trace Diagram (magenta)


Function CSdrawClass::createBox()

Function Summary
namereturn typedescription
createBoxLDreference*create box

Function Arguments
nametypedescription
currentReferenceInPrintListLDreference* current reference in print list
vect vec* vect
width const double width
height const double height
colour int colour

Function Reference List
N/A


Function Trace
locationcurrent function being traced
CSdraw.hppcreateBox
CSexecflow.hppcreateFileObjectListBoxes
CSmain.hppgenerateCodeStructure

Trace Diagram (magenta)


Function CSdrawClass::calculateCSBoxAndConnectionColourBasedUponLevel()

Function Summary
namereturn typedescription
calculateCSBoxAndConnectionColourBasedUponLevelintcalculate CSB ox and connection colour based upon level

Function Arguments
nametypedescription
yIndexconst int yIndex

Function Reference List
N/A


Function Trace
locationcurrent function being traced
CSdraw.hppcalculateCSBoxAndConnectionColourBasedUponLevel
CSexecflow.hppcreateFileObjectListBoxes
CSmain.hppgenerateCodeStructure
CSdraw.hppcalculateCSBoxAndConnectionColourBasedUponLevel
CSdraw.hppcalculateCSBoxAndConnectionColourBasedUponLevel
CSgenerateHTMLdocumentation.hppcreateFunctionObjectListBoxesAndConnections
CSgenerateHTMLdocumentation.hppgenerateFileDiagramFunctionsHeirachy
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions

Trace Diagram (magenta)


Function CSdrawClass::calculateCSBoxAndConnectionColourBasedUponFileName()

Function Summary
namereturn typedescription
calculateCSBoxAndConnectionColourBasedUponFileNameintcalculate CSB ox and connection colour based upon file name

Function Arguments
nametypedescription
currentFileObjectconst CSfile* current file object

Function Reference List
N/A


Function Trace
locationcurrent function being traced
CSdraw.hppcalculateCSBoxAndConnectionColourBasedUponFileName
CSexecflow.hppcreateFileObjectListBoxes
CSmain.hppgenerateCodeStructure
CSdraw.hppcalculateCSBoxAndConnectionColourBasedUponFileName

Trace Diagram (magenta)


Function CSdrawClass::findPrintedFunctionObjectWithName()

Function Summary
namereturn typedescription
findPrintedFunctionObjectWithNameboolfind printed function object with name

Function Arguments
nametypedescription
nameconst string name
firstObjectInAboveLevelBelowListContainer constEffective CSfileContainer* first object in above level below list container
fileObjectHoldingFunction constEffective CSfile** file object holding function
updatedFunctionObject constEffective CSfunction** updated function object

Function Reference List


Function Trace
locationcurrent function being traced
CSexecflow.hppfindPrintedFunctionObjectWithName
CSmain.hppgenerateCodeStructure

Trace Diagram (magenta)


Function CSdrawClass::traceFunctionsUpwardsAndDrawOrHighLightThese()

Function Summary
namereturn typedescription
traceFunctionsUpwardsAndDrawOrHighLightTheseLDreference*trace functions upwards and draw or high light these

Function Arguments
nametypedescription
currentReferenceInPrintListLDreference* current reference in print list
firstObjectInTopLevelBelowListContainer CSfileContainer* first object in top level below list container
currentFunctionBeingTraced CSfunction* current function being traced
currentTag XMLparserTag** current tag
generateHTMLdocumentationMode int generate HTML documentation mode
HTMLdocumentationFunctionTraceTableRows string* HTML documentation function trace table rows

Function Reference List


Function Trace
locationcurrent function being traced
CSgenerateHTMLdocumentation.hpptraceFunctionsUpwardsAndDrawOrHighLightThese
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForFunction
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions
CSexecflow.hppgenerateHTMLdocumentationFunctions
CSmain.hppgenerateCodeStructure

Trace Diagram (magenta)


Function CSdrawClass::traceFunctionsUpwardsAndDrawOrHighLightTheseReset()

Function Summary
namereturn typedescription
traceFunctionsUpwardsAndDrawOrHighLightTheseResetvoidtrace functions upwards and draw or high light these reset

Function Arguments
nametypedescription
firstObjectInTopLevelBelowListContainerconst CSfileContainer* first object in top level below list container
currentFunctionBeingTraced CSfunction* current function being traced

Function Reference List


Function Trace
locationcurrent function being traced
CSgenerateHTMLdocumentation.hpptraceFunctionsUpwardsAndDrawOrHighLightTheseReset
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForFunction
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions
CSexecflow.hppgenerateHTMLdocumentationFunctions
CSmain.hppgenerateCodeStructure

Trace Diagram (magenta)


Function CSdrawClass::writeFileOrFunctionSVGbox()

Function Summary
namereturn typedescription
writeFileOrFunctionSVGboxvoidwrite file or function SVG box

Function Arguments
nametypedescription
currentTagXMLparserTag** current tag
pos const vec* pos
textLength const int text length
scaleFactor const double scale factor
maxTextLength const double max text length
col const int col
boxOutlineWidth const double box outline width

Function Reference List


Function Trace
locationcurrent function being traced
CSdraw.hppwriteFileOrFunctionSVGbox
CSexecflow.hppcreateFileObjectListBoxes
CSmain.hppgenerateCodeStructure
CSdraw.hppwriteFileOrFunctionSVGbox
CSdraw.hppprintFunctionBox
CSgenerateHTMLdocumentation.hppcreateFunctionObjectListBoxesAndConnections
CSgenerateHTMLdocumentation.hppgenerateFileDiagramFunctionsHeirachy
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions

Trace Diagram (magenta)


Function CSdrawClass::writeFileOrFunctionSVGboxTransparent()

Function Summary
namereturn typedescription
writeFileOrFunctionSVGboxTransparentvoidwrite file or function SVG box transparent

Function Arguments
nametypedescription
currentTagXMLparserTag** current tag
pos const vec* pos
textLength const int text length
scaleFactor const double scale factor
maxTextLength const double max text length
col const int col
boxOutlineWidth const double box outline width
fillOpacity const double fill opacity

Function Reference List


Function Trace
locationcurrent function being traced
CSdraw.hppwriteFileOrFunctionSVGboxTransparent
CSgenerateHTMLdocumentation.hpptraceFunctionsUpwardsAndDrawOrHighLightThese
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForFunction
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions
CSexecflow.hppgenerateHTMLdocumentationFunctions
CSmain.hppgenerateCodeStructure

Trace Diagram (magenta)


Function CSdrawClass::fillInCSrulesExternVariables()

Function Summary
namereturn typedescription
fillInCSrulesExternVariablesvoidfill in CS rules extern variables

Function Reference List
N/A


Function Trace
locationcurrent function being traced
CSmain.hppfillInCSrulesExternVariables

Trace Diagram (magenta)


Function CSdrawClass::createGroupID()

Function Summary
namereturn typedescription
createGroupIDstringcreate group ID

Function Arguments
nametypedescription
objectNameconst string object name
printX const int print X
printY const int print Y

Function Reference List


Function Trace
locationcurrent function being traced
CSdraw.hppcreateGroupID
CSexecflow.hppcreateFileObjectListBoxes
CSmain.hppgenerateCodeStructure
CSdraw.hppcreateGroupID
CSdraw.hppcreateFileObjectConnection
CSdraw.hppcreateGroupID
CSdraw.hppcreateFunctionObjectConnection
CSgenerateHTMLdocumentation.hppcreateFunctionObjectListBoxesAndConnections
CSgenerateHTMLdocumentation.hppgenerateFileDiagramFunctionsHeirachy
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions
CSdraw.hppcreateFunctionObjectConnection
CSgenerateHTMLdocumentation.hpptraceFunctionsUpwardsAndDrawOrHighLightThese

Trace Diagram (magenta)