BaseObserver (API V2.11)

repast.simphony.relogo.BaseObserver

Field Summary

Fields
Modifiers	Name	Description
`protected static long`	`serialVersionUID`	This value is used to automatically generate agent identifiers.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`AgentSet<Turtle>`	`createOrderedTurtlesFromCSV(String fileName, Closure initClosure = null)` Creates default ordered turtles from a CSV file.
`<E extends ReLogoAgent>`	`AgentSet<E>`	`createOrderedTurtlesFromCSV(String fileName, Class<E> turtleType, Closure initClosure = null)` Creates ordered turtles of specific type from a CSV file.
	`AgentSet<Turtle>`	`createOrderedTurtlesFromExcel(String fileName, Closure initClosure = null)` Creates ordered default turtles from the first sheet of an Excel file.
`<E extends ReLogoAgent>`	`AgentSet<E>`	`createOrderedTurtlesFromExcel(String fileName, Class<E> turtleType, Closure initClosure = null)` Creates ordered turtles of specific type from the first sheet of an Excel file.
	`AgentSet<Turtle>`	`createOrderedTurtlesFromExcelWithSheet(String fileName, String sheetName, Closure initClosure = null)` Creates ordered default turtles from a specific sheet in an Excel file.
`<E extends ReLogoAgent>`	`AgentSet<E>`	`createOrderedTurtlesFromExcelWithSheet(String fileName, String sheetName, Class<E> turtleType, Closure initClosure = null)` Creates ordered turtles of specific type from a specific sheet in an Excel file.
	`AgentSet<Turtle>`	`createTurtlesFromCSV(String fileName, Closure initClosure = null)` Creates default turtles from a CSV file.
`<E extends ReLogoAgent>`	`AgentSet<E>`	`createTurtlesFromCSV(String fileName, Class<E> turtleType, Closure initClosure = null)` Creates turtles of specific type from a CSV file.
	`AgentSet<Turtle>`	`createTurtlesFromExcel(String fileName, Closure initClosure = null)` Creates default turtles from the first sheet of an Excel file.
`<E extends ReLogoAgent>`	`AgentSet<E>`	`createTurtlesFromExcel(String fileName, Class<E> turtleType, Closure initClosure = null)` Creates turtles of specific type from the first sheet of an Excel file.
	`AgentSet<Turtle>`	`createTurtlesFromExcelWithSheet(String fileName, String sheetName, Closure initClosure = null)` Creates default turtles from a specific sheet in an Excel file.
`<E extends ReLogoAgent>`	`AgentSet<E>`	`createTurtlesFromExcelWithSheet(String fileName, String sheetName, Class<E> turtleType, Closure initClosure = null)` Creates turtles of specific type from a specific sheet in an Excel file.
	`protected Object`	`getCellContent(Cell cell)` Get Excel cell content according to type.
	`protected List<String>`	`getPublicFieldsAndProperties(Class clazz)` Utility method to gather all the names of the public fields and properties of a class.
	`protected void`	`populateFieldValues(def t, Row row, List<String> headerFields, List<String> fieldsToUse)`
	`String`	`toString()` This method provides a human-readable name for the agent.
	`void`	`watch(Object watched)` Does nothing, included for translation compatibility.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractObserver`	allLinks, allQ, ask, ask, ask, ask, ask, askCollection, ca, clearAll, clearLinks, clearPatches, clearTrackingNetwork, clearTurtles, cp, createOrderedTurtles, createOrderedTurtles, createOrderedTurtles, createOrderedTurtles, createPatchVar, createTurtles, createTurtles, createTurtles, createTurtles, cro, cro, cro, cro, crt, crt, crt, crt, ct, diffuse, diffuse4, diffusibleAdd, diffusibleApply, diffusibleDivide, diffusibleMultiply, diffusibleSubtract, fileShow, getContext, getGrid, getLinkFactory, getMaxPxcor, getMaxPycor, getMinPxcor, getMinPycor, getNetwork, getObserverID, getPatchVarMatrix, getRLDimensions, getSpace, getTurtleFactory, initializeBaseObserver, link, link, links, maxNOf, maxOneOf, minNOf, minOneOf, oldStop, patch, patches, projectionEventOccurred, randomPxcor, randomPycor, randomXcor, randomYcor, registerModelParameterListener, run, runresult, setContext, setDefaultShape, setDefaultShape, setObserverID, setPatchVarMatrix, setRLWorldDimensions, show, toString, turtle, turtles, turtlesOn, turtlesOn, turtlesOn, worldHeight, worldWidth

- Field Detail
  - protected static final long serialVersionUID
    
    This value is used to automatically generate agent identifiers.
    field:
    serialVersionUID
- Method Detail
  - AgentSet<Turtle> createOrderedTurtlesFromCSV(String fileName, Closure initClosure = null)
    
    Creates default ordered turtles from a CSV file. Optionally provide an initialization closure.
    The format for the CSV file is:
    prop1,prop2,prop3
    val1a,val2a,val3a
    val1b,val2b,val3b
    
    Where if the turtle type has any of the properties (prop1,prop2,prop3), they will be set to (val1a,val2a,val3a) for the first turtle, (val1b,val2b,val3b) for the second turtle, and so on.
    
    Parameters:
    fileName - the path to the CSV file
    initClosure - the initialization routine
  - <E extends ReLogoAgent> AgentSet<E> createOrderedTurtlesFromCSV(String fileName, Class<E> turtleType, Closure initClosure = null)
    
    Creates ordered turtles of specific type from a CSV file. Optionally provide an initialization closure.
    The format for the CSV file is:
    prop1,prop2,prop3
    val1a,val2a,val3a
    val1b,val2b,val3b
    
    Where if the turtle type has any of the properties (prop1,prop2,prop3), they will be set to (val1a,val2a,val3a) for the first turtle, (val1b,val2b,val3b) for the second turtle, and so on.
    
    Parameters:
    fileName - the path to the CSV file
    turtleType - the class of turtle to create
    initClosure - the initialization routine
  - AgentSet<Turtle> createOrderedTurtlesFromExcel(String fileName, Closure initClosure = null)
    
    Creates ordered default turtles from the first sheet of an Excel file. Optionally provide an initialization closure.
    The format for the Excel file is:
    | prop1 | prop2 | prop3 |
    | val1a | val2a | val3a |
    | val1b | val2b | val3b |
    
    Where if the turtle type has any of the properties (prop1,prop2,prop3), they will be set to (val1a,val2a,val3a) for the first turtle, (val1b,val2b,val3b) for the second turtle, and so on.
    
    Parameters:
    fileName - the path from the default system directory
    initClosure - the initialization routine
  - <E extends ReLogoAgent> AgentSet<E> createOrderedTurtlesFromExcel(String fileName, Class<E> turtleType, Closure initClosure = null)
    
    Creates ordered turtles of specific type from the first sheet of an Excel file. Optionally provide an initialization closure.
    The format for the Excel file is:
    | prop1 | prop2 | prop3 |
    | val1a | val2a | val3a |
    | val1b | val2b | val3b |
    
    Where if the turtle type has any of the properties (prop1,prop2,prop3), they will be set to (val1a,val2a,val3a) for the first turtle, (val1b,val2b,val3b) for the second turtle, and so on.
    
    Parameters:
    fileName - the path from the default system directory
    turtleType - the class of turtle to create
    initClosure - the initialization routine
  - AgentSet<Turtle> createOrderedTurtlesFromExcelWithSheet(String fileName, String sheetName, Closure initClosure = null)
    
    Creates ordered default turtles from a specific sheet in an Excel file. Optionally provide an initialization closure.
    Parameters:
    fileName - the path from the default system directory
    sheetName - the specific sheet name
    initClosure - the initialization routine
  - <E extends ReLogoAgent> AgentSet<E> createOrderedTurtlesFromExcelWithSheet(String fileName, String sheetName, Class<E> turtleType, Closure initClosure = null)
    
    Creates ordered turtles of specific type from a specific sheet in an Excel file. Optionally provide an initialization closure.
    Parameters:
    fileName - the path from the default system directory
    sheetName - the specific sheet name
    turtleType - the class of turtle to create
    initClosure - the initialization routine
  - AgentSet<Turtle> createTurtlesFromCSV(String fileName, Closure initClosure = null)
    
    Creates default turtles from a CSV file. Optionally provide an initialization closure.
    The format for the CSV file is:
    prop1,prop2,prop3
    val1a,val2a,val3a
    val1b,val2b,val3b
    
    Where if the turtle type has any of the properties (prop1,prop2,prop3), they will be set to (val1a,val2a,val3a) for the first turtle, (val1b,val2b,val3b) for the second turtle, and so on.
    
    Parameters:
    fileName - the path to the CSV file
    initClosure - the initialization routine
  - <E extends ReLogoAgent> AgentSet<E> createTurtlesFromCSV(String fileName, Class<E> turtleType, Closure initClosure = null)
    
    Creates turtles of specific type from a CSV file. Optionally provide an initialization closure.
    The format for the CSV file is:
    prop1,prop2,prop3
    val1a,val2a,val3a
    val1b,val2b,val3b
    
    Where if the turtle type has any of the properties (prop1,prop2,prop3), they will be set to (val1a,val2a,val3a) for the first turtle, (val1b,val2b,val3b) for the second turtle, and so on.
    
    Parameters:
    fileName - the path to the CSV file
    turtleType - the class of turtle to create
    initClosure - the initialization routine
  - AgentSet<Turtle> createTurtlesFromExcel(String fileName, Closure initClosure = null)
    
    Creates default turtles from the first sheet of an Excel file. Optionally provide an initialization closure.
    The format for the Excel file is:
    | prop1 | prop2 | prop3 |
    | val1a | val2a | val3a |
    | val1b | val2b | val3b |
    
    Where if the turtle type has any of the properties (prop1,prop2,prop3), they will be set to (val1a,val2a,val3a) for the first turtle, (val1b,val2b,val3b) for the second turtle, and so on.
    
    Parameters:
    fileName - the path from the default system directory
    initClosure - the initialization routine
  - <E extends ReLogoAgent> AgentSet<E> createTurtlesFromExcel(String fileName, Class<E> turtleType, Closure initClosure = null)
    
    Creates turtles of specific type from the first sheet of an Excel file. Optionally provide an initialization closure.
    The format for the Excel file is:
    | prop1 | prop2 | prop3 |
    | val1a | val2a | val3a |
    | val1b | val2b | val3b |
    
    Where if the turtle type has any of the properties (prop1,prop2,prop3), they will be set to (val1a,val2a,val3a) for the first turtle, (val1b,val2b,val3b) for the second turtle, and so on.
    
    Parameters:
    fileName - the path from the default system directory
    turtleType - the class of turtle to create
    initClosure - the initialization routine
  - AgentSet<Turtle> createTurtlesFromExcelWithSheet(String fileName, String sheetName, Closure initClosure = null)
    
    Creates default turtles from a specific sheet in an Excel file. Optionally provide an initialization closure.
    The format for the Excel file is:
    | prop1 | prop2 | prop3 |
    | val1a | val2a | val3a |
    | val1b | val2b | val3b |
    
    Where if the turtle type has any of the properties (prop1,prop2,prop3), they will be set to (val1a,val2a,val3a) for the first turtle, (val1b,val2b,val3b) for the second turtle, and so on.
    
    Parameters:
    fileName - the path from the default system directory
    sheetName - the specific sheet name
    initClosure - the initialization routine
  - <E extends ReLogoAgent> AgentSet<E> createTurtlesFromExcelWithSheet(String fileName, String sheetName, Class<E> turtleType, Closure initClosure = null)
    
    Creates turtles of specific type from a specific sheet in an Excel file. Optionally provide an initialization closure.
    The format for the Excel file is:
    | prop1 | prop2 | prop3 |
    | val1a | val2a | val3a |
    | val1b | val2b | val3b |
    
    Where if the turtle type has any of the properties (prop1,prop2,prop3), they will be set to (val1a,val2a,val3a) for the first turtle, (val1b,val2b,val3b) for the second turtle, and so on.
    
    Parameters:
    fileName - the path from the default system directory
    sheetName - the specific sheet name
    turtleType - the class of turtle to create
    initClosure - the initialization routine
  - protected Object getCellContent(Cell cell)
    
    Get Excel cell content according to type.
    Parameters:
    cell
    Returns:
  - protected List<String> getPublicFieldsAndProperties(Class clazz)
    
    Utility method to gather all the names of the public fields and properties of a class.
    Parameters:
    clazz - class
    Returns:
    names of the public fields and properties of clazz
  - protected void populateFieldValues(def t, Row row, List<String> headerFields, List<String> fieldsToUse)
  - @ProbeID() String toString()
    
    This method provides a human-readable name for the agent.
    method:
    toString
  - void watch(Object watched)
    
    Does nothing, included for translation compatibility.

Summary:
Field
Method

| Detail:
Field
Method

ReLogo API V2.11

[Groovy] Class BaseObserver

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final long serialVersionUID

Method Detail

AgentSet<Turtle> createOrderedTurtlesFromCSV(String fileName, Closure initClosure = null)

<E extends ReLogoAgent> AgentSet<E> createOrderedTurtlesFromCSV(String fileName, Class<E> turtleType, Closure initClosure = null)

AgentSet<Turtle> createOrderedTurtlesFromExcel(String fileName, Closure initClosure = null)

<E extends ReLogoAgent> AgentSet<E> createOrderedTurtlesFromExcel(String fileName, Class<E> turtleType, Closure initClosure = null)

AgentSet<Turtle> createOrderedTurtlesFromExcelWithSheet(String fileName, String sheetName, Closure initClosure = null)

<E extends ReLogoAgent> AgentSet<E> createOrderedTurtlesFromExcelWithSheet(String fileName, String sheetName, Class<E> turtleType, Closure initClosure = null)

AgentSet<Turtle> createTurtlesFromCSV(String fileName, Closure initClosure = null)

<E extends ReLogoAgent> AgentSet<E> createTurtlesFromCSV(String fileName, Class<E> turtleType, Closure initClosure = null)

AgentSet<Turtle> createTurtlesFromExcel(String fileName, Closure initClosure = null)

<E extends ReLogoAgent> AgentSet<E> createTurtlesFromExcel(String fileName, Class<E> turtleType, Closure initClosure = null)

AgentSet<Turtle> createTurtlesFromExcelWithSheet(String fileName, String sheetName, Closure initClosure = null)

<E extends ReLogoAgent> AgentSet<E> createTurtlesFromExcelWithSheet(String fileName, String sheetName, Class<E> turtleType, Closure initClosure = null)

protected Object getCellContent(Cell cell)

protected List<String> getPublicFieldsAndProperties(Class clazz)

protected void populateFieldValues(def t, Row row, List<String> headerFields, List<String> fieldsToUse)

@ProbeID() String toString()

void watch(Object watched)