File ATORdatabaseFileIO Documentation

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

Copyright © 2020, BAI Research. All Rights Reserved.

File Name: ATORdatabaseFileIO.cpp/.hpp

File Description: ATOR database file IO

File Function List


File Diagram (functions hierarchy)


Function ATORdatabaseFileIOClass::initialiseDatabase()

Function Summary
namereturn typedescription
initialiseDatabasevoidinitialise database

Function Arguments
nametypedescription
newDatabaseFolderNameconst string new database folder name

Function Reference List
N/A


Function Trace
locationcurrent function being traced
ATORmain.hppinitialiseDatabase

Trace Diagram (magenta)


Function ATORdatabaseFileIOClass::DBsetCurrentDirectory()

Function Summary
namereturn typedescription
DBsetCurrentDirectoryboolDB set current directory

Function Arguments
nametypedescription
folderNamestring* folder name

Function Reference List


Function Trace
locationcurrent function being traced
ATORdatabaseFileIO.hppDBsetCurrentDirectory
ATORmethod.hppDBgenerateFolderName
ATORmethod.hppATORmethodTrainOrTest
ATORmain.hppATORmethodTrain
ATORmethod.hppATORmethodTrainOrTest
ATORcomparison.hppDBgenerateFolderName
ATORmethod.hppcompareNormalisedSnapshots

Trace Diagram (magenta)


Function ATORdatabaseFileIOClass::DBgenerateServerDatabaseName()

Function Summary
namereturn typedescription
DBgenerateServerDatabaseNamestringDB generate server database name

Function Arguments
nametypedescription
objectNameconst string* object name
trainOrTest const bool train or test

Function Reference List
N/A


Function Trace
locationcurrent function being traced
ATORdatabaseFileIO.hppDBgenerateServerDatabaseName
ATORmethod.hppDBgenerateFolderName
ATORmethod.hppATORmethodTrainOrTest
ATORmain.hppATORmethodTrain
ATORmethod.hppATORmethodTrainOrTest
ATORcomparison.hppDBgenerateFolderName
ATORmethod.hppcompareNormalisedSnapshots

Trace Diagram (magenta)


Function ATORdatabaseFileIOClass::DBgenerateFolderName()

Function Summary
namereturn typedescription
DBgenerateFolderNamestringDB generate folder name

Function Arguments
nametypedescription
objectNamestring* object name
trainOrTest const bool train or test

Function Reference List


Function Trace
locationcurrent function being traced
ATORmethod.hppDBgenerateFolderName
ATORmethod.hppATORmethodTrainOrTest
ATORmain.hppATORmethodTrain
ATORmethod.hppATORmethodTrainOrTest
ATORcomparison.hppDBgenerateFolderName
ATORmethod.hppcompareNormalisedSnapshots

Trace Diagram (magenta)


Function ATORdatabaseFileIOClass::compareFeaturesListForMatch()

Function Summary
namereturn typedescription
compareFeaturesListForMatchboolcompare features list for match

Function Arguments
nametypedescription
testFirstFeatureInNearestFeatureListATORfeature* test first feature in nearest feature list
trainFirstFeatureInNearestFeatureList ATORfeature* train first feature in nearest feature list
dimension const int dimension
exactMatchFound bool* exact match found

Function Reference List


Function Trace
locationcurrent function being traced
ATORcomparison.hppcompareFeaturesListForMatch
ATORmethod.hppcompareNormalisedSnapshots
ATORmethod.hppATORmethodCompareTestWithTrain
ATORmain.hppATORmethodTest

Trace Diagram (magenta)


Function ATORdatabaseFileIOClass::createTransformedFeaturesFile()

Function Summary
namereturn typedescription
createTransformedFeaturesFilevoidcreate transformed features file

Function Arguments
nametypedescription
firstFeatureInListconst ATORfeature* first feature in list
fileName const string file name
objectName const string object name
viewIndex const int view index
zoomIndex const int zoom index
polyIndex const int poly index
sideIndex const int side index
trainOrTest const int train or test

Function Reference List


Function Trace
locationcurrent function being traced
ATORmethod.hppcreateTransformedFeaturesFile
ATORmethod.hppgenerateNormalisedSnapshotsUsingPolyList
ATORmethod.hppATORmethodTrainOrTest
ATORmain.hppATORmethodTrain
ATORmethod.hppATORmethodTrainOrTest

Trace Diagram (magenta)


Function ATORdatabaseFileIOClass::createFeaturesListUsingFeaturesFile()

Function Summary
namereturn typedescription
createFeaturesListUsingFeaturesFilevoidcreate features list using features file

Function Arguments
nametypedescription
fileNameconst string file name
firstFeatureInList ATORfeature* first feature in list
createFeatureObjects const bool create feature objects
appendToList const bool append to list
ignoreOTfeatures const bool ignore OT features

Function Reference List


Function Trace
locationcurrent function being traced
ATORcomparison.hppcreateFeaturesListUsingFeaturesFile
ATORmethod.hppcompareNormalisedSnapshots
ATORmethod.hppATORmethodCompareTestWithTrain
ATORmain.hppATORmethodTest

Trace Diagram (magenta)