KSLCore/ksl.utilities.io/OutputDirectory

OutputDirectory

class OutputDirectory(outputDirectoryPath: Path = KSLFileUtil.programLaunchDirectory, outFileName: String = "out.txt")

This class provides basic context for creating and writing output files. Files and directories created by instances of this class will be relative to the Path supplied at creation.

Parameters

outputDirectoryPath

the base output directory to use for writing text files relative to this OutputDirectory instance

outFileName

the name of the created text file related to property out

Constructors

OutputDirectory

constructor(outDirName: String = "OutputDir", outFileName: String = "out.txt")

Creates a OutputDirectory with the current program launch directory with the base directory

constructor(outputDirectoryPath: Path = KSLFileUtil.programLaunchDirectory, outFileName: String = "out.txt")

Properties

csvDir

val csvDir: Path

dbDir

val dbDir: Path

excelDir

val excelDir: Path

The path to the default Excel directory, relative to this output directory

out

val out: LogPrintWriter

Can be used like System.out, but instead writes to a file found in the base output directory

outDir

var outDir: Path

The path to the default output directory

plotDir

val plotDir: Path

Functions

createFile

fun createFile(fileName: String): File

Makes a new PrintWriter within the base directory with the given file name

createPrintWriter

fun createPrintWriter(fileName: String): PrintWriter

Makes a new PrintWriter within the base directory with the given file name

createSubDirectory

fun createSubDirectory(dirName: String): Path

Makes a Path to the named subdirectory within the base directory

toString

open override fun toString(): String