File SHAREDvars Documentation

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

Copyright © 2020, BAI Research. All Rights Reserved.

File Name: SHAREDvars.cpp/.hpp

File Description: SHARED vars

File Function List


File Diagram (functions hierarchy)


Function SHAREDvarsClass::argumentExists()

Function Summary
namereturn typedescription
argumentExistsboolargument exists

Function Arguments
nametypedescription
argcconst int argc
argv const char** argv
keystr const string keystr

Function Reference List
N/A


Function Trace
locationcurrent function being traced
CSmain.hppargumentExists

Trace Diagram (magenta)


Function SHAREDvarsClass::getFloatArgument()

Function Summary
namereturn typedescription
getFloatArgumentfloatget float argument

Function Arguments
nametypedescription
argcconst int argc
argv const char** argv
keystr const string keystr

Function Reference List
N/A


Function Trace
locationcurrent function being traced
CSmain.hppgetFloatArgument

Trace Diagram (magenta)


Function SHAREDvarsClass::getStringArgument()

Function Summary
namereturn typedescription
getStringArgumentstringget string argument

Function Arguments
nametypedescription
argcconst int argc
argv const char** argv
keystr const string keystr

Function Reference List
N/A


Function Trace
locationcurrent function being traced
CSmain.hppgetStringArgument

Trace Diagram (magenta)


Function SHAREDvarsClass::getCurrentDirectory()

Function Summary
namereturn typedescription
getCurrentDirectorystringget current directory

Function Reference List
N/A


Function Trace
locationcurrent function being traced
CSmain.hppgetCurrentDirectory

Trace Diagram (magenta)


Function SHAREDvarsClass::setCurrentDirectory()

Function Summary
namereturn typedescription
setCurrentDirectoryvoidset current directory

Function Arguments
nametypedescription
folderconst string* folder

Function Reference List
N/A


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

Trace Diagram (magenta)


Function SHAREDvarsClass::convertDoubleToString()

Function Summary
namereturn typedescription
convertDoubleToStringstringconvert double to string

Function Arguments
nametypedescription
numberconst double number
format const string format

Function Reference List


Function Trace
locationcurrent function being traced
LDreferenceManipulation.hppconvertDoubleToString
LDreferenceManipulation.hppconvertRotationMatrixToString
LDreferenceManipulation.hppaddReferenceToFileObject
CSexecflow.hppwriteReferencesToFile
CSmain.hppgenerateCodeStructure
LDreferenceManipulation.hppaddReferenceToFileObject
LDreferenceManipulation.hppwrite2DreferencesLayerToFileObject
LDsvg.hppconvertDoubleToString
LDsvg.hppwriteSVGbox3
LDsvg.hppwriteSVGbox2
CSdraw.hppwriteSVGbox
CSdraw.hppwriteFileOrFunctionSVGbox
CSdraw.hppwriteFileOrFunctionSVGbox
CSdraw.hppprintFunctionBox
CSgenerateHTMLdocumentation.hppcreateFunctionObjectListBoxesAndConnections
CSgenerateHTMLdocumentation.hppgenerateFileDiagramFunctionsHeirachy
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions
LDsvg.hppwriteSVGbox2
CSdraw.hppwriteSVGboxTransparent
CSdraw.hppwriteFileOrFunctionSVGboxTransparent
CSgenerateHTMLdocumentation.hpptraceFunctionsUpwardsAndDrawOrHighLightThese
LDsvg.hppconvertDoubleToString
CSdraw.hppwriteSVGconnector
CSdraw.hppconfigureFileOrFunctionObjectConnection
CSdraw.hppcreateFileObjectConnection
CSdraw.hppconfigureFileOrFunctionObjectConnection

Trace Diagram (magenta)


Function SHAREDvarsClass::convertIntToString()

Function Summary
namereturn typedescription
convertIntToStringstringconvert int to string

Function Arguments
nametypedescription
numberconst int number

Function Reference List


Function Trace
locationcurrent function being traced
LDreferenceManipulation.hppconvertIntToString
LDreferenceManipulation.hppaddReferenceToFileObject
CSexecflow.hppwriteReferencesToFile
CSmain.hppgenerateCodeStructure
LDreferenceManipulation.hppaddReferenceToFileObject
LDreferenceManipulation.hppwrite2DreferencesLayerToFileObject
LDsvg.hppconvertIntToString
LDsvg.hppwriteSVGbox3
LDsvg.hppwriteSVGbox2
CSdraw.hppwriteSVGbox
CSdraw.hppwriteFileOrFunctionSVGbox
CSdraw.hppwriteFileOrFunctionSVGbox
CSdraw.hppprintFunctionBox
CSgenerateHTMLdocumentation.hppcreateFunctionObjectListBoxesAndConnections
CSgenerateHTMLdocumentation.hppgenerateFileDiagramFunctionsHeirachy
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions
LDsvg.hppwriteSVGbox2
CSdraw.hppwriteSVGboxTransparent
CSdraw.hppwriteFileOrFunctionSVGboxTransparent
CSgenerateHTMLdocumentation.hpptraceFunctionsUpwardsAndDrawOrHighLightThese
CSdraw.hppconvertIntToString
CSdraw.hppcreateGroupID
CSdraw.hppcreateFileObjectConnection
CSdraw.hppcreateGroupID
LDsvg.hppconvertIntToString
LDsvg.hppwriteSVGtext
CSdraw.hppwriteSVGtext
LDsvg.hppconvertIntToString
CSdraw.hppwriteSVGline
LDsvg.hppconvertIntToString
LDsvg.hppconvertIntToString
LDsvg.hppwriteSVGheader

Trace Diagram (magenta)


Function SHAREDvarsClass::convertUnsignedIntToString()

Function Summary
namereturn typedescription
convertUnsignedIntToStringstringconvert unsigned int to string

Function Arguments
nametypedescription
numberconst int number

Function Reference List


Function Trace
locationcurrent function being traced
LDreferenceManipulation.hppconvertUnsignedIntToString
LDreferenceManipulation.hppaddReferenceToFileObject
CSexecflow.hppwriteReferencesToFile
CSmain.hppgenerateCodeStructure
LDreferenceManipulation.hppaddReferenceToFileObject
LDreferenceManipulation.hppwrite2DreferencesLayerToFileObject

Trace Diagram (magenta)


Function SHAREDvarsClass::convertStringToInt()

Function Summary
namereturn typedescription
convertStringToIntintconvert string to int

Function Arguments
nametypedescription
numberconst string number

Function Reference List
N/A


Function Trace
locationcurrent function being traced
CSexecflow.hppconvertStringToInt
CSexecflow.hppinitialiseGrid
CSmain.hppgenerateCodeStructure
CSdraw.hppconvertStringToInt

Trace Diagram (magenta)


Function SHAREDvarsClass::convertStringToDouble()

Function Summary
namereturn typedescription
convertStringToDoubledoubleconvert string to double

Function Arguments
nametypedescription
numberconst string number

Function Reference List
N/A


Function Trace
locationcurrent function being traced
LDparser.hppconvertStringToDouble
CSexecflow.hppparseFile
CSmain.hppgenerateCodeStructure
XMLrulesClass.hppconvertStringToDouble
XMLrulesClass.hppaddRulesClassObjectBasedOnTag
XMLrulesClass.hppaddRulesClassObjectsBasedOnSectionTag
XMLrulesClass.hppparseCSRulesTag

Trace Diagram (magenta)


Function SHAREDvarsClass::textInTextArray()

Function Summary
namereturn typedescription
textInTextArraybooltext in text array

Function Arguments
nametypedescription
textconst string text
textArray const string* text array
arraySize const int array size
arrayIndexOfResultFound int* array index of result found

Function Reference List
N/A


Function Trace
locationcurrent function being traced
CSoperations.hpptextInTextArray
CSoperations.hppgetFunctionNamesFromFunctionDeclarationsInHfile
CSexecflow.hppgetIncludeFileNamesFromCorHfile
CSmain.hppgenerateCodeStructure

Trace Diagram (magenta)


Function SHAREDvarsClass::charInCharArray()

Function Summary
namereturn typedescription
charInCharArrayboolchar in char array

Function Arguments
nametypedescription
cconst char c
charArray const char* char array
arraySize const int array size

Function Reference List
N/A


Function Trace
locationcurrent function being traced
CSoperations.hppcharInCharArray
CSoperations.hppsearchFunctionStringForFunctionReference
CSoperations.hppsearchFunctionStringForFunctionReferences
CSoperations.hppsearchFunctionStringForFunctionReferencesRecursive
CSoperations.hppgetFunctionObjectNamesFromFunctionsInCfile
CSexecflow.hppgetIncludeFileNamesFromCorHfile
CSmain.hppgenerateCodeStructure
CSgenerateObjectOrientedCode.hppcharInCharArray
CSgenerateObjectOrientedCode.hppreplaceAllOccurancesOfFunctionObjectReferenceNameInFunction
CSgenerateObjectOrientedCode.hppgenerateCPPclassesFile
CSgenerateObjectOrientedCode.hppgenerateCPPclassesRecurse
CSgenerateConstFunctionArgumentCode.hppcharInCharArray
CSgenerateConstFunctionArgumentCode.hppfunctionArgumentReferenceWholeWordCheck
CSgenerateConstFunctionArgumentCode.hppcheckIfVariableIsBeingModifiedInFunction
CSgenerateConstFunctionArgumentCode.hppgenerateConstFunctionArgument
CSgenerateConstFunctionArgumentCode.hppgenerateConstFunctionArgumentAndSearchForSecondaryReferences
CSgenerateConstFunctionArgumentCode.hppgenerateConstFunctionArgumentsFunction
CSgenerateConstFunctionArgumentCode.hppgenerateConstFunctionArgumentsFile
CSgenerateConstFunctionArgumentCode.hppgenerateConstFunctionArgumentsRecurse

Trace Diagram (magenta)


Function SHAREDvarsClass::replaceAllOccurancesOfString()

Function Summary
namereturn typedescription
replaceAllOccurancesOfStringstringreplace all occurances of string

Function Arguments
nametypedescription
textOrigconst string* text orig
stringToFind string string to find
replacementString string replacement string

Function Reference List


Function Trace
locationcurrent function being traced
CSgenerateConstFunctionArgumentCode.hppreplaceAllOccurancesOfString
CSgenerateConstFunctionArgumentCode.hppgenerateConstFunctionArgumentsFile
CSgenerateConstFunctionArgumentCode.hppgenerateConstFunctionArgumentsRecurse
CSexecflow.hppgenerateConstFunctionArguments
CSmain.hppgenerateCodeStructure

Trace Diagram (magenta)


Function SHAREDvarsClass::replaceAllOccurancesOfString()

Function Summary
namereturn typedescription
replaceAllOccurancesOfStringstringreplace all occurances of string

Function Arguments
nametypedescription
textOrigconst string* text orig
stringToFind string string to find
replacementString string replacement string
foundAtLeastOneInstance bool* found at least one instance

Function Reference List
N/A


Function Trace
locationcurrent function being traced
CSgenerateObjectOrientedCode.hppreplaceAllOccurancesOfString
CSgenerateObjectOrientedCode.hppgenerateCPPclassesFile
CSgenerateObjectOrientedCode.hppgenerateCPPclassesRecurse
CSexecflow.hppgenerateCPPclasses
CSmain.hppgenerateCodeStructure
SHAREDvars.hppreplaceAllOccurancesOfString
CSgenerateConstFunctionArgumentCode.hppreplaceAllOccurancesOfString
CSgenerateConstFunctionArgumentCode.hppgenerateConstFunctionArgumentsFile
CSgenerateConstFunctionArgumentCode.hppgenerateConstFunctionArgumentsRecurse

Trace Diagram (magenta)


Function SHAREDvarsClass::writeStringToFile()

Function Summary
namereturn typedescription
writeStringToFilevoidwrite string to file

Function Arguments
nametypedescription
fileNameconst string file name
s string* s

Function Reference List
N/A


Function Trace
locationcurrent function being traced
CSgenerateObjectOrientedCode.hppwriteStringToFile
CSgenerateObjectOrientedCode.hppgenerateCPPclassesFile
CSgenerateObjectOrientedCode.hppgenerateCPPclassesRecurse
CSexecflow.hppgenerateCPPclasses
CSmain.hppgenerateCodeStructure
CSgenerateConstFunctionArgumentCode.hppwriteStringToFile
CSgenerateConstFunctionArgumentCode.hppgenerateConstFunctionArgumentsFile
CSgenerateConstFunctionArgumentCode.hppgenerateConstFunctionArgumentsRecurse

Trace Diagram (magenta)


Function SHAREDvarsClass::getFileContents()

Function Summary
namereturn typedescription
getFileContentsstringget file contents

Function Arguments
nametypedescription
inputFileNameconst string input file name

Function Reference List
N/A


Function Trace
locationcurrent function being traced
CSoperations.hppgetFileContents
CSexecflow.hppgetIncludeFileNamesFromCorHfile
CSmain.hppgenerateCodeStructure

Trace Diagram (magenta)


Function SHAREDvarsClass::fileExists()

Function Summary
namereturn typedescription
fileExistsboolfile exists

Function Arguments
nametypedescription
inputFileNameconst string input file name

Function Reference List
N/A


Function Trace
locationcurrent function being traced
CSoperations.hppfileExists
CSexecflow.hppgetIncludeFileNamesFromCorHfile
CSmain.hppgenerateCodeStructure
CSgenerateConstFunctionArgumentCode.hppfileExists
CSgenerateConstFunctionArgumentCode.hppgenerateConstFunctionArgumentsRecurse

Trace Diagram (magenta)


Function SHAREDvarsClass::sprintfSafeDouble()

Function Summary
namereturn typedescription
sprintfSafeDoublevoidsprintf safe double

Function Arguments
nametypedescription
stringCharStarchar* string char star
type const char* type
number double number

Function Reference List
N/A


Function Trace
locationcurrent function being traced
LDreferenceManipulation.hppsprintfSafeDouble
LDreferenceManipulation.hppconvertPositionCoordinatesToString
LDreferenceManipulation.hppaddReferenceToFileObject
CSexecflow.hppwriteReferencesToFile
CSmain.hppgenerateCodeStructure
LDreferenceManipulation.hppaddReferenceToFileObject
LDreferenceManipulation.hppwrite2DreferencesLayerToFileObject
SHAREDvars.hppsprintfSafeDouble
LDreferenceManipulation.hppconvertDoubleToString
LDsvg.hppconvertDoubleToString
LDsvg.hppwriteSVGbox3
LDsvg.hppwriteSVGbox2
CSdraw.hppwriteSVGbox
CSdraw.hppwriteFileOrFunctionSVGbox
CSdraw.hppwriteFileOrFunctionSVGbox
CSdraw.hppprintFunctionBox
CSgenerateHTMLdocumentation.hppcreateFunctionObjectListBoxesAndConnections
CSgenerateHTMLdocumentation.hppgenerateFileDiagramFunctionsHeirachy
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions
LDsvg.hppwriteSVGbox2
CSdraw.hppwriteSVGboxTransparent
CSdraw.hppwriteFileOrFunctionSVGboxTransparent
CSgenerateHTMLdocumentation.hpptraceFunctionsUpwardsAndDrawOrHighLightThese
LDsvg.hppconvertDoubleToString
CSdraw.hppwriteSVGconnector
CSdraw.hppconfigureFileOrFunctionObjectConnection
CSdraw.hppcreateFileObjectConnection
CSdraw.hppconfigureFileOrFunctionObjectConnection

Trace Diagram (magenta)


Function SHAREDvarsClass::sprintfSafeInt()

Function Summary
namereturn typedescription
sprintfSafeIntvoidsprintf safe int

Function Arguments
nametypedescription
stringCharStarchar* string char star
type const char* type
number int number

Function Reference List
N/A


Function Trace
locationcurrent function being traced
SHAREDvars.hppsprintfSafeInt
LDreferenceManipulation.hppconvertIntToString
LDreferenceManipulation.hppaddReferenceToFileObject
CSexecflow.hppwriteReferencesToFile
CSmain.hppgenerateCodeStructure
LDreferenceManipulation.hppaddReferenceToFileObject
LDreferenceManipulation.hppwrite2DreferencesLayerToFileObject
LDsvg.hppconvertIntToString
LDsvg.hppwriteSVGbox3
LDsvg.hppwriteSVGbox2
CSdraw.hppwriteSVGbox
CSdraw.hppwriteFileOrFunctionSVGbox
CSdraw.hppwriteFileOrFunctionSVGbox
CSdraw.hppprintFunctionBox
CSgenerateHTMLdocumentation.hppcreateFunctionObjectListBoxesAndConnections
CSgenerateHTMLdocumentation.hppgenerateFileDiagramFunctionsHeirachy
CSgenerateHTMLdocumentation.hppgenerateHTMLdocumentationForAllFunctions
LDsvg.hppwriteSVGbox2
CSdraw.hppwriteSVGboxTransparent
CSdraw.hppwriteFileOrFunctionSVGboxTransparent
CSgenerateHTMLdocumentation.hpptraceFunctionsUpwardsAndDrawOrHighLightThese
CSdraw.hppconvertIntToString
CSdraw.hppcreateGroupID
CSdraw.hppcreateFileObjectConnection
CSdraw.hppcreateGroupID
LDsvg.hppconvertIntToString
LDsvg.hppwriteSVGtext
CSdraw.hppwriteSVGtext
LDsvg.hppconvertIntToString
CSdraw.hppwriteSVGline
LDsvg.hppconvertIntToString
LDsvg.hppconvertIntToString
LDsvg.hppwriteSVGheader
SHAREDvars.hppsprintfSafeInt

Trace Diagram (magenta)