UtilityG (API V2.11)

repast.simphony.relogo.UtilityG

ReLogo Utility (Groovy) class.
Authors:
jozik

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static void`	`beep()` Sounds an audible tone.
	`static String`	`capitalize(String s)` Capitalizes a string.
	`static void`	`checkAndSetWritable()`
	`static void`	`dressClosure()`
	`static boolean`	`fileAtEndQ()` Queries if at end of the file.
	`static void`	`fileClose()` Closes a file.
	`static void`	`fileCloseAll()` Closes all files.
	`static void`	`fileDelete(String string)` Deletes a file.
	`static boolean`	`fileExistsQ(String string)` Queries if the file exists.
	`static void`	`fileFlush()` Writes the file to disk.
	`static void`	`fileOpen(String string)` Opens a file.
	`static void`	`filePrint(Object value)` Prints a value to the current file with a newline.
	`static def`	`fileRead()` Returns the next value from the current file.
	`static String`	`fileReadCharacters(int number)` Returns a number of characters from the current file.
	`static String`	`fileReadLine()` Returns the next line from the current file.
	`static void`	`fileShowU(String id, Object value)` Prints value with agent identifier to current file with a newline.
	`static void`	`fileType(Object value)` Prints value to current file without a newline.
	`static void`	`fileWrite(Object value)` Writes a value to the current file so that fileRead can subsequently read it.
`<E>`	`static Collection<E>`	`filter(Closure closure, Collection<E> a)` Returns a list filtered by a closure.
	`static void`	`foreach(Closure commands, Collection c)` Executes a set of commands for each item in a collection.
	`static void`	`foreach(Closure commands, List... lists)` Executes a set of commands for each slice of items across the lists.
	`static Collection`	`gflatten(Collection c)`
	`static def`	`ifelseValue(Closure conditional, Closure closure1, Closure closure2)` Returns the value of the first or second set of commands depending on the conditional.
	`static ArrayList`	`list(Object... args)` Returns a list of items.
	`static Collection`	`map(Closure commands, Collection c)` Executes a set of commands for each item in a collection and returns the resulting collection.
	`static ArrayList`	`map(Closure commands, List... lists)` Executes a set of commands for each slice of items across the lists and returns the results.
	`static List`	`modes(Collection c)` Returns the mode(s) of a collection of numbers.
	`static void`	`print(Object value)` Prints an object.
	`static def`	`readFromString(String string)` Interprets a string and returns the value.
`<E>`	`static E`	`reduce(Closure closure, List<E> list)` Returns a reduced list by repeatedly applying a closure to pairs of inputs.
	`static void`	`runU(String string, Object o)` Interprets a string as commands then runs the commands using an object's bindings.
	`static Object`	`runresultU(String string, Object o)` Interprets a string as a command using an object's bindings then returns the result.
	`static void`	`setCurrentDirectory(String string)` Sets the current directory to string.
	`static void`	`showU(String id, Object value)` Prints value in the Console, preceded by the calling agent, and followed by a carriage return.
`<E>`	`static List<E>`	`sortBy(Closure closure, Collection<E> c)` Returns a list sorted by a closure.
	`static void`	`type(Object value)` Prints a value to the console without a newline.
	`static String`	`userDirectory()` Allows the user to choose a user directory and returns the directory path.
	`static String`	`userFile()` Allows the user to choose a user file and returns the file path.
	`static String`	`userInput(Object value)` Returns a value that the user enters.
	`static void`	`userMessage(Object value)` Displays a message to the user.
	`static String`	`userNewFile()` Returns a new file chosen by the user.
	`static Object`	`userOneOf(Object value, Object[] list)` Returns an object that the user chose from a list.
	`static boolean`	`userYesOrNoQ(Object value)` Queries for user's answer to a question.
	`static void`	`write(Object value)` Writes a value (enclosed in quotes) to the console without a newline.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Method Detail
  - static void beep()
    
    Sounds an audible tone.
  - static String capitalize(String s)
    
    Capitalizes a string.
    Parameters:
    s - a string
    Returns:
    the capitalized string s
  - static void checkAndSetWritable()
  - static void dressClosure()
  - static boolean fileAtEndQ()
    
    Queries if at end of the file.
    Returns:
    true or false based on whether at end of the file
  - static void fileClose()
    
    Closes a file.
  - static void fileCloseAll()
    
    Closes all files.
  - static void fileDelete(String string)
    
    Deletes a file.
    Parameters:
    string - a string
  - static boolean fileExistsQ(String string)
    
    Queries if the file exists.
    Parameters:
    string - a string path
    Returns:
    true or false based on whether the file exists
  - static void fileFlush()
    
    Writes the file to disk.
  - static void fileOpen(String string)
    
    Opens a file.
    Parameters:
    string - a string path
  - static void filePrint(Object value)
    
    Prints a value to the current file with a newline.
    Parameters:
    value - an object
  - static def fileRead()
    
    Returns the next value from the current file.
    Returns:
    next value from current file
  - static String fileReadCharacters(int number)
    
    Returns a number of characters from the current file.
    Parameters:
    number - an integer
    Returns:
    number of characters from the current file
  - static String fileReadLine()
    
    Returns the next line from the current file.
    Returns:
    next line from the current file
  - static void fileShowU(String id, Object value)
    
    Prints value with agent identifier to current file with a newline.
    exclude:
    
    Parameters:
    id - a string
    value - any object
  - static void fileType(Object value)
    
    Prints value to current file without a newline.
    Parameters:
    value - any object
  - static void fileWrite(Object value)
    
    Writes a value to the current file so that fileRead can subsequently read it.
    Parameters:
    value - any object
  - <E> static Collection<E> filter(Closure closure, Collection<E> a)
    
    Returns a list filtered by a closure.
    Parameters:
    closure - boolean closure
    a - a collection
    Returns:
    the filtered collection consisting of items satisfying the closure
  - static void foreach(Closure commands, Collection c)
    
    Executes a set of commands for each item in a collection.
    Parameters:
    commands - a set of commands
    c - a collection
  - static void foreach(Closure commands, List... lists)
    
    Executes a set of commands for each slice of items across the lists.
    Parameters:
    commands - a set of commands
    lists - a list of lists
  - static Collection gflatten(Collection c)
  - static def ifelseValue(Closure conditional, Closure closure1, Closure closure2)
    
    Returns the value of the first or second set of commands depending on the conditional.
    Parameters:
    conditional - a boolean closure
    closure1 - a closure returning a value
    closure2 - a closure returning a value
    Returns:
    the value returned by closure1 or closure2 depending on the conditional
  - static ArrayList list(Object... args)
    
    Returns a list of items.
    Parameters:
    args - any number of items
    Returns:
    list of items
  - static Collection map(Closure commands, Collection c)
    
    Executes a set of commands for each item in a collection and returns the resulting collection.
    Parameters:
    commands - a set of commands
    c - a collection
    Returns:
    collection resulting from executing the set of commands on each item in the collection
  - static ArrayList map(Closure commands, List... lists)
    
    Executes a set of commands for each slice of items across the lists and returns the results.
    Parameters:
    commands - a set of commands
    lists - a list of lists
    Returns:
    list resulting from executing the set of commands on each slice of items across the lists
  - static List modes(Collection c)
    
    Returns the mode(s) of a collection of numbers.
    Parameters:
    c - a collection of numbers
    Returns:
    a list of the mode(s) of collection c
  - static void print(Object value)
    
    Prints an object.
    Parameters:
    value - an object
  - static def readFromString(String string)
    
    Interprets a string and returns the value.
    Parameters:
    string - a string
    Returns:
    returns the result of reading the string
  - <E> static E reduce(Closure closure, List<E> list)
    
    Returns a reduced list by repeatedly applying a closure to pairs of inputs. e.g., reduce({a, b -> a * b }, [3, 1, 3, 2]) results in (((3 * 1) * 3) * 2)
    Parameters:
    closure - a command
    list - a list
    Returns:
    reduced list by applying closure in a pairwise fashion to list
  - static void runU(String string, Object o)
    
    Interprets a string as commands then runs the commands using an object's bindings.
    Parameters:
    string - a string
    o - an object
  - static Object runresultU(String string, Object o)
    
    Interprets a string as a command using an object's bindings then returns the result.
    Parameters:
    string - a string
    o - an object
    Returns:
    result of interpreting string
  - static void setCurrentDirectory(String string)
    
    Sets the current directory to string.
    Parameters:
    string - a string
  - static void showU(String id, Object value)
    
    Prints value in the Console, preceded by the calling agent, and followed by a carriage return. (The calling agent is included to help you keep track of what agents are producing which lines of output.) Also, all strings have their quotes included similar to write.
  - <E> static List<E> sortBy(Closure closure, Collection<E> c)
    
    Returns a list sorted by a closure. The closure can be a single parameter closure, in which case the value returned is used to order the entities in ascending order. The closure can also have two parameters, in which case returning a negative integer, zero, or a positive integer when the first parameter is less than, equal to, or greater than the second respectively. See also: http://groovy.codehaus.org/groovy-jdk/java/util/Collection.html#sort(groovy.lang.Closure) e.g., ["a","abc","ab"].sort { a -> a.length() } or ["a","abc","ab"].sort { a,b -> a.length() <=> b.length() } both yield ["a","ab","abc"]
    Parameters:
    closure - closure taking one or two arguments
    c - a collection
    Returns:
    list sorted by the closure
  - static void type(Object value)
    
    Prints a value to the console without a newline.
    Parameters:
    value - any object
  - static String userDirectory()
    
    Allows the user to choose a user directory and returns the directory path.
    Returns:
    the chosen directory's absolute path
  - static String userFile()
    
    Allows the user to choose a user file and returns the file path.
    Returns:
    the chosen file's absolute path
  - static String userInput(Object value)
    
    Returns a value that the user enters.
    returns:
    string input by user
    
    Parameters:
    value - the title of the dialog screen
  - static void userMessage(Object value)
    
    Displays a message to the user.
    Parameters:
    value - message
  - static String userNewFile()
    
    Returns a new file chosen by the user.
    Returns:
    new file's absolute path
  - static Object userOneOf(Object value, Object[] list)
    
    Returns an object that the user chose from a list.
    Parameters:
    value - message
    list - list
    Returns:
    object that the user chose from list
  - static boolean userYesOrNoQ(Object value)
    
    Queries for user's answer to a question.
    Parameters:
    value - question
    Returns:
    true or false based on the user's answer to value
  - static void write(Object value)
    
    Writes a value (enclosed in quotes) to the console without a newline.
    Parameters:
    value - an object

Summary:
Method

| Detail:
Method

ReLogo API V2.11

[Groovy] Class UtilityG

Methods Summary

Inherited Methods Summary

Method Detail

static void beep()

static String capitalize(String s)

static void checkAndSetWritable()

static void dressClosure()

static boolean fileAtEndQ()

static void fileClose()

static void fileCloseAll()

static void fileDelete(String string)

static boolean fileExistsQ(String string)

static void fileFlush()

static void fileOpen(String string)

static void filePrint(Object value)

static def fileRead()

static String fileReadCharacters(int number)

static String fileReadLine()

static void fileShowU(String id, Object value)

static void fileType(Object value)

static void fileWrite(Object value)

<E> static Collection<E> filter(Closure closure, Collection<E> a)

static void foreach(Closure commands, Collection c)

static void foreach(Closure commands, List... lists)

static Collection gflatten(Collection c)

static def ifelseValue(Closure conditional, Closure closure1, Closure closure2)

static ArrayList list(Object... args)

static Collection map(Closure commands, Collection c)

static ArrayList map(Closure commands, List... lists)

static List modes(Collection c)

static void print(Object value)

static def readFromString(String string)

<E> static E reduce(Closure closure, List<E> list)

static void runU(String string, Object o)

static Object runresultU(String string, Object o)

static void setCurrentDirectory(String string)

static void showU(String id, Object value)

<E> static List<E> sortBy(Closure closure, Collection<E> c)

static void type(Object value)

static String userDirectory()

static String userFile()

static String userInput(Object value)

static void userMessage(Object value)

static String userNewFile()

static Object userOneOf(Object value, Object[] list)

static boolean userYesOrNoQ(Object value)

static void write(Object value)