Strings Class Reference

A utility class for strings used in this project. More...

Static Public Member Functions
static bool	IsDigitsOnly (string str)
	Determines if is digits only the specified str. More...

Public Attributes
const string	projectTitle = "BotNavSim"
	The project title. More...
const string	projectVersion = "v0.4.3"
	The project version. More...
const string	projectAbout
	Project summary. More...
const char	csvDelimiter = '\t'
	The csv delimiter character. Avoid using comma because some data is serialized to include commas, and LogLoader cannot yet handle cases where commas are not just a delimiter character. More...
const string	csvComment = "#"
	The csv comment character denotes lines which are not CSV data. More...
const string	csvXmlCommentTag = " XML:"
	The csv xml comment tag identifies which line the associated XML settings file name is stored. More...

Properties
static string	logFileDirectory [get]
	Gets the log file directory. More...
static string	navigationPluginDirectory [get]
	Gets the navigation plugin directory. More...
static char[]	invalidFileNameChars [get]
	Gets the invalid file name chars. More...
static char[]	invalidPathChars [get]
	Gets the invalid path chars. More...
static string	newline [get]
	Gets the newline. More...

Static Private Attributes
static char[]	_invalidFileNameChars
static char[]	_invalidPathChars

Detailed Description

A utility class for strings used in this project.

Definition at line 9 of file Strings.cs.

Member Function Documentation

static bool Strings.IsDigitsOnly ( string  str )

static

Determines if is digits only the specified str.

Returns

true if is digits only the specified str; otherwise, false.

Parameters

str

String.

Definition at line 106 of file Strings.cs.

                                                {
        foreach (char c in str) {
            if (c < '0' || c > '9') {
                return false;
            }
        }
        return true;
    }

Here is the caller graph for this function:

Member Data Documentation

char [] Strings._invalidFileNameChars

staticprivate

Definition at line 90 of file Strings.cs.

char [] Strings._invalidPathChars

staticprivate

Definition at line 91 of file Strings.cs.

const string Strings.csvComment = "#"

The csv comment character denotes lines which are not CSV data.

Definition at line 40 of file Strings.cs.

const char Strings.csvDelimiter = '\t'

The csv delimiter character. Avoid using comma because some data is serialized to include commas, and LogLoader cannot yet handle cases where commas are not just a delimiter character.

Definition at line 35 of file Strings.cs.

const string Strings.csvXmlCommentTag = " XML:"

The csv xml comment tag identifies which line the associated XML settings file name is stored.

Definition at line 46 of file Strings.cs.

const string Strings.projectAbout

Initial value:

= 
        "BotNavSim is a master's research project exploring the use of Unity3D for " + 
        "developing robot simulations. The project is developed at Loughborough University " + 
        "by undergraduate Matt Blickem."

Project summary.

Definition at line 24 of file Strings.cs.

const string Strings.projectTitle = "BotNavSim"

The project title.

Definition at line 14 of file Strings.cs.

const string Strings.projectVersion = "v0.4.3"

The project version.

Definition at line 19 of file Strings.cs.

Property Documentation

char [] Strings.invalidFileNameChars

staticget

Gets the invalid file name chars.

The invalid file name chars.

Definition at line 68 of file Strings.cs.

char [] Strings.invalidPathChars

staticget

Gets the invalid path chars.

The invalid path chars.

Definition at line 81 of file Strings.cs.

string Strings.logFileDirectory

staticget

Gets the log file directory.

The log file directory.

Definition at line 52 of file Strings.cs.

string Strings.navigationPluginDirectory

staticget

Gets the navigation plugin directory.

The navigation plugin directory.

Definition at line 60 of file Strings.cs.

string Strings.newline

staticget

Gets the newline.

The newline.

Definition at line 97 of file Strings.cs.

---

The documentation for this class was generated from the following file:

• Assets/botnavsim/Scripts/UI/Strings.cs