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
name | return type | description |
main | int | main |
Function Arguments
name | type | description |
argc | const int | argc |
argv | const char** | argv |
Function Reference List
-
- CSgenerateHTMLdocumentationClass::convertIndentedListToHTMLlist
- CSgenerateHTMLdocumentationClass::generateClassHTMLdocumentationFromCustomCSclassFormat
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getCurrentDirectory
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::setCurrentDirectory
- SHAREDvarsClass::argumentExists
- XMLrulesClassClass::parseCSrulesXMLfile
- LDspriteClass::fillInLDspriteExternVariables
- CSdrawClass::fillInCSrulesExternVariables
- CSexecflowClass::generateCodeStructure
File CSexecflow Documentation
File Name: CSexecflow.cpp/.hpp
File Description: CS execflow
File Function List
-
- generateCodeStructure
- initialiseGrid
File Diagram (functions hierarchy)
Function CSexecflowClass::generateCodeStructure()
Function Summary
name | return type | description |
generateCodeStructure | void | generate code structure |
Function Arguments
name | type | description |
topLevelFileName | const 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
-
-
- LDopenglClass::initiateOpenGL
- CSoperationsClass::getIncludeFileNamesFromCorHfile
- CSoperationsClass::attachFunctionReferenceTargets
- CSdrawClass::initiateMaxXatParticularY
- SHAREDvarsClass::setCurrentDirectory
- initialiseGrid
- CSdrawClass::createFileObjectListBoxes
- CSdrawClass::createFileObjectListConnections
- CSdrawClass::createFileObjectListBoxesPrintedReset
- LDsvgClass::writeSVGfile
- CSdrawClass::createFileObjectListBoxes
- CSdrawClass::createFileObjectListConnections
- CSdrawClass::createFunctionObjectListBoxesAndConnections
- CSdrawClass::createFunctionObjectListBoxesAndConnections
- CSdrawClass::resetPrintedFunctionConnections
- LDsvgClass::writeSVGfile
- CSdrawClass::findPrintedFunctionObjectWithName
- CSgenerateHTMLdocumentationClass::generateHTMLdocumentationForFunction
- CSgenerateHTMLdocumentationClass::generateHTMLdocumentationFunctions
- CSgenerateObjectOrientedCodeClass::generateCPPclasses
- CSgenerateConstFunctionArgumentCodeClass::generateConstFunctionArguments
- LDsvgClass::writeSVGfile
- LDreferenceManipulationClass::writeReferencesToFile
- LDparserClass::parseFile
- LDreferenceManipulationClass::write2DreferenceListCollapsedTo1DtoFile
- LDopenglClass::setViewPort3Dortho
- LDparserClass::parseFile
- LDopenglClass::drawPrimitivesReferenceListToOpenGLandCreateRGBmapBasic
- LDopenglClass::drawPrimitivesReferenceListToOpenGLandCreateRGBmapBasic
- RTpixelMapsClass::generatePixmapFromRGBmap
- LDopenglClass::exitOpenGL
Function CSexecflowClass::initialiseGrid()
Function Summary
name | return type | description |
initialiseGrid | bool | initialise grid |
Function Arguments
name | type | description |
firstTagInGridTag | XMLparserTag** | first tag in grid tag |
Function Reference List
-
- XMLparserClassClass::parseTagDownALevel
-
-
- XMLparserClassClass::parseTagDownALevel
- SHAREDvarsClass::convertStringToInt
- SHAREDvarsClass::convertStringToInt
-
- SHAREDvarsClass::convertStringToInt
- SHAREDvarsClass::convertStringToInt
File CSreferenceContainerClass Documentation
File Name: CSreferenceContainerClass.cpp/.hpp
File Description: CS reference container class
File Function List
-
- findEndPositionOfArgument
- findFunctionReferenceTarget
- findFunctionReferenceTargetRecurse
- findFunctionReferenceTargetRecurseReset
File Diagram (functions hierarchy)
Class CSfunctionContainer
Class Data
name | type | description |
next | CSfunctionContainer* | next |
previous | CSfunctionContainer* | previous |
functionObject | CSfunction* | function object |
fileObjectHoldingFunction | CSfile* | file object holding function |
Class CSfileContainer
Class Data
name | type | description |
next | CSfileContainer* | next |
previous | CSfileContainer* | previous |
fileObject | CSfile* | file object |
aboveLevelObject | CSfile* | above level object |
Function CSreferenceContainerClassClass::findEndPositionOfArgument()
Function Summary
name | return type | description |
findEndPositionOfArgument | int | find end position of argument |
Function Arguments
name | type | description |
functionArgumentsRaw | const 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
name | return type | description |
findFunctionReferenceTarget | bool | find function reference target |
Function Arguments
name | type | description |
functionReference | const 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
-
- countArgumentList
-
- findFunctionReferenceTargetRecurse
- findFunctionReferenceTargetRecurseReset
Function CSreferenceContainerClassClass::findFunctionReferenceTargetRecurse()
Function Summary
name | return type | description |
findFunctionReferenceTargetRecurse | bool | find function reference target recurse |
Function Arguments
name | type | description |
functionReference | const 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
-
- countArgumentList
-
-
-
- findFunctionReferenceTargetRecurse
Function CSreferenceContainerClassClass::countArgumentList()
Function Summary
name | return type | description |
countArgumentList | int | count argument list |
Function Arguments
name | type | description |
firstFunctionArgumentInFunction | const CSfunctionArgument* | first function argument in function |
Function Reference List
N/A
Function CSreferenceContainerClassClass::findFunctionReferenceTargetRecurseReset()
Function Summary
name | return type | description |
findFunctionReferenceTargetRecurseReset | void | find function reference target recurse reset |
Function Arguments
name | type | description |
firstObjectInAboveLevelBelowListContainer | constEffective CSfileContainer* | first object in above level below list container |
Function Reference List
-
-
-
-
- findFunctionReferenceTargetRecurseReset
File LDreferenceManipulation Documentation
File Name: LDreferenceManipulation.cpp/.hpp
File Description: LD reference manipulation
File Function List
-
- copyReferences
- convertPositionCoordinatesToString
- writeReferencesToFile
- addReferenceToFileObject
- readFileIntoString
- convertRotationMatrixToString
- write2DreferenceListCollapsedTo1DtoFile
- write2DreferencesLayerToFileObject
File Diagram (functions hierarchy)
Function LDreferenceManipulationClass::copyReferences()
Function Summary
name | return type | description |
copyReferences | void | copy references |
Function Arguments
name | type | description |
referenceNew | LDreference* | reference new |
referenceToCopy | LDreference* | reference to copy |
type | const int | type |
Function Reference List
-
-
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyMatricies
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyVectors
Function LDreferenceManipulationClass::convertPositionCoordinatesToString()
Function Summary
name | return type | description |
convertPositionCoordinatesToString | string | convert position coordinates to string |
Function Arguments
name | type | description |
spriteSceneCoords | const vec* | sprite scene coords |
Function Reference List
-
- SHAREDvarsClass::sprintfSafeDouble
- SHAREDvarsClass::sprintfSafeDouble
- SHAREDvarsClass::sprintfSafeDouble
Function LDreferenceManipulationClass::writeReferencesToFile()
Function Summary
name | return type | description |
writeReferencesToFile | bool | write references to file |
Function Arguments
name | type | description |
fileName | const string | file name |
firstReference | LDreference* | first reference |
Function Reference List
Function LDreferenceManipulationClass::addReferenceToFileObject()
Function Summary
name | return type | description |
addReferenceToFileObject | bool | add reference to file object |
Function Arguments
name | type | description |
writeFileObject | ofstream* | write file object |
currentReference | LDreference* | current reference |
Function Reference List
-
-
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertUnsignedIntToString
- convertPositionCoordinatesToString
- SHAREDvectorClass::copyMatrixTwoIntoMatrixOne
- convertRotationMatrixToString
- convertPositionCoordinatesToString
- convertPositionCoordinatesToString
- convertPositionCoordinatesToString
- convertPositionCoordinatesToString
Function LDreferenceManipulationClass::readFileIntoString()
Function Summary
name | return type | description |
readFileIntoString | bool | read file into string |
Function Arguments
name | type | description |
fileName | const 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
name | return type | description |
convertRotationMatrixToString | string | convert rotation matrix to string |
Function Arguments
name | type | description |
rotationMatrix | const mat* | rotation matrix |
Function Reference List
-
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
Function LDreferenceManipulationClass::write2DreferenceListCollapsedTo1DtoFile()
Function Summary
name | return type | description |
write2DreferenceListCollapsedTo1DtoFile | bool | write 2D reference list collapsed to 1D to file |
Function Arguments
name | type | description |
fileName | const string | file name |
firstReference | LDreference* | first reference |
Function Reference List
-
- write2DreferencesLayerToFileObject
Function LDreferenceManipulationClass::write2DreferencesLayerToFileObject()
Function Summary
name | return type | description |
write2DreferencesLayerToFileObject | bool | write 2D references layer to file object |
Function Arguments
name | type | description |
writeFileObject | ofstream* | write file object |
firstReferenceInLayer | LDreference* | first reference in layer |
Function Reference List
-
-
-
- write2DreferencesLayerToFileObject
- copyReferences
- SHAREDvectorClass::copyMatricies
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyVectors
File LDreferenceClass Documentation
File Name: LDreferenceClass.cpp/.hpp
File Description: LD reference class
File Function List
-
- convertLdrawColourToDatFileRGB
File Diagram (functions hierarchy)
Class LDreference
Class Data
name | type | description |
relativePosition | vec | relative position |
absolutePosition | vec | absolute position |
deformationMatrix | mat | deformation matrix |
absoluteDeformationMatrix | mat | absolute deformation matrix |
colour | uint32_t | colour |
name | string | name |
next | LDreference* | next |
vertex1relativePosition | vec | vertex 1relative position |
vertex2relativePosition | vec | vertex 2relative position |
vertex3relativePosition | vec | vertex 3relative position |
vertex4relativePosition | vec | vertex 4relative position |
vertex1absolutePosition | vec | vertex 1absolute position |
vertex2absolutePosition | vec | vertex 2absolute position |
vertex3absolutePosition | vec | vertex 3absolute position |
vertex4absolutePosition | vec | vertex 4absolute position |
relativeColourString | string | relative colour string |
isTopLevel | bool | is top level |
intermediatePosition | vec | intermediate position |
intermediateDeformationMatrix | mat | intermediate deformation matrix |
vertex1intermediatePosition | vec | vertex 1intermediate position |
vertex2intermediatePosition | vec | vertex 2intermediate position |
vertex3intermediatePosition | vec | vertex 3intermediate position |
vertex4intermediatePosition | vec | vertex 4intermediate position |
partAdditional | bool | part additional |
partModified | bool | part modified |
partDeleted | bool | part deleted |
vertex1absolutePositionBackup | vec | vertex 1absolute position backup |
vertex2absolutePositionBackup | vec | vertex 2absolute position backup |
vertex3absolutePositionBackup | vec | vertex 3absolute position backup |
vertex4absolutePositionBackup | vec | vertex 4absolute position backup |
referenceEnabledMethod2DOD | bool | reference enabled method 2DOD |
type | int | type |
absoluteColour | uint32_t | absolute colour |
isSubModelReference | bool | is sub model reference |
subModelDetails | ModelDetails* | sub model details |
firstReferenceWithinSubModel | LDreference* | first reference within sub model |
Function LDreferenceClassClass::convertLdrawColourToDatFileRGB()
Function Summary
name | return type | description |
convertLdrawColourToDatFileRGB | void | convert ldraw colour to dat file RGB |
Function Arguments
name | type | description |
dataFileColour | const 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
-
- argumentExists
- getFloatArgument
- getStringArgument
- getCurrentDirectory
- convertDoubleToString
- convertIntToString
- convertUnsignedIntToString
- convertStringToInt
- convertStringToDouble
- textInTextArray
- charInCharArray
- replaceAllOccurancesOfString
- replaceAllOccurancesOfString
- writeStringToFile
- getFileContents
- fileExists
- sprintfSafeDouble
- sprintfSafeInt
File Diagram (functions hierarchy)
Function SHAREDvarsClass::argumentExists()
Function Summary
name | return type | description |
argumentExists | bool | argument exists |
Function Arguments
name | type | description |
argc | const int | argc |
argv | const char** | argv |
keystr | const string | keystr |
Function Reference List
N/A
Function SHAREDvarsClass::getFloatArgument()
Function Summary
name | return type | description |
getFloatArgument | float | get float argument |
Function Arguments
name | type | description |
argc | const int | argc |
argv | const char** | argv |
keystr | const string | keystr |
Function Reference List
N/A
Function SHAREDvarsClass::getStringArgument()
Function Summary
name | return type | description |
getStringArgument | string | get string argument |
Function Arguments
name | type | description |
argc | const int | argc |
argv | const char** | argv |
keystr | const string | keystr |
Function Reference List
N/A
Function SHAREDvarsClass::getCurrentDirectory()
Function Summary
name | return type | description |
getCurrentDirectory | string | get current directory |
Function Reference List
N/A
Function SHAREDvarsClass::setCurrentDirectory()
Function Summary
name | return type | description |
setCurrentDirectory | void | set current directory |
Function Arguments
name | type | description |
folder | const string* | folder |
Function Reference List
N/A
Function SHAREDvarsClass::convertDoubleToString()
Function Summary
name | return type | description |
convertDoubleToString | string | convert double to string |
Function Arguments
name | type | description |
number | const double | number |
format | const string | format |
Function Reference List
Function SHAREDvarsClass::convertIntToString()
Function Summary
name | return type | description |
convertIntToString | string | convert int to string |
Function Arguments
name | type | description |
number | const int | number |
Function Reference List
Function SHAREDvarsClass::convertUnsignedIntToString()
Function Summary
name | return type | description |
convertUnsignedIntToString | string | convert unsigned int to string |
Function Arguments
name | type | description |
number | const int | number |
Function Reference List
Function SHAREDvarsClass::convertStringToInt()
Function Summary
name | return type | description |
convertStringToInt | int | convert string to int |
Function Arguments
name | type | description |
number | const string | number |
Function Reference List
N/A
Function SHAREDvarsClass::convertStringToDouble()
Function Summary
name | return type | description |
convertStringToDouble | double | convert string to double |
Function Arguments
name | type | description |
number | const string | number |
Function Reference List
N/A
Function SHAREDvarsClass::textInTextArray()
Function Summary
name | return type | description |
textInTextArray | bool | text in text array |
Function Arguments
name | type | description |
text | const 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
name | return type | description |
charInCharArray | bool | char in char array |
Function Arguments
name | type | description |
c | const char | c |
charArray | const char* | char array |
arraySize | const int | array size |
Function Reference List
N/A
Function SHAREDvarsClass::replaceAllOccurancesOfString()
Function Summary
name | return type | description |
replaceAllOccurancesOfString | string | replace all occurances of string |
Function Arguments
name | type | description |
textOrig | const string* | text orig |
stringToFind | string | string to find |
replacementString | string | replacement string |
Function Reference List
-
- replaceAllOccurancesOfString
Function SHAREDvarsClass::replaceAllOccurancesOfString()
Function Summary
name | return type | description |
replaceAllOccurancesOfString | string | replace all occurances of string |
Function Arguments
name | type | description |
textOrig | const 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
name | return type | description |
writeStringToFile | void | write string to file |
Function Arguments
name | type | description |
fileName | const string | file name |
s | string* | s |
Function Reference List
N/A
Function SHAREDvarsClass::getFileContents()
Function Summary
name | return type | description |
getFileContents | string | get file contents |
Function Arguments
name | type | description |
inputFileName | const string | input file name |
Function Reference List
N/A
Function SHAREDvarsClass::fileExists()
Function Summary
name | return type | description |
fileExists | bool | file exists |
Function Arguments
name | type | description |
inputFileName | const string | input file name |
Function Reference List
N/A
Function SHAREDvarsClass::sprintfSafeDouble()
Function Summary
name | return type | description |
sprintfSafeDouble | void | sprintf safe double |
Function Arguments
name | type | description |
stringCharStar | char* | string char star |
type | const char* | type |
number | double | number |
Function Reference List
N/A
Function SHAREDvarsClass::sprintfSafeInt()
Function Summary
name | return type | description |
sprintfSafeInt | void | sprintf safe int |
Function Arguments
name | type | description |
stringCharStar | char* | 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
-
- copyVectors
- copyMatricies
- multiplyMatricies
- addVectors
- createIdentityMatrix
- copyMatrixTwoIntoMatrixOne
- scaleMatrix
File Diagram (functions hierarchy)
Function SHAREDvectorClass::copyVectors()
Function Summary
name | return type | description |
copyVectors | void | copy vectors |
Function Arguments
name | type | description |
vecNew | vec* | vec new |
vecToCopy | const vec* | vec to copy |
Function Reference List
N/A
Function SHAREDvectorClass::copyMatricies()
Function Summary
name | return type | description |
copyMatricies | void | copy matricies |
Function Arguments
name | type | description |
matNew | mat* | mat new |
matToCopy | const mat* | mat to copy |
Function Reference List
-
- copyVectors
- copyVectors
- copyVectors
Function SHAREDvectorClass::multiplyMatricies()
Function Summary
name | return type | description |
multiplyMatricies | void | multiply matricies |
Function Arguments
name | type | description |
matNew | mat* | mat new |
mat1 | mat* | mat 1 |
mat2 | mat* | mat 2 |
Function Reference List
N/A
Function SHAREDvectorClass::addVectors()
Function Summary
name | return type | description |
addVectors | void | add vectors |
Function Arguments
name | type | description |
vecNew | vec* | vec new |
a | vec* | a |
b | vec* | b |
Function Reference List
N/A
Function SHAREDvectorClass::createIdentityMatrix()
Function Summary
name | return type | description |
createIdentityMatrix | void | create identity matrix |
Function Arguments
name | type | description |
matrix | mat* | matrix |
Function Reference List
N/A
Function SHAREDvectorClass::copyMatrixTwoIntoMatrixOne()
Function Summary
name | return type | description |
copyMatrixTwoIntoMatrixOne | void | copy matrix two into matrix one |
Function Arguments
name | type | description |
mat1 | mat* | mat 1 |
mat2 | mat* | mat 2 |
Function Reference List
N/A
Function SHAREDvectorClass::scaleMatrix()
Function Summary
name | return type | description |
scaleMatrix | void | scale matrix |
Function Arguments
name | type | description |
matrix | mat* | 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
-
- parseTagDownALevel
- readXMLfile
- parseTagOpen
- parseTagName
- parseTagAttributeName
- parseTagValueAssumingExistenceOfSubtagsAndClose
- parseTagComment
- processTagClose
- createNewTag
- isBlankChar
- isBlankCharTabOrNewLine
- throwGenericXMLParseError
- addTagLayerToFileObject
- incrementLineAndAddTabsToFileObject
- addTabsToFileObject
File Diagram (functions hierarchy)
Class XMLparserAttribute
Class Data
name | type | description |
name | string | name |
value | string | value |
charCount | int | char count |
lineCount | int | line count |
nextAttribute | XMLparserAttribute* | next attribute |
Class XMLparserTag
Class Data
name | type | description |
name | string | name |
value | string | value |
nextTag | XMLparserTag* | next tag |
firstLowerLevelTag | XMLparserTag* | first lower level tag |
charCount | int | char count |
lineCount | int | line count |
firstAttribute | XMLparserAttribute* | first attribute |
currentAttribute | XMLparserAttribute* | current attribute |
Function XMLparserClassClass::parseTagDownALevel()
Function Summary
name | return type | description |
parseTagDownALevel | XMLparserTag* | parse tag down AL evel |
Function Arguments
name | type | description |
currentTag | XMLparserTag* | current tag |
sectionTagName | const string | section tag name |
result | bool* | result |
Function Reference List
N/A
Function XMLparserClassClass::readXMLfile()
Function Summary
name | return type | description |
readXMLfile | bool | read XML file |
Function Arguments
name | type | description |
xmlFileName | const string | xml file name |
firstTagInXMLfile | XMLparserTag* | first tag in XML file |
Function Reference List
Function XMLparserClassClass::parseTagOpen()
Function Summary
name | return type | description |
parseTagOpen | bool | parse tag open |
Function Arguments
name | type | description |
parseFileObject | ifstream* | 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
-
-
-
- parseTagName
- isBlankChar
- throwGenericXMLParseError
Function XMLparserClassClass::parseTagName()
Function Summary
name | return type | description |
parseTagName | bool | parse tag name |
Function Arguments
name | type | description |
parseFileObject | ifstream* | 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
-
-
-
-
- parseTagComment
- parseTagOpen
- isBlankChar
-
- parseTagAttributeName
- throwGenericXMLParseError
- throwGenericXMLParseError
- throwGenericXMLParseError
- throwGenericXMLParseError
- processTagClose
Function XMLparserClassClass::parseTagAttributeName()
Function Summary
name | return type | description |
parseTagAttributeName | bool | parse tag attribute name |
Function Arguments
name | type | description |
parseFileObject | ifstream* | 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
-
-
- isBlankChar
-
- throwGenericXMLParseError
- throwGenericXMLParseError
- throwGenericXMLParseError
- processTagClose
- parseTagAttributeValue
- throwGenericXMLParseError
Function XMLparserClassClass::parseTagAttributeValue()
Function Summary
name | return type | description |
parseTagAttributeValue | bool | parse tag attribute value |
Function Arguments
name | type | description |
parseFileObject | ifstream* | 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
-
-
- isBlankChar
- throwGenericXMLParseError
- throwGenericXMLParseError
Function XMLparserClassClass::parseTagValueAssumingExistenceOfSubtagsAndClose()
Function Summary
name | return type | description |
parseTagValueAssumingExistenceOfSubtagsAndClose | bool | parse tag value assuming existence of subtags and close |
Function Arguments
name | type | description |
parseFileObject | ifstream* | parse file object |
currentTag | XMLparserTag* | current tag |
treeLayer | int | tree layer |
Function Reference List
Function XMLparserClassClass::parseTagComment()
Function Summary
name | return type | description |
parseTagComment | bool | parse tag comment |
Function Arguments
name | type | description |
parseFileObject | ifstream* | parse file object |
type | const char | type |
Function Reference List
-
-
-
-
-
-
- throwGenericXMLParseError
- throwGenericXMLParseError
- throwGenericXMLParseError
-
- throwGenericXMLParseError
Function XMLparserClassClass::processTagClose()
Function Summary
name | return type | description |
processTagClose | bool | process tag close |
Function Arguments
name | type | description |
parseFileObject | ifstream* | 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
-
-
-
- parseTagValueAssumingExistenceOfSubtagsAndClose
- createNewTag
- parseTagOpen
-
-
- throwGenericXMLParseError
- createNewTag
- parseTagOpen
- throwGenericXMLParseError
- parseTagValueAssumingExistenceOfSubtagsAndClose
- createNewTag
- parseTagOpen
Function XMLparserClassClass::createNewTag()
Function Summary
name | return type | description |
createNewTag | XMLparserTag* | create new tag |
Function Arguments
name | type | description |
currentTag | XMLparserTag* | current tag |
Function Reference List
N/A
Function XMLparserClassClass::isBlankChar()
Function Summary
name | return type | description |
isBlankChar | bool | is blank char |
Function Arguments
name | type | description |
parseFileObject | const ifstream* | parse file object |
c | const char | c |
Function Reference List
N/A
Function XMLparserClassClass::isBlankCharTabOrNewLine()
Function Summary
name | return type | description |
isBlankCharTabOrNewLine | bool | is blank char tab or new line |
Function Arguments
name | type | description |
parseFileObject | const ifstream* | parse file object |
c | const char | c |
Function Reference List
N/A
Function XMLparserClassClass::throwGenericXMLParseError()
Function Summary
name | return type | description |
throwGenericXMLParseError | void | throw generic XMLP arse error |
Function Reference List
N/A
Function XMLparserClassClass::addTagLayerToFileObject()
Function Summary
name | return type | description |
addTagLayerToFileObject | bool | add tag layer to file object |
Function Arguments
name | type | description |
firstTagInCurrentLayer | const XMLparserTag* | first tag in current layer |
writeFileString | string* | write file string |
treeLayer | const int | tree layer |
Function Reference List
-
-
- incrementLineAndAddTabsToFileObject
-
- addTagLayerToFileObject
- addTabsToFileObject
- incrementLineAndAddTabsToFileObject
Function XMLparserClassClass::incrementLineAndAddTabsToFileObject()
Function Summary
name | return type | description |
incrementLineAndAddTabsToFileObject | void | increment line and add tabs to file object |
Function Arguments
name | type | description |
writeFileString | string* | write file string |
treeLayer | const int | tree layer |
Function Reference List
N/A
Function XMLparserClassClass::addTabsToFileObject()
Function Summary
name | return type | description |
addTabsToFileObject | void | add tabs to file object |
Function Arguments
name | type | description |
writeFileString | string* | 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
-
- getIncludeFileNamesFromCorHfile
- fileIsHeader
- findFileObjectInFileObjectContainerList
- getFunctionNamesFromFunctionDeclarationsInHfile
- getFunctionObjectNamesFromFunctionsInCfile
- searchFunctionStringForFunctionReferencesRecursive
- searchFunctionStringForFunctionReferencesRecursiveReset
- searchFunctionStringForFunctionReferences
- searchFunctionStringForFunctionReference
- identifyFunctionReferenceArguments
- removePrependedWhiteSpace
- identifyFunctionDeclarationArguments
- generateSourceFileNameFromHeaderFileName
- generateFileNameBaseFromHeaderFileName
- attachFunctionReferenceTargets
- extractFunctionArgumentName
- printLevelIndentation
- createParameterList
File Diagram (functions hierarchy)
Function CSoperationsClass::getIncludeFileNamesFromCorHfile()
Function Summary
name | return type | description |
getIncludeFileNamesFromCorHfile | bool | get include file names from cor hfile |
Function Arguments
name | type | description |
firstReferenceInIncludeFileListContainer | CSfileContainer* | 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
-
-
-
-
-
-
- fileIsHeader
- SHAREDvarsClass::fileExists
- findFileObjectInFileObjectContainerList
- generateSourceFileNameFromHeaderFileName
- generateSourceFileNameFromHeaderFileName
- generateSourceFileNameFromHeaderFileName
- SHAREDvarsClass::getFileContents
- SHAREDvarsClass::getFileContents
- generateFileNameBaseFromHeaderFileName
- printLevelIndentation
- printLevelIndentation
- getIncludeFileNamesFromCorHfile
- getIncludeFileNamesFromCorHfile
- getFunctionNamesFromFunctionDeclarationsInHfile
- getFunctionObjectNamesFromFunctionsInCfile
Function CSoperationsClass::fileIsHeader()
Function Summary
name | return type | description |
fileIsHeader | bool | file is header |
Function Arguments
name | type | description |
parseFileName | string | parse file name |
Function Reference List
N/A
Function CSoperationsClass::findFileObjectInFileObjectContainerList()
Function Summary
name | return type | description |
findFileObjectInFileObjectContainerList | bool | find file object in file object container list |
Function Arguments
name | type | description |
firstReferenceContainerInLevel | constEffective CSfileContainer* | first reference container in level |
fileReferenceName | const string | file reference name |
fileReferenceFound | constEffective CSfile** | file reference found |
Function Reference List
-
-
-
-
- findFileObjectInFileObjectContainerList
Function CSoperationsClass::getFunctionNamesFromFunctionDeclarationsInHfile()
Function Summary
name | return type | description |
getFunctionNamesFromFunctionDeclarationsInHfile | bool | get function names from function declarations in hfile |
Function Arguments
name | type | description |
fileObject | CSfile* | file object |
topLevelFileName | const string | top level file name |
level | const int | level |
Function Reference List
-
-
-
-
-
-
- SHAREDvarsClass::textInTextArray
- createParameterList
- identifyFunctionDeclarationArguments
Function CSoperationsClass::getFunctionObjectNamesFromFunctionsInCfile()
Function Summary
name | return type | description |
getFunctionObjectNamesFromFunctionsInCfile | void | get function object names from functions in cfile |
Function Arguments
name | type | description |
firstFileInIncludeFileList | const 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
-
- LDreferenceManipulationClass::readFileIntoString
-
-
-
- searchFunctionStringForFunctionReferences
- searchFunctionStringForFunctionReferencesRecursive
- searchFunctionStringForFunctionReferencesRecursiveReset
Function CSoperationsClass::searchFunctionStringForFunctionReferencesRecursive()
Function Summary
name | return type | description |
searchFunctionStringForFunctionReferencesRecursive | bool | search function string for function references recursive |
Function Arguments
name | type | description |
firstFileInIncludeFileList | const 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
-
-
-
- searchFunctionStringForFunctionReferences
- searchFunctionStringForFunctionReferencesRecursive
Function CSoperationsClass::searchFunctionStringForFunctionReferencesRecursiveReset()
Function Summary
name | return type | description |
searchFunctionStringForFunctionReferencesRecursiveReset | void | search function string for function references recursive reset |
Function Arguments
name | type | description |
firstFileNameInLayerContainingFunctionReferencesToSearchFor | const CSfileContainer* | first file name in layer containing function references to search for |
Function Reference List
-
-
-
-
- searchFunctionStringForFunctionReferencesRecursiveReset
Function CSoperationsClass::searchFunctionStringForFunctionReferences()
Function Summary
name | return type | description |
searchFunctionStringForFunctionReferences | bool | search function string for function references |
Function Arguments
name | type | description |
firstFileInIncludeFileList | const 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
-
-
-
-
- searchFunctionStringForFunctionReference
-
- searchFunctionStringForFunctionReference
- searchFunctionStringForFunctionReference
- searchFunctionStringForFunctionReference
Function CSoperationsClass::searchFunctionStringForFunctionReference()
Function Summary
name | return type | description |
searchFunctionStringForFunctionReference | bool | search function string for function reference |
Function Arguments
name | type | description |
firstFileInIncludeFileList | const 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
-
-
- SHAREDvarsClass::charInCharArray
-
- identifyFunctionReferenceArguments
- identifyFunctionReferenceArguments
Function CSoperationsClass::identifyFunctionReferenceArguments()
Function Summary
name | return type | description |
identifyFunctionReferenceArguments | void | identify function reference arguments |
Function Arguments
name | type | description |
currentReferenceInFunctionReferenceList | CSfunction* | 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
-
-
-
-
-
- removePrependedWhiteSpace
Function CSoperationsClass::removePrependedWhiteSpace()
Function Summary
name | return type | description |
removePrependedWhiteSpace | string | remove prepended white space |
Function Arguments
name | type | description |
argument | const string | argument |
Function Reference List
N/A
Function CSoperationsClass::identifyFunctionDeclarationArguments()
Function Summary
name | return type | description |
identifyFunctionDeclarationArguments | void | identify function declaration arguments |
Function Arguments
name | type | description |
currentReferenceInFunctionReferenceList | CSfunction* | current reference in function reference list |
functionNameFull | const string* | function name full |
Function Reference List
-
-
-
- CSreferenceContainerClassClass::findEndPositionOfArgument
- removePrependedWhiteSpace
- extractFunctionArgumentName
Function CSoperationsClass::generateSourceFileNameFromHeaderFileName()
Function Summary
name | return type | description |
generateSourceFileNameFromHeaderFileName | string | generate source file name from header file name |
Function Arguments
name | type | description |
headerFileName | const string | header file name |
sourceFileNameExtension | const string | source file name extension |
Function Reference List
N/A
Function CSoperationsClass::generateFileNameBaseFromHeaderFileName()
Function Summary
name | return type | description |
generateFileNameBaseFromHeaderFileName | string | generate file name base from header file name |
Function Arguments
name | type | description |
headerFileName | const string | header file name |
Function Reference List
N/A
Function CSoperationsClass::attachFunctionReferenceTargets()
Function Summary
name | return type | description |
attachFunctionReferenceTargets | void | attach function reference targets |
Function Arguments
name | type | description |
firstObjectInAboveLevelBelowListContainer | CSfileContainer* | first object in above level below list container |
level | int | level |
Function Reference List
-
-
-
- printLevelIndentation
-
- CSreferenceContainerClassClass::findFunctionReferenceTarget
- CSreferenceContainerClassClass::findFunctionReferenceTarget
- attachFunctionReferenceTargets
Function CSoperationsClass::extractFunctionArgumentName()
Function Summary
name | return type | description |
extractFunctionArgumentName | string | extract function argument name |
Function Arguments
name | type | description |
argumentText | string* | argument text |
indexOfStartOfVariableName | const int | index of start of variable name |
Function Reference List
N/A
Function CSoperationsClass::printLevelIndentation()
Function Summary
name | return type | description |
printLevelIndentation | void | print level indentation |
Function Arguments
name | type | description |
level | int | level |
Function Reference List
N/A
Function CSoperationsClass::createParameterList()
Function Summary
name | return type | description |
createParameterList | vector | create parameter list |
Function Arguments
name | type | description |
functionArgumentsRaw | const string* | function arguments raw |
Function Reference List
-
-
- CSreferenceContainerClassClass::findEndPositionOfArgument
File LDsprite Documentation
File Name: LDsprite.cpp/.hpp
File Description: LD sprite
File Function List
-
- fillInLDspriteExternVariables
- LDaddBasicTextualSpriteStringToReferenceList
- LDspriteSubmodelFillTextualReference
File Diagram (functions hierarchy)
Function LDspriteClass::fillInLDspriteExternVariables()
Function Summary
name | return type | description |
fillInLDspriteExternVariables | void | fill in LD sprite extern variables |
Function Reference List
N/A
Function LDspriteClass::LDaddBasicTextualSpriteStringToReferenceList()
Function Summary
name | return type | description |
LDaddBasicTextualSpriteStringToReferenceList | LDreference* | LD add basic textual sprite string to reference list |
Function Arguments
name | type | description |
spriteTextString | string | 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
-
-
-
-
- SHAREDvectorClass::addVectors
- LDspriteSubmodelFillTextualReference
- LDspriteSubmodelFillTextualReference
- SHAREDvectorClass::addVectors
- LDspriteSubmodelFillTextualReference
- LDspriteSubmodelFillTextualReference
Function LDspriteClass::LDspriteSubmodelFillTextualReference()
Function Summary
name | return type | description |
LDspriteSubmodelFillTextualReference | void | LD sprite submodel fill textual reference |
Function Arguments
name | type | description |
spriteSubmodelCurrentReference | LDreference* | 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
-
-
- SHAREDvectorClass::createIdentityMatrix
- SHAREDvectorClass::scaleMatrix
- SHAREDvectorClass::createIdentityMatrix
- SHAREDvectorClass::scaleMatrix
- SHAREDvectorClass::copyMatrixTwoIntoMatrixOne
File XMLrulesClass Documentation
File Name: XMLrulesClass.cpp/.hpp
File Description: XML rules class
File Function List
-
- parseCSrulesXMLfile
- addRulesClassObjectsBasedOnSectionTag
- addRulesClassObjectBasedOnTag
File Diagram (functions hierarchy)
Class XMLrulesClass
Class Data
name | type | description |
name | string | name |
stringValue | string | string value |
fractionalValue | double | fractional value |
attribute4 | int | attribute 4 |
attribute5 | int | attribute 5 |
attribute6 | int | attribute 6 |
attribute7 | int | attribute 7 |
attribute8 | int | attribute 8 |
next | XMLrulesClass* | next |
Function XMLrulesClassClass::parseCSrulesXMLfile()
Function Summary
name | return type | description |
parseCSrulesXMLfile | bool | parse CS rules XML file |
Function Reference List
-
- XMLparserClassClass::readXMLfile
- parseCSRulesTag
Function XMLrulesClassClass::parseCSRulesTag()
Function Summary
name | return type | description |
parseCSRulesTag | bool | parse CSR ules tag |
Function Arguments
name | type | description |
currentTag | XMLparserTag* | current tag |
Function Reference List
-
- XMLparserClassClass::parseTagDownALevel
- addRulesClassObjectsBasedOnSectionTag
- addRulesClassObjectsBasedOnSectionTag
Function XMLrulesClassClass::addRulesClassObjectsBasedOnSectionTag()
Function Summary
name | return type | description |
addRulesClassObjectsBasedOnSectionTag | bool | add rules class objects based on section tag |
Function Arguments
name | type | description |
currentTag | XMLparserTag* | 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
-
-
-
- addRulesClassObjectBasedOnTag
Function XMLrulesClassClass::addRulesClassObjectBasedOnTag()
Function Summary
name | return type | description |
addRulesClassObjectBasedOnTag | bool | add rules class object based on tag |
Function Arguments
name | type | description |
currentTag | XMLparserTag* | 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
-
-
-
-
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
File CSdraw Documentation
File Name: CSdraw.cpp/.hpp
File Description: CS draw
File Function List
-
- initiateMaxXatParticularY
- createFileObjectListBoxes
- createFileObjectListBoxesPrintedReset
- hasPreviousReferenceWithThisNameHasBeenPrinted
- hasPreviousReferenceWithThisNameHasBeenPrintedReset
- createFileObjectListConnections
- createFileObjectConnection
- createFunctionObjectListBoxesAndConnections
- printFunctionBox
- printFunctionBoxText
- resetPrintedFunctionConnections
- createFunctionObjectConnection
- configureFileOrFunctionObjectConnection
- createFileOrFunctionObjectBox
- createBox
- calculateCSBoxAndConnectionColourBasedUponLevel
- calculateCSBoxAndConnectionColourBasedUponFileName
- findPrintedFunctionObjectWithName
- traceFunctionsUpwardsAndDrawOrHighLightThese
- traceFunctionsUpwardsAndDrawOrHighLightTheseReset
- writeFileOrFunctionSVGbox
- writeFileOrFunctionSVGboxTransparent
- fillInCSrulesExternVariables
- createGroupID
File Diagram (functions hierarchy)
Function CSdrawClass::initiateMaxXatParticularY()
Function Summary
name | return type | description |
initiateMaxXatParticularY | void | initiate max xat particular Y |
Function Reference List
N/A
Function CSdrawClass::createFileObjectListBoxes()
Function Summary
name | return type | description |
createFileObjectListBoxes | LDreference* | create file object list boxes |
Function Arguments
name | type | description |
currentReferenceInPrintList | LDreference* | 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
-
-
- hasPreviousReferenceWithThisNameHasBeenPrinted
- hasPreviousReferenceWithThisNameHasBeenPrintedReset
-
-
-
-
-
-
- SHAREDvarsClass::convertStringToInt
- SHAREDvarsClass::convertStringToInt
- createBox
- LDsvgClass::writeSVGbox
- calculateCSBoxAndConnectionColourBasedUponLevel
- calculateCSBoxAndConnectionColourBasedUponFileName
- createGroupID
- LDsvgClass::writeSVGgroup
- createFileOrFunctionObjectBox
- writeFileOrFunctionSVGbox
- LDspriteClass::LDaddBasicTextualSpriteStringToReferenceList
- LDsvgClass::writeSVGtext
- createFileObjectListBoxes
Function CSdrawClass::createFileObjectListBoxesPrintedReset()
Function Summary
name | return type | description |
createFileObjectListBoxesPrintedReset | void | create file object list boxes printed reset |
Function Arguments
name | type | description |
firstObjectInAboveLevelBelowListContainer | CSfileContainer* | first object in above level below list container |
Function Reference List
-
-
-
- createFileObjectListBoxesPrintedReset
Function CSdrawClass::hasPreviousReferenceWithThisNameHasBeenPrinted()
Function Summary
name | return type | description |
hasPreviousReferenceWithThisNameHasBeenPrinted | bool | has previous reference with this name has been printed |
Function Arguments
name | type | description |
name | string | name |
firstObjectInTopLevelBelowListContainer | CSfileContainer* | first object in top level below list container |
*maxYPos | int | *max YP os |
Function Reference List
-
-
-
-
- hasPreviousReferenceWithThisNameHasBeenPrinted
Function CSdrawClass::hasPreviousReferenceWithThisNameHasBeenPrintedReset()
Function Summary
name | return type | description |
hasPreviousReferenceWithThisNameHasBeenPrintedReset | void | has previous reference with this name has been printed reset |
Function Arguments
name | type | description |
firstObjectInTopLevelBelowListContainer | CSfileContainer* | first object in top level below list container |
Function Reference List
-
-
-
-
- hasPreviousReferenceWithThisNameHasBeenPrintedReset
Function CSdrawClass::createFileObjectListConnections()
Function Summary
name | return type | description |
createFileObjectListConnections | LDreference* | create file object list connections |
Function Arguments
name | type | description |
currentReferenceInPrintList | LDreference* | 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
-
-
-
-
- calculateCSBoxAndConnectionColourBasedUponLevel
- calculateCSBoxAndConnectionColourBasedUponFileName
- createFileObjectConnection
- createFileObjectListConnections
Function CSdrawClass::createFileObjectConnection()
Function Summary
name | return type | description |
createFileObjectConnection | LDreference* | create file object connection |
Function Arguments
name | type | description |
currentReferenceInPrintList | LDreference* | 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
-
- createGroupID
- createGroupID
- configureFileOrFunctionObjectConnection
Function CSdrawClass::createFunctionObjectListBoxesAndConnections()
Function Summary
name | return type | description |
createFunctionObjectListBoxesAndConnections | LDreference* | create function object list boxes and connections |
Function Arguments
name | type | description |
currentReferenceInPrintList | LDreference* | 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
-
-
- CSreferenceContainerClassClass::findFunctionReferenceTarget
-
-
-
- calculateCSBoxAndConnectionColourBasedUponLevel
- createFunctionObjectConnection
- createGroupID
- LDsvgClass::writeSVGgroup
- printFunctionBox
- printFunctionBoxText
- createFunctionObjectListBoxesAndConnections
- createFunctionObjectConnection
Function CSdrawClass::printFunctionBox()
Function Summary
name | return type | description |
printFunctionBox | LDreference* | print function box |
Function Arguments
name | type | description |
currentReferenceInPrintList | LDreference* | current reference in print list |
currentTag | XMLparserTag** | current tag |
functionObject | CSfunction* | function object |
colour | int | colour |
Function Reference List
-
- createFileOrFunctionObjectBox
- writeFileOrFunctionSVGbox
Function CSdrawClass::printFunctionBoxText()
Function Summary
name | return type | description |
printFunctionBoxText | LDreference* | print function box text |
Function Arguments
name | type | description |
currentReferenceInPrintList | LDreference* | 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
-
- LDspriteClass::LDaddBasicTextualSpriteStringToReferenceList
- LDsvgClass::writeSVGtext
Function CSdrawClass::resetPrintedFunctionConnections()
Function Summary
name | return type | description |
resetPrintedFunctionConnections | void | reset printed function connections |
Function Arguments
name | type | description |
aboveLevelFileObject | constEffective 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
-
-
- CSreferenceContainerClassClass::findFunctionReferenceTarget
-
- resetPrintedFunctionConnections
Function CSdrawClass::createFunctionObjectConnection()
Function Summary
name | return type | description |
createFunctionObjectConnection | LDreference* | create function object connection |
Function Arguments
name | type | description |
currentReferenceInPrintList | LDreference* | 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
-
- createGroupID
- createGroupID
- configureFileOrFunctionObjectConnection
Function CSdrawClass::configureFileOrFunctionObjectConnection()
Function Summary
name | return type | description |
configureFileOrFunctionObjectConnection | LDreference* | configure file or function object connection |
Function Arguments
name | type | description |
currentReferenceInPrintList | LDreference* | 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
-
-
- LDsvgClass::writeSVGconnector
- LDsvgClass::writeSVGline
Function CSdrawClass::createFileOrFunctionObjectBox()
Function Summary
name | return type | description |
createFileOrFunctionObjectBox | LDreference* | create file or function object box |
Function Arguments
name | type | description |
currentReferenceInPrintList | LDreference* | 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
name | return type | description |
createBox | LDreference* | create box |
Function Arguments
name | type | description |
currentReferenceInPrintList | LDreference* | 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
name | return type | description |
calculateCSBoxAndConnectionColourBasedUponLevel | int | calculate CSB ox and connection colour based upon level |
Function Arguments
name | type | description |
yIndex | const int | yIndex |
Function Reference List
N/A
Function CSdrawClass::calculateCSBoxAndConnectionColourBasedUponFileName()
Function Summary
name | return type | description |
calculateCSBoxAndConnectionColourBasedUponFileName | int | calculate CSB ox and connection colour based upon file name |
Function Arguments
name | type | description |
currentFileObject | const CSfile* | current file object |
Function Reference List
N/A
Function CSdrawClass::findPrintedFunctionObjectWithName()
Function Summary
name | return type | description |
findPrintedFunctionObjectWithName | bool | find printed function object with name |
Function Arguments
name | type | description |
name | const 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
-
-
-
- findPrintedFunctionObjectWithName
Function CSdrawClass::traceFunctionsUpwardsAndDrawOrHighLightThese()
Function Summary
name | return type | description |
traceFunctionsUpwardsAndDrawOrHighLightThese | LDreference* | trace functions upwards and draw or high light these |
Function Arguments
name | type | description |
currentReferenceInPrintList | LDreference* | 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
-
- createFileOrFunctionObjectBox
- writeFileOrFunctionSVGboxTransparent
- LDspriteClass::LDaddBasicTextualSpriteStringToReferenceList
- LDsvgClass::writeSVGtext
-
-
- createFunctionObjectConnection
- traceFunctionsUpwardsAndDrawOrHighLightThese
Function CSdrawClass::traceFunctionsUpwardsAndDrawOrHighLightTheseReset()
Function Summary
name | return type | description |
traceFunctionsUpwardsAndDrawOrHighLightTheseReset | void | trace functions upwards and draw or high light these reset |
Function Arguments
name | type | description |
firstObjectInTopLevelBelowListContainer | const CSfileContainer* | first object in top level below list container |
currentFunctionBeingTraced | CSfunction* | current function being traced |
Function Reference List
-
-
-
-
-
- traceFunctionsUpwardsAndDrawOrHighLightTheseReset
Function CSdrawClass::writeFileOrFunctionSVGbox()
Function Summary
name | return type | description |
writeFileOrFunctionSVGbox | void | write file or function SVG box |
Function Arguments
name | type | description |
currentTag | XMLparserTag** | 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
name | return type | description |
writeFileOrFunctionSVGboxTransparent | void | write file or function SVG box transparent |
Function Arguments
name | type | description |
currentTag | XMLparserTag** | 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
-
- LDsvgClass::writeSVGboxTransparent
Function CSdrawClass::fillInCSrulesExternVariables()
Function Summary
name | return type | description |
fillInCSrulesExternVariables | void | fill in CS rules extern variables |
Function Reference List
N/A
Function CSdrawClass::createGroupID()
Function Summary
name | return type | description |
createGroupID | string | create group ID |
Function Arguments
name | type | description |
objectName | const string | object name |
printX | const int | print X |
printY | const int | print Y |
Function Reference List
-
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
File LDsvg Documentation
File Name: LDsvg.cpp/.hpp
File Description: LD svg
File Function List
-
-
-
- writeSVGfile
- writeSVGheader
- writeSVGfooter
- writeSVGboxTransparent
- writeSVGbox
- writeSVGbox2
- writeSVGline
- writeSVGtext
- writeSVGgroup
- writeSVGconnector
- convertColourRGBtoHexString
File Diagram (functions hierarchy)
Function LDsvgClass::writeSVGfile()
Function Summary
name | return type | description |
writeSVGfile | bool | write SVG file |
Function Arguments
name | type | description |
writeFileString | string* | 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
-
- writeSVGheader
- XMLparserClassClass::addTagLayerToFileObject
- writeSVGfooter
Function LDsvgClass::writeSVGheader()
Function Summary
name | return type | description |
writeSVGheader | void | write SVG header |
Function Arguments
name | type | description |
writeFileString | string* | 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
-
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
Function LDsvgClass::writeSVGfooter()
Function Summary
name | return type | description |
writeSVGfooter | void | write SVG footer |
Function Arguments
name | type | description |
writeFileString | string* | write file string |
Function Reference List
N/A
Function LDsvgClass::writeSVGboxTransparent()
Function Summary
name | return type | description |
writeSVGboxTransparent | void | write SVG box transparent |
Function Arguments
name | type | description |
currentTag | XMLparserTag** | 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
name | return type | description |
writeSVGbox | void | write SVG box |
Function Arguments
name | type | description |
currentTag | XMLparserTag** | 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
name | return type | description |
writeSVGbox2 | void | write SVG box 2 |
Function Arguments
name | type | description |
currentTag | XMLparserTag** | 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
-
- LDreferenceClassClass::convertLdrawColourToDatFileRGB
- writeSVGbox3
Function LDsvgClass::writeSVGbox3()
Function Summary
name | return type | description |
writeSVGbox3 | void | write SVG box 3 |
Function Arguments
name | type | description |
currentTag | XMLparserTag** | 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
-
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertDoubleToString
Function LDsvgClass::writeSVGline()
Function Summary
name | return type | description |
writeSVGline | void | write SVG line |
Function Arguments
name | type | description |
currentTag | XMLparserTag** | current tag |
pos1 | const vec* | pos 1 |
pos2 | const vec* | pos 2 |
colourrgb | const colour | colourrgb |
Function Reference List
-
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
Function LDsvgClass::writeSVGtext()
Function Summary
name | return type | description |
writeSVGtext | void | write SVG text |
Function Arguments
name | type | description |
currentTag | XMLparserTag** | 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
name | return type | description |
writeSVGtext | void | write SVG text |
Function Arguments
name | type | description |
currentTag | XMLparserTag** | 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
-
- LDreferenceClassClass::convertLdrawColourToDatFileRGB
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
Function LDsvgClass::writeSVGgroup()
Function Summary
name | return type | description |
writeSVGgroup | XMLparserTag* | write SVG group |
Function Arguments
name | type | description |
currentTag | XMLparserTag** | current tag |
groupID | const string* | group ID |
Function Reference List
N/A
Function LDsvgClass::writeSVGconnector()
Function Summary
name | return type | description |
writeSVGconnector | void | write SVG connector |
Function Arguments
name | type | description |
currentTag | XMLparserTag** | 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
-
- LDreferenceClassClass::convertLdrawColourToDatFileRGB
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertDoubleToString
- convertColourRGBtoHexString
Function LDsvgClass::convertColourRGBtoHexString()
Function Summary
name | return type | description |
convertColourRGBtoHexString | string | convert colour RGB to hex string |
Function Arguments
name | type | description |
colourRGB | const colour* | colour RGB |
Function Reference List
N/A
File LDopengl Documentation
File Name: LDopengl.cpp/.hpp
File Description: LD opengl
File Function List
-
- initiateOpenGL
- exitOpenGL
- setViewPort3Dortho
- drawPrimitivesReferenceListToOpenGLandCreateRGBmapBasic
File Diagram (functions hierarchy)
Function LDopenglClass::initiateOpenGL()
Function Summary
name | return type | description |
initiateOpenGL | bool | initiate open GL |
Function Arguments
name | type | description |
width | const 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
name | return type | description |
exitOpenGL | bool | exit open GL |
Function Reference List
N/A
Function LDopenglClass::setViewPort3Dortho()
Function Summary
name | return type | description |
setViewPort3Dortho | void | set view port 3D ortho |
Function Arguments
name | type | description |
left | const 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
name | return type | description |
drawPrimitivesReferenceListToOpenGLandCreateRGBmapBasic | void | draw primitives reference list to open GL and create RGB map basic |
Function Arguments
name | type | description |
firstReferenceInPrimitivesReferenceList | const 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
name | return type | description |
writeScreenToRGBMap | void | write screen to RGBM ap |
Function Arguments
name | type | description |
width | int | 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
-
- parseFile
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- removeWhiteSpaceFromString
File Diagram (functions hierarchy)
Function LDparserClass::parseFile()
Function Summary
name | return type | description |
parseFile | bool | parse file |
Function Arguments
name | type | description |
parseFileName | string | parse file name |
initialReference | LDreference* | initial reference |
parentReference | LDreference* | parent reference |
recurseIntoPartsDir | const bool | recurse into parts dir |
Function Reference List
-
-
-
- removeWhiteSpaceFromString
- removeWhiteSpaceFromString
-
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvectorClass::multiplyMatricies
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- SHAREDvectorClass::multiplyMatricies
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- parseFile
Function LDparserClass::calcModXPosBasedUponRotate()
Function Summary
name | return type | description |
calcModXPosBasedUponRotate | double | calc mod XP os based upon rotate |
Function Arguments
name | type | description |
childRelativePosition | const vec* | child relative position |
parentReferenceDeformationMatrix | const mat* | parent reference deformation matrix |
Function Reference List
N/A
Function LDparserClass::calcModYPosBasedUponRotate()
Function Summary
name | return type | description |
calcModYPosBasedUponRotate | double | calc mod YP os based upon rotate |
Function Arguments
name | type | description |
childRelativePosition | const vec* | child relative position |
parentReferenceDeformationMatrix | const mat* | parent reference deformation matrix |
Function Reference List
N/A
Function LDparserClass::calcModZPosBasedUponRotate()
Function Summary
name | return type | description |
calcModZPosBasedUponRotate | double | calc mod ZP os based upon rotate |
Function Arguments
name | type | description |
childRelativePosition | const vec* | child relative position |
parentReferenceDeformationMatrix | const mat* | parent reference deformation matrix |
Function Reference List
N/A
Function LDparserClass::removeWhiteSpaceFromString()
Function Summary
name | return type | description |
removeWhiteSpaceFromString | string | remove white space from string |
Function Arguments
name | type | description |
s | const string | s |
Function Reference List
N/A
File RTpixelMaps Documentation
File Name: RTpixelMaps.cpp/.hpp
File Description: RT pixel maps
File Function List
-
- getRGBMapValues
- generatePixmapFromRGBmap
- writeImage
File Diagram (functions hierarchy)
Function RTpixelMapsClass::getRGBMapValues()
Function Summary
name | return type | description |
getRGBMapValues | void | get RGBM ap values |
Function Arguments
name | type | description |
x | int | 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
name | return type | description |
generatePixmapFromRGBmap | void | generate pixmap from RGB map |
Function Arguments
name | type | description |
imageFileName | const string | image file name |
imageWidth | int | image width |
imageHeight | const int | image height |
rgbMap | uchar* | rgb map |
Function Reference List
-
- RTppmClass::newPixmap
-
- getRGBMapValues
- RTppmClass::placepointPPM
- writeImage
Function RTpixelMapsClass::writeImage()
Function Summary
name | return type | description |
writeImage | void | write image |
Function Arguments
name | type | description |
imageFileName | const string | image file name |
pm | pixmap* | pm |
Function Reference List
-
- RTppmClass::writePPM
- RTppmClass::freePixmap
File RTppm Documentation
File Name: RTppm.cpp/.hpp
File Description: RT ppm
File Function List
-
- placepointPPM
- newPixmap
- writePPM
- freePixmap
File Diagram (functions hierarchy)
Function RTppmClass::placepointPPM()
Function Summary
name | return type | description |
placepointPPM | void | placepoint PPM |
Function Arguments
name | type | description |
pm | pixmap* | 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
name | return type | description |
newPixmap | pixmap* | new pixmap |
Function Arguments
name | type | description |
wide | const int | wide |
high | const int | high |
Function Reference List
N/A
Function RTppmClass::writePPM()
Function Summary
name | return type | description |
writePPM | void | write PPM |
Function Arguments
name | type | description |
fname | const string | fname |
pm | const pixmap* | pm |
Function Reference List
N/A
Function RTppmClass::freePixmap()
Function Summary
name | return type | description |
freePixmap | void | free pixmap |
Function Arguments
name | type | description |
pm | pixmap* | pm |
Function Reference List
N/A
File CSgenerateHTMLdocumentation Documentation
File Name: CSgenerateHTMLdocumentation.cpp/.hpp
File Description: CS generate HTML documentation
File Function List
-
- generateHTMLdocumentationFunctions
- generateHTMLdocumentationHeader
- generateHTMLdocumentationHeader
- generateHTMLdocumentationFooter
- generateHTMLdocumentationForAllFunctions
- generateHTMLdocumentationForFunction
- generateHTMLdocumentationFunctionSummary
- generateHTMLdocumentationFunctionInputArguments
- generateHTMLdocumentationFunctionOrClassArgumentsFromFunctionNameFull
- generateHTMLdocumentationFunctionOrClassArgumentsFromString
- generateHTMLdocumentationFunctionOrClassArgumentsFromParameterList
- ensureHTMLTagSafe
- createDescriptionFromCaseSensitiveMultiwordString
- generateHTMLdocumentationFunctionReferenceList
- generateHTMLdocumentationImagePlaceHolder
- generateFileDiagramFunctionsHeirachy
- writeStringPointerToFileObject
- addToHTMLdocumentationFileFunctionList
- generateClassHTMLdocumentationFromCustomCSclassFormat
- getFunctionNameFromFunctionNameFull
- generateClassHTMLdocumentationFromCustomCSclassFormat
- convertIndentedListToHTMLlist
- readIndentedListFile
- generateHTMLdocumentationIndentedList
- addToHTMLdocumentationIndentedList
- generateFunctionString
File Diagram (functions hierarchy)
Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationFunctions()
Function Summary
name | return type | description |
generateHTMLdocumentationFunctions | void | generate HTML documentation functions |
Function Arguments
name | type | description |
firstTagInSVGFile | XMLparserTag* | 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
-
- generateHTMLdocumentationForAllFunctions
- generateHTMLdocumentationHeader
- generateHTMLdocumentationFooter
- generateHTMLdocumentationImagePlaceHolder
- generateHTMLdocumentationImagePlaceHolder
- writeStringPointerToFileObject
Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationHeader()
Function Summary
name | return type | description |
generateHTMLdocumentationHeader | string | generate HTML documentation header |
Function Arguments
name | type | description |
name | const string | name |
htmlHeader | const bool | html header |
isFile | const bool | is file |
Function Reference List
-
- generateHTMLdocumentationHeader
Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationHeader()
Function Summary
name | return type | description |
generateHTMLdocumentationHeader | string | generate HTML documentation header |
Function Arguments
name | type | description |
titleName | const string | title name |
fileName | const string | file name |
htmlHeader | const bool | html header |
isFile | const bool | is file |
Function Reference List
-
-
- createDescriptionFromCaseSensitiveMultiwordString
Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationFooter()
Function Summary
name | return type | description |
generateHTMLdocumentationFooter | string | generate HTML documentation footer |
Function Arguments
name | type | description |
htmlFileFooter | const bool | html file footer |
Function Reference List
N/A
Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationForAllFunctions()
Function Summary
name | return type | description |
generateHTMLdocumentationForAllFunctions | void | generate HTML documentation for all functions |
Function Arguments
name | type | description |
firstObjectInAboveLevelBelowListContainer | CSfileContainer* | 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
-
-
-
-
-
-
-
- generateHTMLdocumentationForFunction
- addToHTMLdocumentationFileFunctionList
- generateFileDiagramFunctionsHeirachy
- generateHTMLdocumentationImagePlaceHolder
-
- generateHTMLdocumentationFunctionOrClassArgumentsFromParameterList
- generateHTMLdocumentationHeader
- generateHTMLdocumentationFooter
- writeStringPointerToFileObject
- generateHTMLdocumentationForAllFunctions
Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationForFunction()
Function Summary
name | return type | description |
generateHTMLdocumentationForFunction | void | generate HTML documentation for function |
Function Arguments
name | type | description |
currentReferenceInPrintList | LDreference* | 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
-
-
- CSdrawClass::traceFunctionsUpwardsAndDrawOrHighLightThese
- CSdrawClass::traceFunctionsUpwardsAndDrawOrHighLightTheseReset
- generateFunctionString
- generateHTMLdocumentationFunctionSummary
- generateHTMLdocumentationFunctionInputArguments
- generateHTMLdocumentationFunctionReferenceList
- generateHTMLdocumentationImagePlaceHolder
- generateHTMLdocumentationHeader
- generateHTMLdocumentationFooter
- writeStringPointerToFileObject
Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationFunctionSummary()
Function Summary
name | return type | description |
generateHTMLdocumentationFunctionSummary | void | generate HTML documentation function summary |
Function Arguments
name | type | description |
currentFunction | const CSfunction* | current function |
HTMLdocumentationFunctionSummary | string* | HTML documentation function summary |
Function Reference List
-
- createDescriptionFromCaseSensitiveMultiwordString
Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationFunctionInputArguments()
Function Summary
name | return type | description |
generateHTMLdocumentationFunctionInputArguments | void | generate HTML documentation function input arguments |
Function Arguments
name | type | description |
currentFunction | const CSfunction* | current function |
HTMLdocumentationFunctionInputArguments | string* | HTML documentation function input arguments |
Function Reference List
-
- generateHTMLdocumentationFunctionOrClassArgumentsFromParameterList
- generateHTMLdocumentationFunctionOrClassArgumentsFromString
- generateHTMLdocumentationFunctionOrClassArgumentsFromFunctionNameFull
Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationFunctionOrClassArgumentsFromFunctionNameFull()
Function Summary
name | return type | description |
generateHTMLdocumentationFunctionOrClassArgumentsFromFunctionNameFull | void | generate HTML documentation function or class arguments from function name full |
Function Arguments
name | type | description |
classDataOrFunctionArguments | const bool | class data or function arguments |
functionNameFull | const string* | function name full |
HTMLdocumentationFunctionInputArguments | string* | HTML documentation function input arguments |
Function Reference List
-
-
- generateHTMLdocumentationFunctionOrClassArgumentsFromString
Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationFunctionOrClassArgumentsFromString()
Function Summary
name | return type | description |
generateHTMLdocumentationFunctionOrClassArgumentsFromString | void | generate HTML documentation function or class arguments from string |
Function Arguments
name | type | description |
classDataOrFunctionArguments | const bool | class data or function arguments |
functionArgumentsRaw | const string | function arguments raw |
HTMLdocumentationFunctionInputArguments | string* | HTML documentation function input arguments |
Function Reference List
-
-
- CSreferenceContainerClassClass::findEndPositionOfArgument
- createDescriptionFromCaseSensitiveMultiwordString
- ensureHTMLTagSafe
- ensureHTMLTagSafe
- ensureHTMLTagSafe
Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationFunctionOrClassArgumentsFromParameterList()
Function Summary
name | return type | description |
generateHTMLdocumentationFunctionOrClassArgumentsFromParameterList | void | generate HTML documentation function or class arguments from parameter list |
Function Arguments
name | type | description |
classDataOrFunctionArguments | const bool | class data or function arguments |
parameterList | vector<CSparameter*>* | parameter list |
HTMLdocumentationParameterList | string* | HTML documentation parameter list |
Function Reference List
-
-
-
- createDescriptionFromCaseSensitiveMultiwordString
- ensureHTMLTagSafe
- ensureHTMLTagSafe
- ensureHTMLTagSafe
Function CSgenerateHTMLdocumentationClass::ensureHTMLTagSafe()
Function Summary
name | return type | description |
ensureHTMLTagSafe | string | ensure HTMLT ag safe |
Function Arguments
name | type | description |
str | const string | str |
Function Reference List
N/A
Function CSgenerateHTMLdocumentationClass::createDescriptionFromCaseSensitiveMultiwordString()
Function Summary
name | return type | description |
createDescriptionFromCaseSensitiveMultiwordString | string | create description from case sensitive multiword string |
Function Arguments
name | type | description |
str | string | str |
Function Reference List
N/A
Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationFunctionReferenceList()
Function Summary
name | return type | description |
generateHTMLdocumentationFunctionReferenceList | void | generate HTML documentation function reference list |
Function Arguments
name | type | description |
function | CSfunction* | function |
HTMLdocumentationFunctionReferenceList | string* | HTML documentation function reference list |
Function Reference List
-
-
- addToHTMLdocumentationFileFunctionList
- generateFunctionString
Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationImagePlaceHolder()
Function Summary
name | return type | description |
generateHTMLdocumentationImagePlaceHolder | string | generate HTML documentation image place holder |
Function Arguments
name | type | description |
traceImageFileName | const string* | trace image file name |
imageTitle | const string | image title |
Function Reference List
N/A
Function CSgenerateHTMLdocumentationClass::generateFileDiagramFunctionsHeirachy()
Function Summary
name | return type | description |
generateFileDiagramFunctionsHeirachy | void | generate file diagram functions heirachy |
Function Arguments
name | type | description |
currentFileObject | CSfile* | 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
-
-
- CSdrawClass::initiateMaxXatParticularY
- SHAREDvarsClass::setCurrentDirectory
-
-
- CSdrawClass::printFunctionBox
- CSdrawClass::printFunctionBoxText
- CSdrawClass::createFunctionObjectListBoxesAndConnections
- CSdrawClass::resetPrintedFunctionConnections
- LDsvgClass::writeSVGfile
Function CSgenerateHTMLdocumentationClass::writeStringPointerToFileObject()
Function Summary
name | return type | description |
writeStringPointerToFileObject | void | write string pointer to file object |
Function Arguments
name | type | description |
s | string* | s |
writeFileObject | ofstream* | write file object |
Function Reference List
N/A
Function CSgenerateHTMLdocumentationClass::addToHTMLdocumentationFileFunctionList()
Function Summary
name | return type | description |
addToHTMLdocumentationFileFunctionList | void | add to HTML documentation file function list |
Function Arguments
name | type | description |
currentFunctionObject | CSfunction* | 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
-
- generateFunctionString
- addToHTMLdocumentationIndentedList
Function CSgenerateHTMLdocumentationClass::generateClassHTMLdocumentationFromCustomCSclassFormat()
Function Summary
name | return type | description |
generateClassHTMLdocumentationFromCustomCSclassFormat | void | generate class HTML documentation from custom CS class format |
Function Reference List
-
-
-
- generateClassHTMLdocumentationFromCustomCSclassFormat
Function CSgenerateHTMLdocumentationClass::getFunctionNameFromFunctionNameFull()
Function Summary
name | return type | description |
getFunctionNameFromFunctionNameFull | string | get function name from function name full |
Function Arguments
name | type | description |
functionNameFull | const string* | function name full |
Function Reference List
N/A
Function CSgenerateHTMLdocumentationClass::generateClassHTMLdocumentationFromCustomCSclassFormat()
Function Summary
name | return type | description |
generateClassHTMLdocumentationFromCustomCSclassFormat | void | generate class HTML documentation from custom CS class format |
Function Arguments
name | type | description |
CSclassFileName | const string | CS class file name |
CSclassFileContents | const vector<string>* | CS class file contents |
Function Reference List
-
-
- getFunctionNameFromFunctionNameFull
- createDescriptionFromCaseSensitiveMultiwordString
- generateHTMLdocumentationFunctionOrClassArgumentsFromFunctionNameFull
- generateHTMLdocumentationHeader
- generateHTMLdocumentationFooter
- writeStringPointerToFileObject
Function CSgenerateHTMLdocumentationClass::convertIndentedListToHTMLlist()
Function Summary
name | return type | description |
convertIndentedListToHTMLlist | void | convert indented list to HTML list |
Function Reference List
-
- readIndentedListFile
- generateHTMLdocumentationIndentedList
- writeStringPointerToFileObject
Function CSgenerateHTMLdocumentationClass::readIndentedListFile()
Function Summary
name | return type | description |
readIndentedListFile | bool | read indented list file |
Function Arguments
name | type | description |
indentedListFileName | const string | indented list file name |
indentedListVector | vector<string>* | indented list vector |
Function Reference List
N/A
Function CSgenerateHTMLdocumentationClass::generateHTMLdocumentationIndentedList()
Function Summary
name | return type | description |
generateHTMLdocumentationIndentedList | void | generate HTML documentation indented list |
Function Arguments
name | type | description |
indentedListVector | vector<string>* | indented list vector |
HTMLdocumentationIndentationList | string* | HTML documentation indentation list |
Function Reference List
-
-
- addToHTMLdocumentationIndentedList
Function CSgenerateHTMLdocumentationClass::addToHTMLdocumentationIndentedList()
Function Summary
name | return type | description |
addToHTMLdocumentationIndentedList | void | add to HTML documentation indented list |
Function Arguments
name | type | description |
currentFunctionObjectName | const 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
name | return type | description |
generateFunctionString | string | generate function string |
Function Arguments
name | type | description |
currentFunction | const 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
-
- generateCPPclasses
- generateCPPclassesRecurse
- generateCPPclassesFile
- replaceAllOccurancesOfFunctionObjectReferenceNameInFunction
- isFunctionBeingReferencedPublicallyRecurse
- generateClassName
- generateClassDeclarationName
- generateClassObjectName
- convertFunctionNameToClassFunctionNameSource
- convertFunctionNameToClassFunctionNameHeader
- generateReferencedClassesDeclarations
- findReferencedClassInList
- moveIncludeFileStatementsToHeader
File Diagram (functions hierarchy)
Class ReferencedClass
Class Data
name | type | description |
className | string | class name |
next | ReferencedClass* | next |
Function CSgenerateObjectOrientedCodeClass::generateCPPclasses()
Function Summary
name | return type | description |
generateCPPclasses | bool | generate CPP classes |
Function Arguments
name | type | description |
firstObjectInTopLevelBelowListContainer | CSfileContainer* | first object in top level below list container |
Function Reference List
-
- generateCPPclassesRecurse
Function CSgenerateObjectOrientedCodeClass::generateCPPclassesRecurse()
Function Summary
name | return type | description |
generateCPPclassesRecurse | bool | generate CPP classes recurse |
Function Arguments
name | type | description |
firstObjectInAboveLevelBelowListContainer | CSfileContainer* | first object in above level below list container |
firstObjectInTopLevelBelowListContainer | const CSfileContainer* | first object in top level below list container |
Function Reference List
-
-
-
-
-
- generateCPPclassesFile
- generateCPPclassesRecurse
Function CSgenerateObjectOrientedCodeClass::generateCPPclassesFile()
Function Summary
name | return type | description |
generateCPPclassesFile | bool | generate CPP classes file |
Function Arguments
name | type | description |
currentFileObject | CSfile* | current file object |
firstObjectInTopLevelBelowListContainer | const CSfileContainer* | first object in top level below list container |
Function Reference List
-
- generateClassName
-
- isFunctionBeingReferencedPublicallyRecurse
- convertFunctionNameToClassFunctionNameSource
- convertFunctionNameToClassFunctionNameHeader
- SHAREDvarsClass::replaceAllOccurancesOfString
- SHAREDvarsClass::replaceAllOccurancesOfString
-
- generateClassName
- generateClassDeclarationName
- generateClassObjectName
- findReferencedClassInList
- replaceAllOccurancesOfFunctionObjectReferenceNameInFunction
- generateClassDeclarationName
- generateReferencedClassesDeclarations
- moveIncludeFileStatementsToHeader
- SHAREDvarsClass::writeStringToFile
- SHAREDvarsClass::writeStringToFile
Function CSgenerateObjectOrientedCodeClass::replaceAllOccurancesOfFunctionObjectReferenceNameInFunction()
Function Summary
name | return type | description |
replaceAllOccurancesOfFunctionObjectReferenceNameInFunction | string | replace all occurances of function object reference name in function |
Function Arguments
name | type | description |
functionTextOrig | const 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
-
-
-
- SHAREDvarsClass::charInCharArray
Function CSgenerateObjectOrientedCodeClass::isFunctionBeingReferencedPublicallyRecurse()
Function Summary
name | return type | description |
isFunctionBeingReferencedPublicallyRecurse | void | is function being referenced publically recurse |
Function Arguments
name | type | description |
functionName | const 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
-
-
-
-
- isFunctionBeingReferencedPublicallyRecurse
Function CSgenerateObjectOrientedCodeClass::generateClassName()
Function Summary
name | return type | description |
generateClassName | string | generate class name |
Function Arguments
name | type | description |
headerFileName | const string | header file name |
Function Reference List
N/A
Function CSgenerateObjectOrientedCodeClass::generateClassDeclarationName()
Function Summary
name | return type | description |
generateClassDeclarationName | string | generate class declaration name |
Function Arguments
name | type | description |
className | const string | class name |
Function Reference List
N/A
Function CSgenerateObjectOrientedCodeClass::generateClassObjectName()
Function Summary
name | return type | description |
generateClassObjectName | string | generate class object name |
Function Arguments
name | type | description |
className | const string | class name |
Function Reference List
N/A
Function CSgenerateObjectOrientedCodeClass::convertFunctionNameToClassFunctionNameSource()
Function Summary
name | return type | description |
convertFunctionNameToClassFunctionNameSource | string | convert function name to class function name source |
Function Arguments
name | type | description |
fullFunctionName | string | 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
-
-
-
- generateClassDeclarationName
Function CSgenerateObjectOrientedCodeClass::convertFunctionNameToClassFunctionNameHeader()
Function Summary
name | return type | description |
convertFunctionNameToClassFunctionNameHeader | string | convert function name to class function name header |
Function Arguments
name | type | description |
fullFunctionName | const 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
name | return type | description |
generateReferencedClassesDeclarations | string | generate referenced classes declarations |
Function Arguments
name | type | description |
firstReferencedClassInList | const ReferencedClass* | first referenced class in list |
Function Reference List
-
-
- generateClassDeclarationName
- generateClassObjectName
Function CSgenerateObjectOrientedCodeClass::findReferencedClassInList()
Function Summary
name | return type | description |
findReferencedClassInList | bool | find referenced class in list |
Function Arguments
name | type | description |
firstReferencedClassInList | const ReferencedClass* | first referenced class in list |
classNameToFind | const string | class name to find |
Function Reference List
N/A
Function CSgenerateObjectOrientedCodeClass::moveIncludeFileStatementsToHeader()
Function Summary
name | return type | description |
moveIncludeFileStatementsToHeader | bool | move include file statements to header |
Function Arguments
name | type | description |
firstReferenceInAboveLevelBelowList | CSfile* | 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
-
- generateConstFunctionArguments
- generateConstFunctionArgumentsRecurse
- generateConstFunctionArgumentsFile
- generateConstFunctionArgumentsFunction
- generateConstFunctionArgumentAndSearchForSecondaryReferences
- generateConstFunctionArgument
- checkIfVariableIsBeingModifiedInFunction
- verifyThatVariableIsNotDeclarationOrNextIteratorAssignmentOrArrayIndex
- functionArgumentReferenceWholeWordCheck
- charInString
- detectDoublePointer
- detectPointerArray
- extractFullVariableName
- extractFullVariableNameReverse
- extractFullVariableTypeReverse
- addConstToAllOccurancesOfFunctionObjectFunctionArgumentSecondaryAssignmentDeclarationInFunction
File Diagram (functions hierarchy)
Function CSgenerateConstFunctionArgumentCodeClass::generateConstFunctionArguments()
Function Summary
name | return type | description |
generateConstFunctionArguments | bool | generate const function arguments |
Function Arguments
name | type | description |
firstObjectInTopLevelBelowListContainer | CSfileContainer* | first object in top level below list container |
Function Reference List
-
- generateConstFunctionArgumentsRecurse
Function CSgenerateConstFunctionArgumentCodeClass::generateConstFunctionArgumentsRecurse()
Function Summary
name | return type | description |
generateConstFunctionArgumentsRecurse | bool | generate const function arguments recurse |
Function Arguments
name | type | description |
firstObjectInAboveLevelBelowListContainer | CSfileContainer* | first object in above level below list container |
firstObjectInTopLevelBelowListContainer | const CSfileContainer* | first object in top level below list container |
Function Reference List
-
-
-
-
-
- SHAREDvarsClass::fileExists
- SHAREDvarsClass::fileExists
- generateConstFunctionArgumentsFile
- generateConstFunctionArgumentsRecurse
Function CSgenerateConstFunctionArgumentCodeClass::generateConstFunctionArgumentsFile()
Function Summary
name | return type | description |
generateConstFunctionArgumentsFile | bool | generate const function arguments file |
Function Arguments
name | type | description |
currentFileObject | CSfile* | current file object |
Function Reference List
-
-
- generateConstFunctionArgumentsFunction
-
-
- SHAREDvarsClass::replaceAllOccurancesOfString
- SHAREDvarsClass::replaceAllOccurancesOfString
- SHAREDvarsClass::replaceAllOccurancesOfString
- SHAREDvarsClass::replaceAllOccurancesOfString
-
- addConstToAllOccurancesOfFunctionObjectFunctionArgumentSecondaryAssignmentDeclarationInFunction
- SHAREDvarsClass::replaceAllOccurancesOfString
- SHAREDvarsClass::replaceAllOccurancesOfString
- SHAREDvarsClass::replaceAllOccurancesOfString
- SHAREDvarsClass::writeStringToFile
- SHAREDvarsClass::writeStringToFile
Function CSgenerateConstFunctionArgumentCodeClass::generateConstFunctionArgumentsFunction()
Function Summary
name | return type | description |
generateConstFunctionArgumentsFunction | bool | generate const function arguments function |
Function Arguments
name | type | description |
currentFunctionObject | CSfunction* | current function object |
Function Reference List
-
-
-
- generateConstFunctionArgumentAndSearchForSecondaryReferences
- generateConstFunctionArgumentAndSearchForSecondaryReferences
- generateConstFunctionArgumentAndSearchForSecondaryReferences
Function CSgenerateConstFunctionArgumentCodeClass::generateConstFunctionArgumentAndSearchForSecondaryReferences()
Function Summary
name | return type | description |
generateConstFunctionArgumentAndSearchForSecondaryReferences | bool | generate const function argument and search for secondary references |
Function Arguments
name | type | description |
currentFunctionObject | CSfunction* | current function object |
currentFunctionArgumentInFunction | CSfunctionArgument* | current function argument in function |
functionDeclarationArgument | string | function declaration argument |
Function Reference List
-
-
- generateConstFunctionArgument
- functionArgumentReferenceWholeWordCheck
-
-
-
-
- extractFullVariableNameReverse
-
- generateConstFunctionArgumentAndSearchForSecondaryReferences
- extractFullVariableName
- generateConstFunctionArgumentAndSearchForSecondaryReferences
-
- extractFullVariableNameReverse
- generateConstFunctionArgumentAndSearchForSecondaryReferences
Function CSgenerateConstFunctionArgumentCodeClass::generateConstFunctionArgument()
Function Summary
name | return type | description |
generateConstFunctionArgument | bool | generate const function argument |
Function Arguments
name | type | description |
currentFunctionObject | CSfunction* | current function object |
currentFunctionArgumentInFunction | CSfunctionArgument* | current function argument in function |
functionDeclarationArgument | string | function declaration argument |
Function Reference List
-
-
- checkIfVariableIsBeingModifiedInFunction
-
-
-
-
- functionArgumentReferenceWholeWordCheck
- generateConstFunctionArgumentsFunction
Function CSgenerateConstFunctionArgumentCodeClass::checkIfVariableIsBeingModifiedInFunction()
Function Summary
name | return type | description |
checkIfVariableIsBeingModifiedInFunction | void | check if variable is being modified in function |
Function Arguments
name | type | description |
currentFunctionObject | CSfunction* | 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
-
-
- functionArgumentReferenceWholeWordCheck
- SHAREDvarsClass::charInCharArray
-
-
-
-
- extractFullVariableNameReverse
-
-
-
-
-
- functionArgumentReferenceWholeWordCheck
- functionArgumentReferenceWholeWordCheck
- verifyThatVariableIsNotDeclarationOrNextIteratorAssignmentOrArrayIndex
- detectDoublePointer
- detectDoublePointer
- detectDoublePointer
-
-
- functionArgumentReferenceWholeWordCheck
- verifyThatVariableIsNotDeclarationOrNextIteratorAssignmentOrArrayIndex
- functionArgumentReferenceWholeWordCheck
- detectPointerArray
- detectDoublePointer
- extractFullVariableName
-
-
- extractFullVariableName
-
-
-
-
-
- functionArgumentReferenceWholeWordCheck
- functionArgumentReferenceWholeWordCheck
Function CSgenerateConstFunctionArgumentCodeClass::verifyThatVariableIsNotDeclarationOrNextIteratorAssignmentOrArrayIndex()
Function Summary
name | return type | description |
verifyThatVariableIsNotDeclarationOrNextIteratorAssignmentOrArrayIndex | bool | verify that variable is not declaration or next iterator assignment or array index |
Function Arguments
name | type | description |
currentFunctionObject | const 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
name | return type | description |
functionArgumentReferenceWholeWordCheck | bool | function argument reference whole word check |
Function Arguments
name | type | description |
functionText | string* | function text |
functionDeclarationArgument | string | function declaration argument |
indexOfFunctionArgument | int | index of function argument |
Function Reference List
-
- SHAREDvarsClass::charInCharArray
- SHAREDvarsClass::charInCharArray
Function CSgenerateConstFunctionArgumentCodeClass::charInString()
Function Summary
name | return type | description |
charInString | bool | char in string |
Function Arguments
name | type | description |
text | const string | text |
charArray | const char* | char array |
arraySize | const int | array size |
Function Reference List
N/A
Function CSgenerateConstFunctionArgumentCodeClass::detectDoublePointer()
Function Summary
name | return type | description |
detectDoublePointer | bool | detect double pointer |
Function Arguments
name | type | description |
functionArgument | string | function argument |
Function Reference List
N/A
Function CSgenerateConstFunctionArgumentCodeClass::detectPointerArray()
Function Summary
name | return type | description |
detectPointerArray | bool | detect pointer array |
Function Arguments
name | type | description |
functionArgument | string | function argument |
Function Reference List
N/A
Function CSgenerateConstFunctionArgumentCodeClass::extractFullVariableName()
Function Summary
name | return type | description |
extractFullVariableName | string | extract full variable name |
Function Arguments
name | type | description |
functionText | string* | function text |
indexOfStartOfVariableName | const int | index of start of variable name |
Function Reference List
N/A
Function CSgenerateConstFunctionArgumentCodeClass::extractFullVariableNameReverse()
Function Summary
name | return type | description |
extractFullVariableNameReverse | string | extract full variable name reverse |
Function Arguments
name | type | description |
functionText | const 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
name | return type | description |
extractFullVariableTypeReverse | string | extract full variable type reverse |
Function Arguments
name | type | description |
functionText | const 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
name | return type | description |
addConstToAllOccurancesOfFunctionObjectFunctionArgumentSecondaryAssignmentDeclarationInFunction | string | add const to all occurances of function object function argument secondary assignment declaration in function |
Function Arguments
name | type | description |
functionTextOrig | const 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
-
-
-
-
- extractFullVariableTypeReverse