Software Project Documentation

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

Copyright © 2020, BAI Research. All Rights Reserved.


Software Project Code Structure - Files



Software Project Code Structure - Functions


File CSmain Documentation

File Name: CSmain.cpp/.hpp

File Description: CS main

File Function List


File Diagram (functions hierarchy)


Function main()

Function Summary
namereturn typedescription
mainintmain

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

Function Reference List


File CSexecflow Documentation

File Name: CSexecflow.cpp/.hpp

File Description: CS execflow

File Function List


File Diagram (functions hierarchy)


Function CSexecflowClass::generateCodeStructure()

Function Summary
namereturn typedescription
generateCodeStructurevoidgenerate code structure

Function Arguments
nametypedescription
topLevelFileNameconst string top level file name
width int width
height const int height
outputLDRfileName const string output LDR file name
outputSVGfileName const string output SVG file name
outputPPMfileName const string output PPM file name
outputHTMLfileName string output HTML file name
useOutputLDRfile const bool use output LDR file
useOutputPPMfile const bool use output PPM file
useOutputHTMLfile bool use output HTML file
generateHTMLdocumentationMode int generate HTML documentation mode
display const bool display
outputFunctionsConnectivity bool output functions connectivity
traceFunctionUpwards bool trace function upwards
bottomLevelFunctionNameToTraceUpwards string bottom level function name to trace upwards
outputFileConnections const bool output file connections
topLevelFunctionName const string top level function name
generateOOcode const bool generate OO code
generateConstFunctionArgumentsCode const bool generate const function arguments code

Function Reference List


Function CSexecflowClass::initialiseGrid()

Function Summary
namereturn typedescription
initialiseGridboolinitialise grid

Function Arguments
nametypedescription
firstTagInGridTagXMLparserTag** first tag in grid tag

Function Reference List


File CSreferenceContainerClass Documentation

File Name: CSreferenceContainerClass.cpp/.hpp

File Description: CS reference container class

File Function List


File Diagram (functions hierarchy)


Class CSfunctionContainer

Class Data
nametypedescription
nextCSfunctionContainer*next
previousCSfunctionContainer*previous
functionObjectCSfunction*function object
fileObjectHoldingFunctionCSfile*file object holding function

Class CSfileContainer

Class Data
nametypedescription
nextCSfileContainer*next
previousCSfileContainer*previous
fileObjectCSfile*file object
aboveLevelObjectCSfile*above level object

Function CSreferenceContainerClassClass::findEndPositionOfArgument()

Function Summary
namereturn typedescription
findEndPositionOfArgumentintfind end position of argument

Function Arguments
nametypedescription
functionArgumentsRawconst string* function arguments raw
startPositionOfArgument const int start position of argument
lastArgument bool* last argument

Function Reference List
N/A


Function CSreferenceContainerClassClass::findFunctionReferenceTarget()

Function Summary
namereturn typedescription
findFunctionReferenceTargetboolfind function reference target

Function Arguments
nametypedescription
functionReferenceconst CSfunction* function reference
currentFileObject constEffective CSfile* current file object
fileObjectHoldingFunction constEffective CSfile** file object holding function
functionReferenceTarget constEffective CSfunction** function reference target
countArguments const bool count arguments

Function Reference List


Function CSreferenceContainerClassClass::findFunctionReferenceTargetRecurse()

Function Summary
namereturn typedescription
findFunctionReferenceTargetRecurseboolfind function reference target recurse

Function Arguments
nametypedescription
functionReferenceconst CSfunction* function reference
firstObjectInAboveLevelBelowListContainer constEffective CSfileContainer* first object in above level below list container
fileObjectHoldingFunction constEffective CSfile** file object holding function
functionReferenceTarget constEffective CSfunction** function reference target
countArguments const bool count arguments

Function Reference List


Function CSreferenceContainerClassClass::countArgumentList()

Function Summary
namereturn typedescription
countArgumentListintcount argument list

Function Arguments
nametypedescription
firstFunctionArgumentInFunctionconst CSfunctionArgument* first function argument in function

Function Reference List
N/A


Function CSreferenceContainerClassClass::findFunctionReferenceTargetRecurseReset()

Function Summary
namereturn typedescription
findFunctionReferenceTargetRecurseResetvoidfind function reference target recurse reset

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

Function Reference List


File LDreferenceManipulation Documentation

File Name: LDreferenceManipulation.cpp/.hpp

File Description: LD reference manipulation

File Function List


File Diagram (functions hierarchy)


Function LDreferenceManipulationClass::copyReferences()

Function Summary
namereturn typedescription
copyReferencesvoidcopy references

Function Arguments
nametypedescription
referenceNewLDreference* reference new
referenceToCopy LDreference* reference to copy
type const int type

Function Reference List


Function LDreferenceManipulationClass::convertPositionCoordinatesToString()

Function Summary
namereturn typedescription
convertPositionCoordinatesToStringstringconvert position coordinates to string

Function Arguments
nametypedescription
spriteSceneCoordsconst vec* sprite scene coords

Function Reference List


Function LDreferenceManipulationClass::writeReferencesToFile()

Function Summary
namereturn typedescription
writeReferencesToFileboolwrite references to file

Function Arguments
nametypedescription
fileNameconst string file name
firstReference LDreference* first reference

Function Reference List


Function LDreferenceManipulationClass::addReferenceToFileObject()

Function Summary
namereturn typedescription
addReferenceToFileObjectbooladd reference to file object

Function Arguments
nametypedescription
writeFileObjectofstream* write file object
currentReference LDreference* current reference

Function Reference List


Function LDreferenceManipulationClass::readFileIntoString()

Function Summary
namereturn typedescription
readFileIntoStringboolread file into string

Function Arguments
nametypedescription
fileNameconst string file name
fileContentsString string* file contents string
fileNumberOfLines int* file number of lines
fileByteArraySize int* file byte array size

Function Reference List
N/A


Function LDreferenceManipulationClass::convertRotationMatrixToString()

Function Summary
namereturn typedescription
convertRotationMatrixToStringstringconvert rotation matrix to string

Function Arguments
nametypedescription
rotationMatrixconst mat* rotation matrix

Function Reference List


Function LDreferenceManipulationClass::write2DreferenceListCollapsedTo1DtoFile()

Function Summary
namereturn typedescription
write2DreferenceListCollapsedTo1DtoFileboolwrite 2D reference list collapsed to 1D to file

Function Arguments
nametypedescription
fileNameconst string file name
firstReference LDreference* first reference

Function Reference List


Function LDreferenceManipulationClass::write2DreferencesLayerToFileObject()

Function Summary
namereturn typedescription
write2DreferencesLayerToFileObjectboolwrite 2D references layer to file object

Function Arguments
nametypedescription
writeFileObjectofstream* write file object
firstReferenceInLayer LDreference* first reference in layer

Function Reference List


File LDreferenceClass Documentation

File Name: LDreferenceClass.cpp/.hpp

File Description: LD reference class

File Function List


File Diagram (functions hierarchy)


Class LDreference

Class Data
nametypedescription
relativePositionvecrelative position
absolutePositionvecabsolute position
deformationMatrixmatdeformation matrix
absoluteDeformationMatrixmatabsolute deformation matrix
colouruint32_tcolour
namestringname
nextLDreference*next
vertex1relativePositionvecvertex 1relative position
vertex2relativePositionvecvertex 2relative position
vertex3relativePositionvecvertex 3relative position
vertex4relativePositionvecvertex 4relative position
vertex1absolutePositionvecvertex 1absolute position
vertex2absolutePositionvecvertex 2absolute position
vertex3absolutePositionvecvertex 3absolute position
vertex4absolutePositionvecvertex 4absolute position
relativeColourStringstringrelative colour string
isTopLevelboolis top level
intermediatePositionvecintermediate position
intermediateDeformationMatrixmatintermediate deformation matrix
vertex1intermediatePositionvecvertex 1intermediate position
vertex2intermediatePositionvecvertex 2intermediate position
vertex3intermediatePositionvecvertex 3intermediate position
vertex4intermediatePositionvecvertex 4intermediate position
partAdditionalboolpart additional
partModifiedboolpart modified
partDeletedboolpart deleted
vertex1absolutePositionBackupvecvertex 1absolute position backup
vertex2absolutePositionBackupvecvertex 2absolute position backup
vertex3absolutePositionBackupvecvertex 3absolute position backup
vertex4absolutePositionBackupvecvertex 4absolute position backup
referenceEnabledMethod2DODboolreference enabled method 2DOD
typeinttype
absoluteColouruint32_tabsolute colour
isSubModelReferenceboolis sub model reference
subModelDetailsModelDetails*sub model details
firstReferenceWithinSubModelLDreference*first reference within sub model

Function LDreferenceClassClass::convertLdrawColourToDatFileRGB()

Function Summary
namereturn typedescription
convertLdrawColourToDatFileRGBvoidconvert ldraw colour to dat file RGB

Function Arguments
nametypedescription
dataFileColourconst int data file colour
col colour* col

Function Reference List
N/A


File SHAREDvars Documentation

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 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 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 SHAREDvarsClass::getCurrentDirectory()

Function Summary
namereturn typedescription
getCurrentDirectorystringget current directory

Function Reference List
N/A


Function SHAREDvarsClass::setCurrentDirectory()

Function Summary
namereturn typedescription
setCurrentDirectoryvoidset current directory

Function Arguments
nametypedescription
folderconst string* folder

Function Reference List
N/A


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 SHAREDvarsClass::convertIntToString()

Function Summary
namereturn typedescription
convertIntToStringstringconvert int to string

Function Arguments
nametypedescription
numberconst int number

Function Reference List


Function SHAREDvarsClass::convertUnsignedIntToString()

Function Summary
namereturn typedescription
convertUnsignedIntToStringstringconvert unsigned int to string

Function Arguments
nametypedescription
numberconst int number

Function Reference List


Function SHAREDvarsClass::convertStringToInt()

Function Summary
namereturn typedescription
convertStringToIntintconvert string to int

Function Arguments
nametypedescription
numberconst string number

Function Reference List
N/A


Function SHAREDvarsClass::convertStringToDouble()

Function Summary
namereturn typedescription
convertStringToDoubledoubleconvert string to double

Function Arguments
nametypedescription
numberconst string number

Function Reference List
N/A


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 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 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 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 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 SHAREDvarsClass::getFileContents()

Function Summary
namereturn typedescription
getFileContentsstringget file contents

Function Arguments
nametypedescription
inputFileNameconst string input file name

Function Reference List
N/A


Function SHAREDvarsClass::fileExists()

Function Summary
namereturn typedescription
fileExistsboolfile exists

Function Arguments
nametypedescription
inputFileNameconst string input file name

Function Reference List
N/A


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 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


File SHAREDvector Documentation

File Name: SHAREDvector.cpp/.hpp

File Description: SHARED vector

File Function List


File Diagram (functions hierarchy)


Function SHAREDvectorClass::copyVectors()

Function Summary
namereturn typedescription
copyVectorsvoidcopy vectors

Function Arguments
nametypedescription
vecNewvec* vec new
vecToCopy const vec* vec to copy

Function Reference List
N/A


Function SHAREDvectorClass::copyMatricies()

Function Summary
namereturn typedescription
copyMatriciesvoidcopy matricies

Function Arguments
nametypedescription
matNewmat* mat new
matToCopy const mat* mat to copy

Function Reference List


Function SHAREDvectorClass::multiplyMatricies()

Function Summary
namereturn typedescription
multiplyMatriciesvoidmultiply matricies

Function Arguments
nametypedescription
matNewmat* mat new
mat1 mat* mat 1
mat2 mat* mat 2

Function Reference List
N/A


Function SHAREDvectorClass::addVectors()

Function Summary
namereturn typedescription
addVectorsvoidadd vectors

Function Arguments
nametypedescription
vecNewvec* vec new
a vec* a
b vec* b

Function Reference List
N/A


Function SHAREDvectorClass::createIdentityMatrix()

Function Summary
namereturn typedescription
createIdentityMatrixvoidcreate identity matrix

Function Arguments
nametypedescription
matrixmat* matrix

Function Reference List
N/A


Function SHAREDvectorClass::copyMatrixTwoIntoMatrixOne()

Function Summary
namereturn typedescription
copyMatrixTwoIntoMatrixOnevoidcopy matrix two into matrix one

Function Arguments
nametypedescription
mat1mat* mat 1
mat2 mat* mat 2

Function Reference List
N/A


Function SHAREDvectorClass::scaleMatrix()

Function Summary
namereturn typedescription
scaleMatrixvoidscale matrix

Function Arguments
nametypedescription
matrixmat* matrix
scaleFactor double scale factor

Function Reference List
N/A


File XMLparserClass Documentation

File Name: XMLparserClass.cpp/.hpp

File Description: XML parser class

File Function List


File Diagram (functions hierarchy)


Class XMLparserAttribute

Class Data
nametypedescription
namestringname
valuestringvalue
charCountintchar count
lineCountintline count
nextAttributeXMLparserAttribute*next attribute

Class XMLparserTag

Class Data
nametypedescription
namestringname
valuestringvalue
nextTagXMLparserTag*next tag
firstLowerLevelTagXMLparserTag*first lower level tag
charCountintchar count
lineCountintline count
firstAttributeXMLparserAttribute*first attribute
currentAttributeXMLparserAttribute*current attribute

Function XMLparserClassClass::parseTagDownALevel()

Function Summary
namereturn typedescription
parseTagDownALevelXMLparserTag*parse tag down AL evel

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag
sectionTagName const string section tag name
result bool* result

Function Reference List
N/A


Function XMLparserClassClass::readXMLfile()

Function Summary
namereturn typedescription
readXMLfileboolread XML file

Function Arguments
nametypedescription
xmlFileNameconst string xml file name
firstTagInXMLfile XMLparserTag* first tag in XML file

Function Reference List


Function XMLparserClassClass::parseTagOpen()

Function Summary
namereturn typedescription
parseTagOpenboolparse tag open

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer int tree layer

Function Reference List


Function XMLparserClassClass::parseTagName()

Function Summary
namereturn typedescription
parseTagNameboolparse tag name

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer int tree layer

Function Reference List


Function XMLparserClassClass::parseTagAttributeName()

Function Summary
namereturn typedescription
parseTagAttributeNameboolparse tag attribute name

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer int tree layer

Function Reference List


Function XMLparserClassClass::parseTagAttributeValue()

Function Summary
namereturn typedescription
parseTagAttributeValueboolparse tag attribute value

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer const int tree layer

Function Reference List


Function XMLparserClassClass::parseTagValueAssumingExistenceOfSubtagsAndClose()

Function Summary
namereturn typedescription
parseTagValueAssumingExistenceOfSubtagsAndCloseboolparse tag value assuming existence of subtags and close

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag* current tag
treeLayer int tree layer

Function Reference List


Function XMLparserClassClass::parseTagComment()

Function Summary
namereturn typedescription
parseTagCommentboolparse tag comment

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
type const char type

Function Reference List


Function XMLparserClassClass::processTagClose()

Function Summary
namereturn typedescription
processTagCloseboolprocess tag close

Function Arguments
nametypedescription
parseFileObjectifstream* parse file object
currentTag XMLparserTag** current tag
parentTagName const string parent tag name
isSubTag const bool is sub tag
treeLayer int tree layer
endTagFound const bool end tag found
parsingAttributeName const bool parsing attribute name
tagName const string tag name

Function Reference List


Function XMLparserClassClass::createNewTag()

Function Summary
namereturn typedescription
createNewTagXMLparserTag*create new tag

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag

Function Reference List
N/A


Function XMLparserClassClass::isBlankChar()

Function Summary
namereturn typedescription
isBlankCharboolis blank char

Function Arguments
nametypedescription
parseFileObjectconst ifstream* parse file object
c const char c

Function Reference List
N/A


Function XMLparserClassClass::isBlankCharTabOrNewLine()

Function Summary
namereturn typedescription
isBlankCharTabOrNewLineboolis blank char tab or new line

Function Arguments
nametypedescription
parseFileObjectconst ifstream* parse file object
c const char c

Function Reference List
N/A


Function XMLparserClassClass::throwGenericXMLParseError()

Function Summary
namereturn typedescription
throwGenericXMLParseErrorvoidthrow generic XMLP arse error

Function Reference List
N/A


Function XMLparserClassClass::addTagLayerToFileObject()

Function Summary
namereturn typedescription
addTagLayerToFileObjectbooladd tag layer to file object

Function Arguments
nametypedescription
firstTagInCurrentLayerconst XMLparserTag* first tag in current layer
writeFileString string* write file string
treeLayer const int tree layer

Function Reference List


Function XMLparserClassClass::incrementLineAndAddTabsToFileObject()

Function Summary
namereturn typedescription
incrementLineAndAddTabsToFileObjectvoidincrement line and add tabs to file object

Function Arguments
nametypedescription
writeFileStringstring* write file string
treeLayer const int tree layer

Function Reference List
N/A


Function XMLparserClassClass::addTabsToFileObject()

Function Summary
namereturn typedescription
addTabsToFileObjectvoidadd tabs to file object

Function Arguments
nametypedescription
writeFileStringstring* write file string
treeLayer const int tree layer

Function Reference List
N/A


File CSoperations Documentation

File Name: CSoperations.cpp/.hpp

File Description: CS operations

File Function List


File Diagram (functions hierarchy)


Function CSoperationsClass::getIncludeFileNamesFromCorHfile()

Function Summary
namereturn typedescription
getIncludeFileNamesFromCorHfileboolget include file names from cor hfile

Function Arguments
nametypedescription
firstReferenceInIncludeFileListContainerCSfileContainer* first reference in include file list container
topLevelReferenceContainer constEffective CSfileContainer* top level reference container
aboveLevelObject CSfile* above level object
topLevelReferenceName const string top level reference name
level const int level
parsingCorHfile const bool parsing cor hfile

Function Reference List


Function CSoperationsClass::fileIsHeader()

Function Summary
namereturn typedescription
fileIsHeaderboolfile is header

Function Arguments
nametypedescription
parseFileNamestring parse file name

Function Reference List
N/A


Function CSoperationsClass::findFileObjectInFileObjectContainerList()

Function Summary
namereturn typedescription
findFileObjectInFileObjectContainerListboolfind file object in file object container list

Function Arguments
nametypedescription
firstReferenceContainerInLevelconstEffective CSfileContainer* first reference container in level
fileReferenceName const string file reference name
fileReferenceFound constEffective CSfile** file reference found

Function Reference List


Function CSoperationsClass::getFunctionNamesFromFunctionDeclarationsInHfile()

Function Summary
namereturn typedescription
getFunctionNamesFromFunctionDeclarationsInHfileboolget function names from function declarations in hfile

Function Arguments
nametypedescription
fileObjectCSfile* file object
topLevelFileName const string top level file name
level const int level

Function Reference List


Function CSoperationsClass::getFunctionObjectNamesFromFunctionsInCfile()

Function Summary
namereturn typedescription
getFunctionObjectNamesFromFunctionsInCfilevoidget function object names from functions in cfile

Function Arguments
nametypedescription
firstFileInIncludeFileListconst CSfile* first file in include file list
firstFunctionInFunctionList CSfunction* first function in function list
aboveLevelObject const CSfile* above level object
topLevelFileName const string top level file name
level const int level

Function Reference List


Function CSoperationsClass::searchFunctionStringForFunctionReferencesRecursive()

Function Summary
namereturn typedescription
searchFunctionStringForFunctionReferencesRecursiveboolsearch function string for function references recursive

Function Arguments
nametypedescription
firstFileInIncludeFileListconst CSfile* first file in include file list
firstFileNameInLayerContainingFunctionReferencesToSearchFor const CSfileContainer* first file name in layer containing function references to search for
currentReferenceInFunctionReferenceList CSfunction** current reference in function reference list
currentReferenceInFunctionReferenceListRepeats CSfunction** current reference in function reference list repeats
functionContentsString string* function contents string

Function Reference List


Function CSoperationsClass::searchFunctionStringForFunctionReferencesRecursiveReset()

Function Summary
namereturn typedescription
searchFunctionStringForFunctionReferencesRecursiveResetvoidsearch function string for function references recursive reset

Function Arguments
nametypedescription
firstFileNameInLayerContainingFunctionReferencesToSearchForconst CSfileContainer* first file name in layer containing function references to search for

Function Reference List


Function CSoperationsClass::searchFunctionStringForFunctionReferences()

Function Summary
namereturn typedescription
searchFunctionStringForFunctionReferencesboolsearch function string for function references

Function Arguments
nametypedescription
firstFileInIncludeFileListconst CSfile* first file in include file list
fileNameContainingFunctionReferencesToSearchFor const CSfile* file name containing function references to search for
currentReferenceInFunctionReferenceList CSfunction** current reference in function reference list
currentReferenceInFunctionReferenceListRepeats CSfunction** current reference in function reference list repeats
functionContentsString string* function contents string
currentFile const bool current file

Function Reference List


Function CSoperationsClass::searchFunctionStringForFunctionReference()

Function Summary
namereturn typedescription
searchFunctionStringForFunctionReferenceboolsearch function string for function reference

Function Arguments
nametypedescription
firstFileInIncludeFileListconst CSfile* first file in include file list
currentFunction const CSfunction* current function
functionReferenceToFind const string function reference to find
firstTimeFound bool* first time found
currentReferenceInFunctionReferenceList CSfunction** current reference in function reference list
currentReferenceInFunctionReferenceListRepeats CSfunction** current reference in function reference list repeats
functionContentsString string* function contents string
externalFunction const bool external function

Function Reference List


Function CSoperationsClass::identifyFunctionReferenceArguments()

Function Summary
namereturn typedescription
identifyFunctionReferenceArgumentsvoididentify function reference arguments

Function Arguments
nametypedescription
currentReferenceInFunctionReferenceListCSfunction* current reference in function reference list
functionContentsString string* function contents string
indexToFunctionObject int index to function object
functionReferenceToFind const string function reference to find

Function Reference List


Function CSoperationsClass::removePrependedWhiteSpace()

Function Summary
namereturn typedescription
removePrependedWhiteSpacestringremove prepended white space

Function Arguments
nametypedescription
argumentconst string argument

Function Reference List
N/A


Function CSoperationsClass::identifyFunctionDeclarationArguments()

Function Summary
namereturn typedescription
identifyFunctionDeclarationArgumentsvoididentify function declaration arguments

Function Arguments
nametypedescription
currentReferenceInFunctionReferenceListCSfunction* current reference in function reference list
functionNameFull const string* function name full

Function Reference List


Function CSoperationsClass::generateSourceFileNameFromHeaderFileName()

Function Summary
namereturn typedescription
generateSourceFileNameFromHeaderFileNamestringgenerate source file name from header file name

Function Arguments
nametypedescription
headerFileNameconst string header file name
sourceFileNameExtension const string source file name extension

Function Reference List
N/A


Function CSoperationsClass::generateFileNameBaseFromHeaderFileName()

Function Summary
namereturn typedescription
generateFileNameBaseFromHeaderFileNamestringgenerate file name base from header file name

Function Arguments
nametypedescription
headerFileNameconst string header file name

Function Reference List
N/A


Function CSoperationsClass::attachFunctionReferenceTargets()

Function Summary
namereturn typedescription
attachFunctionReferenceTargetsvoidattach function reference targets

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

Function Reference List


Function CSoperationsClass::extractFunctionArgumentName()

Function Summary
namereturn typedescription
extractFunctionArgumentNamestringextract function argument name

Function Arguments
nametypedescription
argumentTextstring* argument text
indexOfStartOfVariableName const int index of start of variable name

Function Reference List
N/A


Function CSoperationsClass::printLevelIndentation()

Function Summary
namereturn typedescription
printLevelIndentationvoidprint level indentation

Function Arguments
nametypedescription
levelint level

Function Reference List
N/A


Function CSoperationsClass::createParameterList()

Function Summary
namereturn typedescription
createParameterListvectorcreate parameter list

Function Arguments
nametypedescription
functionArgumentsRawconst string* function arguments raw

Function Reference List


File LDsprite Documentation

File Name: LDsprite.cpp/.hpp

File Description: LD sprite

File Function List


File Diagram (functions hierarchy)


Function LDspriteClass::fillInLDspriteExternVariables()

Function Summary
namereturn typedescription
fillInLDspriteExternVariablesvoidfill in LD sprite extern variables

Function Reference List
N/A


Function LDspriteClass::LDaddBasicTextualSpriteStringToReferenceList()

Function Summary
namereturn typedescription
LDaddBasicTextualSpriteStringToReferenceListLDreference*LD add basic textual sprite string to reference list

Function Arguments
nametypedescription
spriteTextStringstring sprite text string
currentReference LDreference* current reference
position vec* position
numSpritesAdded int* num sprites added
addIndividualSprites const bool add individual sprites
colour int colour
scale double scale

Function Reference List


Function LDspriteClass::LDspriteSubmodelFillTextualReference()

Function Summary
namereturn typedescription
LDspriteSubmodelFillTextualReferencevoidLD sprite submodel fill textual reference

Function Arguments
nametypedescription
spriteSubmodelCurrentReferenceLDreference* sprite submodel current reference
spriteParagraphCurrentPosition vec* sprite paragraph current position
characterToWrite const char character to write
spriteColour int sprite colour
scale double scale

Function Reference List


File XMLrulesClass Documentation

File Name: XMLrulesClass.cpp/.hpp

File Description: XML rules class

File Function List


File Diagram (functions hierarchy)


Class XMLrulesClass

Class Data
nametypedescription
namestringname
stringValuestringstring value
fractionalValuedoublefractional value
attribute4intattribute 4
attribute5intattribute 5
attribute6intattribute 6
attribute7intattribute 7
attribute8intattribute 8
nextXMLrulesClass*next

Function XMLrulesClassClass::parseCSrulesXMLfile()

Function Summary
namereturn typedescription
parseCSrulesXMLfileboolparse CS rules XML file

Function Reference List


Function XMLrulesClassClass::parseCSRulesTag()

Function Summary
namereturn typedescription
parseCSRulesTagboolparse CSR ules tag

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag

Function Reference List


Function XMLrulesClassClass::addRulesClassObjectsBasedOnSectionTag()

Function Summary
namereturn typedescription
addRulesClassObjectsBasedOnSectionTagbooladd rules class objects based on section tag

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag
sectionTagName const string section tag name
firstReferenceToObjectClass XMLrulesClass* first reference to object class
tagName const string tag name
numberOfAttributes const int number of attributes
attributeName1 const string attribute name 1
attributeName2 const string attribute name 2
attributeName3 const string attribute name 3
attributeName4 const string attribute name 4
attributeName5 const string attribute name 5
attributeName6 const string attribute name 6
attributeName7 const string attribute name 7
attributeName8 const string attribute name 8

Function Reference List


Function XMLrulesClassClass::addRulesClassObjectBasedOnTag()

Function Summary
namereturn typedescription
addRulesClassObjectBasedOnTagbooladd rules class object based on tag

Function Arguments
nametypedescription
currentTagXMLparserTag* current tag
currentReferenceToObjectClass XMLrulesClass* current reference to object class
tagName const string tag name
numberOfAttributes const int number of attributes
attributeName1 const string attribute name 1
attributeName2 const string attribute name 2
attributeName3 const string attribute name 3
attributeName4 const string attribute name 4
attributeName5 const string attribute name 5
attributeName6 const string attribute name 6
attributeName7 const string attribute name 7
attributeName8 const string attribute name 8

Function Reference List


File CSdraw Documentation

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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 CSdrawClass::fillInCSrulesExternVariables()

Function Summary
namereturn typedescription
fillInCSrulesExternVariablesvoidfill in CS rules extern variables

Function Reference List
N/A


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


File LDsvg Documentation

File Name: LDsvg.cpp/.hpp

File Description: LD svg

File Function List


File Diagram (functions hierarchy)


Function LDsvgClass::writeSVGfile()

Function Summary
namereturn typedescription
writeSVGfileboolwrite SVG file

Function Arguments
nametypedescription
writeFileStringstring* write file string
firstTagInXMLfile const XMLparserTag* first tag in XML file
viewBoxMinX const int view box min X
viewBoxMaxX const int view box max X
viewBoxMinY const int view box min Y
viewBoxMaxY const int view box max Y

Function Reference List


Function LDsvgClass::writeSVGheader()

Function Summary
namereturn typedescription
writeSVGheadervoidwrite SVG header

Function Arguments
nametypedescription
writeFileStringstring* write file string
viewBoxMinX const int view box min X
viewBoxMaxX const int view box max X
viewBoxMinY const int view box min Y
viewBoxMaxY const int view box max Y

Function Reference List


Function LDsvgClass::writeSVGfooter()

Function Summary
namereturn typedescription
writeSVGfootervoidwrite SVG footer

Function Arguments
nametypedescription
writeFileStringstring* write file string

Function Reference List
N/A


Function LDsvgClass::writeSVGboxTransparent()

Function Summary
namereturn typedescription
writeSVGboxTransparentvoidwrite SVG box transparent

Function Arguments
nametypedescription
currentTagXMLparserTag** current tag
pos const vec* pos
width const double width
height const double height
col const int col
boxOutlineWidth const double box outline width
useEllipse const bool use ellipse
fillOpacity const double fill opacity

Function Reference List


Function LDsvgClass::writeSVGbox()

Function Summary
namereturn typedescription
writeSVGboxvoidwrite SVG box

Function Arguments
nametypedescription
currentTagXMLparserTag** current tag
pos const vec* pos
width const double width
height const double height
col const int col
boxOutlineWidth const double box outline width
useEllipse const bool use ellipse

Function Reference List


Function LDsvgClass::writeSVGbox2()

Function Summary
namereturn typedescription
writeSVGbox2voidwrite SVG box 2

Function Arguments
nametypedescription
currentTagXMLparserTag** current tag
pos const vec* pos
width const double width
height const double height
col const int col
boxOutlineWidth const double box outline width
useEllipse const bool use ellipse
transparent bool transparent
fillOpacity const double fill opacity

Function Reference List


Function LDsvgClass::writeSVGbox3()

Function Summary
namereturn typedescription
writeSVGbox3voidwrite SVG box 3

Function Arguments
nametypedescription
currentTagXMLparserTag** current tag
pos const vec* pos
width const double width
height const double height
colourrgb const colour colourrgb
boxOutlineWidth const double box outline width
useEllipse const bool use ellipse
transparent bool transparent
fillOpacity const double fill opacity

Function Reference List


Function LDsvgClass::writeSVGline()

Function Summary
namereturn typedescription
writeSVGlinevoidwrite SVG line

Function Arguments
nametypedescription
currentTagXMLparserTag** current tag
pos1 const vec* pos 1
pos2 const vec* pos 2
colourrgb const colour colourrgb

Function Reference List


Function LDsvgClass::writeSVGtext()

Function Summary
namereturn typedescription
writeSVGtextvoidwrite SVG text

Function Arguments
nametypedescription
currentTagXMLparserTag** current tag
text const string text
pos const vec* pos
fontSize const int font size
col const int col

Function Reference List


Function LDsvgClass::writeSVGtext()

Function Summary
namereturn typedescription
writeSVGtextvoidwrite SVG text

Function Arguments
nametypedescription
currentTagXMLparserTag** current tag
text const string text
pos const vec* pos
fontSize const int font size
col const int col
svgTinySpec bool svg tiny spec

Function Reference List


Function LDsvgClass::writeSVGgroup()

Function Summary
namereturn typedescription
writeSVGgroupXMLparserTag*write SVG group

Function Arguments
nametypedescription
currentTagXMLparserTag** current tag
groupID const string* group ID

Function Reference List
N/A


Function LDsvgClass::writeSVGconnector()

Function Summary
namereturn typedescription
writeSVGconnectorvoidwrite SVG connector

Function Arguments
nametypedescription
currentTagXMLparserTag** current tag
pos1 const vec* pos 1
pos2 const vec* pos 2
col const int col
startGroupID const string* start group ID
endGroupID const string* end group ID
width const double width

Function Reference List


Function LDsvgClass::convertColourRGBtoHexString()

Function Summary
namereturn typedescription
convertColourRGBtoHexStringstringconvert colour RGB to hex string

Function Arguments
nametypedescription
colourRGBconst colour* colour RGB

Function Reference List
N/A


File LDopengl Documentation

File Name: LDopengl.cpp/.hpp

File Description: LD opengl

File Function List


File Diagram (functions hierarchy)


Function LDopenglClass::initiateOpenGL()

Function Summary
namereturn typedescription
initiateOpenGLboolinitiate open GL

Function Arguments
nametypedescription
widthconst int width
height const int height
windowPositionX const int window position X
windowPositionY const int window position Y
confidentialWarnings const bool confidential warnings

Function Reference List
N/A


Function LDopenglClass::exitOpenGL()

Function Summary
namereturn typedescription
exitOpenGLboolexit open GL

Function Reference List
N/A


Function LDopenglClass::setViewPort3Dortho()

Function Summary
namereturn typedescription
setViewPort3Dorthovoidset view port 3D ortho

Function Arguments
nametypedescription
leftconst double left
right const double right
bottom const double bottom
top const double top
back const double back
forward const double forward

Function Reference List
N/A


Function LDopenglClass::drawPrimitivesReferenceListToOpenGLandCreateRGBmapBasic()

Function Summary
namereturn typedescription
drawPrimitivesReferenceListToOpenGLandCreateRGBmapBasicvoiddraw primitives reference list to open GL and create RGB map basic

Function Arguments
nametypedescription
firstReferenceInPrimitivesReferenceListconst LDreference* first reference in primitives reference list
width int width
height const int height
rgbMap uchar* rgb map

Function Reference List


Function LDopenglClass::writeScreenToRGBMap()

Function Summary
namereturn typedescription
writeScreenToRGBMapvoidwrite screen to RGBM ap

Function Arguments
nametypedescription
widthint width
height const int height
rgbMap uchar* rgb map

Function Reference List
N/A


File LDparser Documentation

File Name: LDparser.cpp/.hpp

File Description: LD parser

File Function List


File Diagram (functions hierarchy)


Function LDparserClass::parseFile()

Function Summary
namereturn typedescription
parseFileboolparse file

Function Arguments
nametypedescription
parseFileNamestring parse file name
initialReference LDreference* initial reference
parentReference LDreference* parent reference
recurseIntoPartsDir const bool recurse into parts dir

Function Reference List


Function LDparserClass::calcModXPosBasedUponRotate()

Function Summary
namereturn typedescription
calcModXPosBasedUponRotatedoublecalc mod XP os based upon rotate

Function Arguments
nametypedescription
childRelativePositionconst vec* child relative position
parentReferenceDeformationMatrix const mat* parent reference deformation matrix

Function Reference List
N/A


Function LDparserClass::calcModYPosBasedUponRotate()

Function Summary
namereturn typedescription
calcModYPosBasedUponRotatedoublecalc mod YP os based upon rotate

Function Arguments
nametypedescription
childRelativePositionconst vec* child relative position
parentReferenceDeformationMatrix const mat* parent reference deformation matrix

Function Reference List
N/A


Function LDparserClass::calcModZPosBasedUponRotate()

Function Summary
namereturn typedescription
calcModZPosBasedUponRotatedoublecalc mod ZP os based upon rotate

Function Arguments
nametypedescription
childRelativePositionconst vec* child relative position
parentReferenceDeformationMatrix const mat* parent reference deformation matrix

Function Reference List
N/A


Function LDparserClass::removeWhiteSpaceFromString()

Function Summary
namereturn typedescription
removeWhiteSpaceFromStringstringremove white space from string

Function Arguments
nametypedescription
sconst string s

Function Reference List
N/A


File RTpixelMaps Documentation

File Name: RTpixelMaps.cpp/.hpp

File Description: RT pixel maps

File Function List


File Diagram (functions hierarchy)


Function RTpixelMapsClass::getRGBMapValues()

Function Summary
namereturn typedescription
getRGBMapValuesvoidget RGBM ap values

Function Arguments
nametypedescription
xint x
y int y
imageWidth int image width
rgbMap uchar* rgb map
col colour* col

Function Reference List
N/A


Function RTpixelMapsClass::generatePixmapFromRGBmap()

Function Summary
namereturn typedescription
generatePixmapFromRGBmapvoidgenerate pixmap from RGB map

Function Arguments
nametypedescription
imageFileNameconst string image file name
imageWidth int image width
imageHeight const int image height
rgbMap uchar* rgb map

Function Reference List


Function RTpixelMapsClass::writeImage()

Function Summary
namereturn typedescription
writeImagevoidwrite image

Function Arguments
nametypedescription
imageFileNameconst string image file name
pm pixmap* pm

Function Reference List


File RTppm Documentation

File Name: RTppm.cpp/.hpp

File Description: RT ppm

File Function List


File Diagram (functions hierarchy)


Function RTppmClass::placepointPPM()

Function Summary
namereturn typedescription
placepointPPMvoidplacepoint PPM

Function Arguments
nametypedescription
pmpixmap* pm
x const int x
y const int y
r int r
g int g
b int b

Function Reference List
N/A


Function RTppmClass::newPixmap()

Function Summary
namereturn typedescription
newPixmappixmap*new pixmap

Function Arguments
nametypedescription
wideconst int wide
high const int high

Function Reference List
N/A


Function RTppmClass::writePPM()

Function Summary
namereturn typedescription
writePPMvoidwrite PPM

Function Arguments
nametypedescription
fnameconst string fname
pm const pixmap* pm

Function Reference List
N/A


Function RTppmClass::freePixmap()

Function Summary
namereturn typedescription
freePixmapvoidfree pixmap

Function Arguments
nametypedescription
pmpixmap* pm

Function Reference List
N/A


File CSgenerateHTMLdocumentation Documentation

File Name: CSgenerateHTMLdocumentation.cpp/.hpp

File Description: CS generate HTML documentation

File Function List


File Diagram (functions hierarchy)


Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationFunctions()

Function Summary
namereturn typedescription
generateHTMLdocumentationFunctionsvoidgenerate HTML documentation functions

Function Arguments
nametypedescription
firstTagInSVGFileXMLparserTag* first tag in SVGF ile
firstObjectInTopLevelBelowListContainer CSfileContainer* first object in top level below list container
generateHTMLdocumentationMode int generate HTML documentation mode
useOutputHTMLfile const bool use output HTML file
traceFunctionUpwards const bool trace function upwards
usePredefinedGrid bool use predefined grid
outputHTMLfileName const string output HTML file name

Function Reference List


Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationHeader()

Function Summary
namereturn typedescription
generateHTMLdocumentationHeaderstringgenerate HTML documentation header

Function Arguments
nametypedescription
nameconst string name
htmlHeader const bool html header
isFile const bool is file

Function Reference List


Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationHeader()

Function Summary
namereturn typedescription
generateHTMLdocumentationHeaderstringgenerate HTML documentation header

Function Arguments
nametypedescription
titleNameconst string title name
fileName const string file name
htmlHeader const bool html header
isFile const bool is file

Function Reference List


Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationFooter()

Function Summary
namereturn typedescription
generateHTMLdocumentationFooterstringgenerate HTML documentation footer

Function Arguments
nametypedescription
htmlFileFooterconst bool html file footer

Function Reference List
N/A


Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationForAllFunctions()

Function Summary
namereturn typedescription
generateHTMLdocumentationForAllFunctionsvoidgenerate HTML documentation for all functions

Function Arguments
nametypedescription
firstObjectInAboveLevelBelowListContainerCSfileContainer* first object in above level below list container
currentReferenceInPrintList LDreference* current reference in print list
firstObjectInTopLevelBelowListContainer CSfileContainer* first object in top level below list container
generateHTMLdocumentationMode int generate HTML documentation mode
useOutputHTMLfile const bool use output HTML file
HTMLdocumentationBody string* HTML documentation body
firstTagInSVGFile const XMLparserTag* first tag in SVGF ile
lastTagInSVGFile XMLparserTag* last tag in SVGF ile
traceFunctionUpwards const bool trace function upwards
usePredefinedGrid bool use predefined grid

Function Reference List


Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationForFunction()

Function Summary
namereturn typedescription
generateHTMLdocumentationForFunctionvoidgenerate HTML documentation for function

Function Arguments
nametypedescription
currentReferenceInPrintListLDreference* current reference in print list
firstObjectInTopLevelBelowListContainer CSfileContainer* first object in top level below list container
bottomLevelFunctionToTraceUpwards CSfunction* bottom level function to trace upwards
fileNameHoldingFunction const string file name holding function
currentTag XMLparserTag** current tag
generateHTMLdocumentationMode int generate HTML documentation mode
HTMLdocumentationFunctionBody string* HTML documentation function body
outputSVGfileNameFunction const string* output SVG file name function
useOutputHTMLfile const bool use output HTML file
outputHTMLfileName const string output HTML file name
traceFunctionUpwards const bool trace function upwards

Function Reference List


Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationFunctionSummary()

Function Summary
namereturn typedescription
generateHTMLdocumentationFunctionSummaryvoidgenerate HTML documentation function summary

Function Arguments
nametypedescription
currentFunctionconst CSfunction* current function
HTMLdocumentationFunctionSummary string* HTML documentation function summary

Function Reference List


Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationFunctionInputArguments()

Function Summary
namereturn typedescription
generateHTMLdocumentationFunctionInputArgumentsvoidgenerate HTML documentation function input arguments

Function Arguments
nametypedescription
currentFunctionconst CSfunction* current function
HTMLdocumentationFunctionInputArguments string* HTML documentation function input arguments

Function Reference List


Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationFunctionOrClassArgumentsFromFunctionNameFull()

Function Summary
namereturn typedescription
generateHTMLdocumentationFunctionOrClassArgumentsFromFunctionNameFullvoidgenerate HTML documentation function or class arguments from function name full

Function Arguments
nametypedescription
classDataOrFunctionArgumentsconst bool class data or function arguments
functionNameFull const string* function name full
HTMLdocumentationFunctionInputArguments string* HTML documentation function input arguments

Function Reference List


Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationFunctionOrClassArgumentsFromString()

Function Summary
namereturn typedescription
generateHTMLdocumentationFunctionOrClassArgumentsFromStringvoidgenerate HTML documentation function or class arguments from string

Function Arguments
nametypedescription
classDataOrFunctionArgumentsconst bool class data or function arguments
functionArgumentsRaw const string function arguments raw
HTMLdocumentationFunctionInputArguments string* HTML documentation function input arguments

Function Reference List


Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationFunctionOrClassArgumentsFromParameterList()

Function Summary
namereturn typedescription
generateHTMLdocumentationFunctionOrClassArgumentsFromParameterListvoidgenerate HTML documentation function or class arguments from parameter list

Function Arguments
nametypedescription
classDataOrFunctionArgumentsconst bool class data or function arguments
parameterList vector<CSparameter*>* parameter list
HTMLdocumentationParameterList string* HTML documentation parameter list

Function Reference List


Function CSgenerateHTMLdocumentationClass::ensureHTMLTagSafe()

Function Summary
namereturn typedescription
ensureHTMLTagSafestringensure HTMLT ag safe

Function Arguments
nametypedescription
strconst string str

Function Reference List
N/A


Function CSgenerateHTMLdocumentationClass::createDescriptionFromCaseSensitiveMultiwordString()

Function Summary
namereturn typedescription
createDescriptionFromCaseSensitiveMultiwordStringstringcreate description from case sensitive multiword string

Function Arguments
nametypedescription
strstring str

Function Reference List
N/A


Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationFunctionReferenceList()

Function Summary
namereturn typedescription
generateHTMLdocumentationFunctionReferenceListvoidgenerate HTML documentation function reference list

Function Arguments
nametypedescription
functionCSfunction* function
HTMLdocumentationFunctionReferenceList string* HTML documentation function reference list

Function Reference List


Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationImagePlaceHolder()

Function Summary
namereturn typedescription
generateHTMLdocumentationImagePlaceHolderstringgenerate HTML documentation image place holder

Function Arguments
nametypedescription
traceImageFileNameconst string* trace image file name
imageTitle const string image title

Function Reference List
N/A


Function CSgenerateHTMLdocumentationClass::generateFileDiagramFunctionsHeirachy()

Function Summary
namereturn typedescription
generateFileDiagramFunctionsHeirachyvoidgenerate file diagram functions heirachy

Function Arguments
nametypedescription
currentFileObjectCSfile* current file object
outputSVGFileNameFile const string output SVGF ile name file
firstObjectInTopLevelBelowListContainer CSfileContainer* first object in top level below list container
usePredefinedGrid bool use predefined grid

Function Reference List


Function CSgenerateHTMLdocumentationClass::writeStringPointerToFileObject()

Function Summary
namereturn typedescription
writeStringPointerToFileObjectvoidwrite string pointer to file object

Function Arguments
nametypedescription
sstring* s
writeFileObject ofstream* write file object

Function Reference List
N/A


Function CSgenerateHTMLdocumentationClass::addToHTMLdocumentationFileFunctionList()

Function Summary
namereturn typedescription
addToHTMLdocumentationFileFunctionListvoidadd to HTML documentation file function list

Function Arguments
nametypedescription
currentFunctionObjectCSfunction* current function object
HTMLdocumentationFileFunctionList string* HTML documentation file function list
previousIndentation int* previous indentation
previousIndentationFirst bool* previous indentation first
isFunctionOrFunctionReferenceList const bool is function or function reference list
externalFunction const bool external function

Function Reference List


Function CSgenerateHTMLdocumentationClass::generateClassHTMLdocumentationFromCustomCSclassFormat()

Function Summary
namereturn typedescription
generateClassHTMLdocumentationFromCustomCSclassFormatvoidgenerate class HTML documentation from custom CS class format

Function Reference List


Function CSgenerateHTMLdocumentationClass::getFunctionNameFromFunctionNameFull()

Function Summary
namereturn typedescription
getFunctionNameFromFunctionNameFullstringget function name from function name full

Function Arguments
nametypedescription
functionNameFullconst string* function name full

Function Reference List
N/A


Function CSgenerateHTMLdocumentationClass::generateClassHTMLdocumentationFromCustomCSclassFormat()

Function Summary
namereturn typedescription
generateClassHTMLdocumentationFromCustomCSclassFormatvoidgenerate class HTML documentation from custom CS class format

Function Arguments
nametypedescription
CSclassFileNameconst string CS class file name
CSclassFileContents const vector<string>* CS class file contents

Function Reference List


Function CSgenerateHTMLdocumentationClass::convertIndentedListToHTMLlist()

Function Summary
namereturn typedescription
convertIndentedListToHTMLlistvoidconvert indented list to HTML list

Function Reference List


Function CSgenerateHTMLdocumentationClass::readIndentedListFile()

Function Summary
namereturn typedescription
readIndentedListFileboolread indented list file

Function Arguments
nametypedescription
indentedListFileNameconst string indented list file name
indentedListVector vector<string>* indented list vector

Function Reference List
N/A


Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationIndentedList()

Function Summary
namereturn typedescription
generateHTMLdocumentationIndentedListvoidgenerate HTML documentation indented list

Function Arguments
nametypedescription
indentedListVectorvector<string>* indented list vector
HTMLdocumentationIndentationList string* HTML documentation indentation list

Function Reference List


Function CSgenerateHTMLdocumentationClass::addToHTMLdocumentationIndentedList()

Function Summary
namereturn typedescription
addToHTMLdocumentationIndentedListvoidadd to HTML documentation indented list

Function Arguments
nametypedescription
currentFunctionObjectNameconst string current function object name
currentFunctionObjectIndentation int current function object indentation
HTMLdocumentationFileFunctionList string* HTML documentation file function list
previousIndentation int* previous indentation
previousIndentationFirst bool* previous indentation first

Function Reference List
N/A


Function CSgenerateHTMLdocumentationClass::generateFunctionString()

Function Summary
namereturn typedescription
generateFunctionStringstringgenerate function string

Function Arguments
nametypedescription
currentFunctionconst CSfunction* current function
isFunctionOrFunctionReferenceList const bool is function or function reference list
externalFunction const bool external function

Function Reference List
N/A


File CSgenerateObjectOrientedCode Documentation

File Name: CSgenerateObjectOrientedCode.cpp/.hpp

File Description: CS generate object oriented code

File Function List


File Diagram (functions hierarchy)


Class ReferencedClass

Class Data
nametypedescription
classNamestringclass name
nextReferencedClass*next

Function CSgenerateObjectOrientedCodeClass::generateCPPclasses()

Function Summary
namereturn typedescription
generateCPPclassesboolgenerate CPP classes

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

Function Reference List


Function CSgenerateObjectOrientedCodeClass::generateCPPclassesRecurse()

Function Summary
namereturn typedescription
generateCPPclassesRecurseboolgenerate CPP classes recurse

Function Arguments
nametypedescription
firstObjectInAboveLevelBelowListContainerCSfileContainer* first object in above level below list container
firstObjectInTopLevelBelowListContainer const CSfileContainer* first object in top level below list container

Function Reference List


Function CSgenerateObjectOrientedCodeClass::generateCPPclassesFile()

Function Summary
namereturn typedescription
generateCPPclassesFileboolgenerate CPP classes file

Function Arguments
nametypedescription
currentFileObjectCSfile* current file object
firstObjectInTopLevelBelowListContainer const CSfileContainer* first object in top level below list container

Function Reference List


Function CSgenerateObjectOrientedCodeClass::replaceAllOccurancesOfFunctionObjectReferenceNameInFunction()

Function Summary
namereturn typedescription
replaceAllOccurancesOfFunctionObjectReferenceNameInFunctionstringreplace all occurances of function object reference name in function

Function Arguments
nametypedescription
functionTextOrigconst string* function text orig
functionReferenceName string function reference name
functionReferenceNameUpdated string function reference name updated
foundAtLeastOneInstance bool* found at least one instance

Function Reference List


Function CSgenerateObjectOrientedCodeClass::isFunctionBeingReferencedPublicallyRecurse()

Function Summary
namereturn typedescription
isFunctionBeingReferencedPublicallyRecursevoidis function being referenced publically recurse

Function Arguments
nametypedescription
functionNameconst string function name
fileName const string file name
firstObjectInAboveLevelBelowListContainer const CSfileContainer* first object in above level below list container
foundPublicReference bool* found public reference

Function Reference List


Function CSgenerateObjectOrientedCodeClass::generateClassName()

Function Summary
namereturn typedescription
generateClassNamestringgenerate class name

Function Arguments
nametypedescription
headerFileNameconst string header file name

Function Reference List
N/A


Function CSgenerateObjectOrientedCodeClass::generateClassDeclarationName()

Function Summary
namereturn typedescription
generateClassDeclarationNamestringgenerate class declaration name

Function Arguments
nametypedescription
classNameconst string class name

Function Reference List
N/A


Function CSgenerateObjectOrientedCodeClass::generateClassObjectName()

Function Summary
namereturn typedescription
generateClassObjectNamestringgenerate class object name

Function Arguments
nametypedescription
classNameconst string class name

Function Reference List
N/A


Function CSgenerateObjectOrientedCodeClass::convertFunctionNameToClassFunctionNameSource()

Function Summary
namereturn typedescription
convertFunctionNameToClassFunctionNameSourcestringconvert function name to class function name source

Function Arguments
nametypedescription
fullFunctionNamestring full function name
functionName const string function name
className const string class name
foundPublicReference const bool found public reference
foundStaticReference bool* found static reference

Function Reference List


Function CSgenerateObjectOrientedCodeClass::convertFunctionNameToClassFunctionNameHeader()

Function Summary
namereturn typedescription
convertFunctionNameToClassFunctionNameHeaderstringconvert function name to class function name header

Function Arguments
nametypedescription
fullFunctionNameconst string full function name
functionName const string function name
className const string class name
foundPublicReference const bool found public reference
foundStaticReference const bool found static reference

Function Reference List
N/A


Function CSgenerateObjectOrientedCodeClass::generateReferencedClassesDeclarations()

Function Summary
namereturn typedescription
generateReferencedClassesDeclarationsstringgenerate referenced classes declarations

Function Arguments
nametypedescription
firstReferencedClassInListconst ReferencedClass* first referenced class in list

Function Reference List


Function CSgenerateObjectOrientedCodeClass::findReferencedClassInList()

Function Summary
namereturn typedescription
findReferencedClassInListboolfind referenced class in list

Function Arguments
nametypedescription
firstReferencedClassInListconst ReferencedClass* first referenced class in list
classNameToFind const string class name to find

Function Reference List
N/A


Function CSgenerateObjectOrientedCodeClass::moveIncludeFileStatementsToHeader()

Function Summary
namereturn typedescription
moveIncludeFileStatementsToHeaderboolmove include file statements to header

Function Arguments
nametypedescription
firstReferenceInAboveLevelBelowListCSfile* first reference in above level below list

Function Reference List
N/A


File CSgenerateConstFunctionArgumentCode Documentation

File Name: CSgenerateConstFunctionArgumentCode.cpp/.hpp

File Description: CS generate const function argument code

File Function List


File Diagram (functions hierarchy)


Function CSgenerateConstFunctionArgumentCodeClass::generateConstFunctionArguments()

Function Summary
namereturn typedescription
generateConstFunctionArgumentsboolgenerate const function arguments

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

Function Reference List


Function CSgenerateConstFunctionArgumentCodeClass::generateConstFunctionArgumentsRecurse()

Function Summary
namereturn typedescription
generateConstFunctionArgumentsRecurseboolgenerate const function arguments recurse

Function Arguments
nametypedescription
firstObjectInAboveLevelBelowListContainerCSfileContainer* first object in above level below list container
firstObjectInTopLevelBelowListContainer const CSfileContainer* first object in top level below list container

Function Reference List


Function CSgenerateConstFunctionArgumentCodeClass::generateConstFunctionArgumentsFile()

Function Summary
namereturn typedescription
generateConstFunctionArgumentsFileboolgenerate const function arguments file

Function Arguments
nametypedescription
currentFileObjectCSfile* current file object

Function Reference List


Function CSgenerateConstFunctionArgumentCodeClass::generateConstFunctionArgumentsFunction()

Function Summary
namereturn typedescription
generateConstFunctionArgumentsFunctionboolgenerate const function arguments function

Function Arguments
nametypedescription
currentFunctionObjectCSfunction* current function object

Function Reference List


Function CSgenerateConstFunctionArgumentCodeClass::generateConstFunctionArgumentAndSearchForSecondaryReferences()

Function Summary
namereturn typedescription
generateConstFunctionArgumentAndSearchForSecondaryReferencesboolgenerate const function argument and search for secondary references

Function Arguments
nametypedescription
currentFunctionObjectCSfunction* current function object
currentFunctionArgumentInFunction CSfunctionArgument* current function argument in function
functionDeclarationArgument string function declaration argument

Function Reference List


Function CSgenerateConstFunctionArgumentCodeClass::generateConstFunctionArgument()

Function Summary
namereturn typedescription
generateConstFunctionArgumentboolgenerate const function argument

Function Arguments
nametypedescription
currentFunctionObjectCSfunction* current function object
currentFunctionArgumentInFunction CSfunctionArgument* current function argument in function
functionDeclarationArgument string function declaration argument

Function Reference List


Function CSgenerateConstFunctionArgumentCodeClass::checkIfVariableIsBeingModifiedInFunction()

Function Summary
namereturn typedescription
checkIfVariableIsBeingModifiedInFunctionvoidcheck if variable is being modified in function

Function Arguments
nametypedescription
currentFunctionObjectCSfunction* current function object
currentFunctionArgumentInFunction CSfunctionArgument* current function argument in function
functionDeclarationArgument string function declaration argument
isNotConst bool* is not const
isConstEffective bool* is const effective

Function Reference List


Function CSgenerateConstFunctionArgumentCodeClass::verifyThatVariableIsNotDeclarationOrNextIteratorAssignmentOrArrayIndex()

Function Summary
namereturn typedescription
verifyThatVariableIsNotDeclarationOrNextIteratorAssignmentOrArrayIndexboolverify that variable is not declaration or next iterator assignment or array index

Function Arguments
nametypedescription
currentFunctionObjectconst CSfunction* current function object
functionText const string* function text
textBeforeFunctionArgument const string text before function argument
functionDeclarationArgument const string function declaration argument
indexOfFunctionArgument const int index of function argument
indexOfSquareBracketOpen const int index of square bracket open
indexOfSquareBracketClose const int index of square bracket close
indexOfEndOfCommand const int index of end of command
indexOfStartOfLine const int index of start of line
indexOfEqualsSet const int index of equals set

Function Reference List


Function CSgenerateConstFunctionArgumentCodeClass::functionArgumentReferenceWholeWordCheck()

Function Summary
namereturn typedescription
functionArgumentReferenceWholeWordCheckboolfunction argument reference whole word check

Function Arguments
nametypedescription
functionTextstring* function text
functionDeclarationArgument string function declaration argument
indexOfFunctionArgument int index of function argument

Function Reference List


Function CSgenerateConstFunctionArgumentCodeClass::charInString()

Function Summary
namereturn typedescription
charInStringboolchar in string

Function Arguments
nametypedescription
textconst string text
charArray const char* char array
arraySize const int array size

Function Reference List
N/A


Function CSgenerateConstFunctionArgumentCodeClass::detectDoublePointer()

Function Summary
namereturn typedescription
detectDoublePointerbooldetect double pointer

Function Arguments
nametypedescription
functionArgumentstring function argument

Function Reference List
N/A


Function CSgenerateConstFunctionArgumentCodeClass::detectPointerArray()

Function Summary
namereturn typedescription
detectPointerArraybooldetect pointer array

Function Arguments
nametypedescription
functionArgumentstring function argument

Function Reference List
N/A


Function CSgenerateConstFunctionArgumentCodeClass::extractFullVariableName()

Function Summary
namereturn typedescription
extractFullVariableNamestringextract full variable name

Function Arguments
nametypedescription
functionTextstring* function text
indexOfStartOfVariableName const int index of start of variable name

Function Reference List
N/A


Function CSgenerateConstFunctionArgumentCodeClass::extractFullVariableNameReverse()

Function Summary
namereturn typedescription
extractFullVariableNameReversestringextract full variable name reverse

Function Arguments
nametypedescription
functionTextconst string* function text
indexOfEndOfVariableName const int index of end of variable name
indexOfStartOfVariableName int* index of start of variable name

Function Reference List
N/A


Function CSgenerateConstFunctionArgumentCodeClass::extractFullVariableTypeReverse()

Function Summary
namereturn typedescription
extractFullVariableTypeReversestringextract full variable type reverse

Function Arguments
nametypedescription
functionTextconst string* function text
indexOfEndOfVariableType const int index of end of variable type
indexOfStartOfVariableType int* index of start of variable type

Function Reference List
N/A


Function CSgenerateConstFunctionArgumentCodeClass::addConstToAllOccurancesOfFunctionObjectFunctionArgumentSecondaryAssignmentDeclarationInFunction()

Function Summary
namereturn typedescription
addConstToAllOccurancesOfFunctionObjectFunctionArgumentSecondaryAssignmentDeclarationInFunctionstringadd const to all occurances of function object function argument secondary assignment declaration in function

Function Arguments
nametypedescription
functionTextOrigconst string* function text orig
functionArgumentSecondaryAssignmentName const string function argument secondary assignment name
foundAtLeastOneInstance bool* found at least one instance
constString const string const string

Function Reference List