Buffer

---

final class Buffer

Buffer in memory.

Factory Functions

Name	Description
Buffer	Create a Buffer.
Buffer	Create a Buffer.

Member Variables

Name	Description
value:Value	Value contained in this buffer.

Member Functions

Name	Description
getChild	Get a child.
setChild	Set child.
push	Push a new element onto the end of an array.
size	Get the size of an array.
clear	Clear all contents.
walk	Iterate through the elements of an array.
walk	Iterate through the elements of a child array.
getObject	Get this as an object.
getArray	Get this as an array.
getBoolean	Get this as a Boolean.
getInteger	Get this as an integer.
getReal	Get this as a real.
getString	Get this as a string.
getBooleanVector	Get this as a vector of Booleans.
getIntegerVector	Get this as a vector of integers.
getRealVector	Get this as a vector of reals.
getBooleanMatrix	Get this as a matrix of Booleans.
getIntegerMatrix	Get this as a matrix of integers.
getRealMatrix	Get this as a matrix of reals.
getLLT	Get this as a positive definite symmetric matrix of reals.
size	Get the size of an array.
getObject	Get a child as an object.
getArray	Get a child as an array.
getBoolean	Get a child as a Boolean.
getInteger	Get a child as an integer.
getReal	Get a child as a real.
getString	Get a child as a string.
getBooleanVector	Get a child as a vector of Booleans.
getIntegerVector	Get a child as a vector of integers.
getRealVector	Get a child as a vector of reals.
getBooleanMatrix	Get a child as a matrix of Booleans.
getIntegerMatrix	Get a child as a matrix of integers.
getRealMatrix	Get a child as a matrix of reals.
getLLT	Get a child as a symmetric positive definite matrix.
get	Get this as an object.
get	Get this as a Boolean.
get	Get this as an integer.
get	Get this as a real.
get	Get this as a string.
get	Get this as a vector of Booleans.
get	Get this as a vector of integers.
get	Get this as a vector of reals.
get	Get this as a matrix of Booleans.
get	Get this as a matrix of integers.
get	Get this as a matrix of reals.
get	Get this as a symmetric positive definite matrix of reals.
get	Get an object.
get	Get a Boolean.
get	Get an integer.
get	Get a real.
get	Get a string.
get	Get a vector of Booleans.
get	Get a vector of integers.
get	Get a vector of reals.
get	Get a matrix of Booleans.
get	Get a matrix of integers.
get	Get a matrix of reals.
get	Get a symmetric positive definite matrix of reals.
setObject	Set this as an object.
setArray	Set this as an array.
setNil	Set this as nil.
setBoolean	Set this as a Boolean.
setInteger	Set this as an integer.
setReal	Set this as a real.
setString	Set this as a string.
setBooleanVector	Set this as a vector of Booleans.
setIntegerVector	Set this as a vector of integers.
setRealVector	Set this as a vector of reals.
setObjectVector	Set this as a vector of objects.
setBooleanMatrix	Set this as matrix of Booleans.
setIntegerMatrix	Set this as a matrix of integers.
setRealMatrix	Set this as a matrix of reals.
setLLT	Set this as a symmetric positive definite matrix of reals.
setObjectMatrix	Set this as a matrix of objects.
setObject	Set child as an object.
setArray	Set child as an array.
setNil	Set child as nil.
setBoolean	Set child as a Boolean.
setInteger	Set child as an integer.
setReal	Set child as a real.
setString	Set child as a string.
setBooleanVector	Set child as a vector of Booleans.
setIntegerVector	Set child as a vector of integers.
setRealVector	Set child as a vector of reals.
setObjectVector	Set child as a vector of objects.
setBooleanMatrix	Set child as a matrix of Booleans.
setIntegerMatrix	Set child as a matrix of integers.
setRealMatrix	Set child as a matrix of reals.
setLLT	Set child as a symmetric positive definite matrix of reals.
setObjectMatrix	Set child as a matrix of objects.
set	Set this as a Boolean.
set	Set this as an integer.
set	Set this as a real.
set	Set this as a string.
set	Set this as an object.
set	Set this as a vector of Booleans.
set	Set this as a vector of integers.
set	Set this as a vector of reals.
set	Set this as a vector of objects.
set	Set this as matrix of Booleans.
set	Set this as a matrix of integers.
set	Set this as a matrix of reals.
set	Set this as a symmetric positive definite matrix of reals.
set	Set this as a matrix of objects.
set	Set a Boolean.
set	Set an integer.
set	Set a real.
set	Set a string.
set	Set an object.
set	Set a vector of Booleans.
set	Set a vector of integers.
set	Set a vector of reals.
set	Set a vector of objects.
set	Set a matrix of Booleans.
set	Set a matrix of integers.
set	Set a matrix of reals.
set	Set a symmetric positive definite matrix of reals.
set	Set a matrix of objects.

Factory Function Details

function Buffer(root:Value) -> Buffer

Create a Buffer.

• root: Root element.

function Buffer() -> Buffer

Create a Buffer.

Member Function Details

clear

function clear()

Clear all contents.

get

function get(value:Object?) -> Object?

Get this as an object.

• value: The object.

Return: The object.

function get(value:Boolean?) -> Boolean?

Get this as a Boolean.

• value: Unused, but necessary for overload resolution.

Return: An optional with a value if this is of a compatible type.

function get(value:Integer?) -> Integer?

Get this as an integer.

• value: Unused, but necessary for overload resolution.

Return: An optional with a value if this is of a compatible type.

function get(value:Real?) -> Real?

Get this as a real.

• value: Unused, but necessary for overload resolution.

Return: An optional with a value if this is of a compatible type.

function get(value:String?) -> String?

Get this as a string.

• value: Unused, but necessary for overload resolution.

Return: An optional with a value if this is of a compatible type.

function get(value:Boolean[_]?) -> Boolean[_]?

Get this as a vector of Booleans.

• value: Unused, but necessary for overload resolution.

Return: An optional with a value if this is an array with all elements of a compatible type.

function get(value:Integer[_]?) -> Integer[_]?

Get this as a vector of integers.

• value: Unused, but necessary for overload resolution.

Return: An optional with a value if this is an array with all elements of a compatible type.

function get(value:Real[_]?) -> Real[_]?

Get this as a vector of reals.

• value: Unused, but necessary for overload resolution.

Return: An optional with a value if this is an array with all elements of a compatible type.

function get(value:Boolean[_,_]?) -> Boolean[_,_]?

Get this as a matrix of Booleans.

• value: Unused, but necessary for overload resolution.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

function get(value:Integer[_,_]?) -> Integer[_,_]?

Get this as a matrix of integers.

• value: Unused, but necessary for overload resolution.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

function get(value:Real[_,_]?) -> Real[_,_]?

Get this as a matrix of reals.

• value: Unused, but necessary for overload resolution.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

function get(value:LLT?) -> LLT?

Get this as a symmetric positive definite matrix of reals.

• value: Unused, but necessary for overload resolution.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

function get(name:String, value:Object?) -> Object?

Get an object.

• name: Name of the child.
• value: The object.

Return: The object.

function get(name:String, value:Boolean?) -> Boolean?

Get a Boolean.

• name: Name of the child.
• value: Unused, but necessary for overload resolution.

Return: An optional with a value if the given entry exists and is of a compatible type.

function get(name:String, value:Integer?) -> Integer?

Get an integer.

• name: Name of the child.
• value: Unused, but necessary for overload resolution.

Return: An optional with a value if the given entry exists and is of a compatible type.

function get(name:String, value:Real?) -> Real?

Get a real.

• name: Name of the child.
• value: Unused, but necessary for overload resolution.

Return: An optional with a value if the given entry exists and is of a compatible type.

function get(name:String, value:String?) -> String?

Get a string.

• name: Name of the child.
• value: Unused, but necessary for overload resolution.

Return: An optional with a value if the given entry exists and is of a compatible type.

function get(name:String, value:Boolean[_]?) -> Boolean[_]?

Get a vector of Booleans.

• name: Name of the child.
• value: Unused, but necessary for overload resolution.

Return: An optional with a value if this is an array with all elements of a compatible type.

function get(name:String, value:Integer[_]?) -> Integer[_]?

Get a vector of integers.

• name: Name of the child.
• value: Unused, but necessary for overload resolution.

Return: An optional with a value if this is an array with all elements of a compatible type.

function get(name:String, value:Real[_]?) -> Real[_]?

Get a vector of reals.

• name: Name of the child.
• value: Unused, but necessary for overload resolution.

Return: An optional with a value if this is an array with all elements of a compatible type.

function get(name:String, value:Boolean[_,_]?) -> Boolean[_,_]?

Get a matrix of Booleans.

• name: Name of the child.
• value: Unused, but necessary for overload resolution.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

function get(name:String, value:Integer[_,_]?) -> Integer[_,_]?

Get a matrix of integers.

• name: Name of the child.
• value: Unused, but necessary for overload resolution.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

function get(name:String, value:Real[_,_]?) -> Real[_,_]?

Get a matrix of reals.

• name: Name of the child.
• value: Unused, but necessary for overload resolution.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

function get(name:String, value:LLT?) -> LLT?

Get a symmetric positive definite matrix of reals.

• name: Name of the child.
• value: Unused, but necessary for overload resolution.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

getArray

function getArray() -> Buffer?

Get this as an array.

function getArray(name:String) -> Buffer?

Get a child as an array.

• name: Name of the child.

Return: An optional with a value if the given entry exists and is of a compatible type.

getBoolean

function getBoolean() -> Boolean?

Get this as a Boolean.

Return: An optional with a value if this is of a compatible type.

function getBoolean(name:String) -> Boolean?

Get a child as a Boolean.

• name: Name of the child.

Return: An optional with a value if the given entry exists and is of a compatible type.

getBooleanMatrix

function getBooleanMatrix() -> Boolean[_,_]?

Get this as a matrix of Booleans.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

function getBooleanMatrix(name:String) -> Boolean[_,_]?

Get a child as a matrix of Booleans.

• name: Name of the child.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

getBooleanVector

function getBooleanVector() -> Boolean[_]?

Get this as a vector of Booleans.

Return: An optional with a value if this is an array with all elements of a compatible type.

function getBooleanVector(name:String) -> Boolean[_]?

Get a child as a vector of Booleans.

• name: Name of the child.

Return: An optional with a value if this is an array with all elements of a compatible type.

getChild

function getChild(name:String) -> Buffer?

Get a child.

getInteger

function getInteger() -> Integer?

Get this as an integer.

Return: An optional with a value if this is of a compatible type.

function getInteger(name:String) -> Integer?

Get a child as an integer.

• name: Name of the child.

Return: An optional with a value if the given entry exists and is of a compatible type.

getIntegerMatrix

function getIntegerMatrix() -> Integer[_,_]?

Get this as a matrix of integers.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

function getIntegerMatrix(name:String) -> Integer[_,_]?

Get a child as a matrix of integers.

• name: Name of the child.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

getIntegerVector

function getIntegerVector() -> Integer[_]?

Get this as a vector of integers.

Return: An optional with a value if this is an array with all elements of a compatible type.

function getIntegerVector(name:String) -> Integer[_]?

Get a child as a vector of integers.

• name: Name of the child.

Return: An optional with a value if this is an array with all elements of a compatible type.

getLLT

function getLLT() -> LLT?

Get this as a positive definite symmetric matrix of reals.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

function getLLT(name:String) -> LLT?

Get a child as a symmetric positive definite matrix.

• name: Name of the child.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

getObject

function getObject() -> Buffer?

Get this as an object. This is an identity function, returning this, as object of class type use their read() and write() member functions to read and write to buffers as they please.

function getObject(name:String) -> Buffer?

Get a child as an object.

• name: Name of the child.

Return: An optional with a value if the given entry exists and is of a compatible type.

getReal

function getReal() -> Real?

Get this as a real.

Return: An optional with a value if this is of a compatible type.

function getReal(name:String) -> Real?

Get a child as a real.

• name: Name of the child.

Return: An optional with a value if the given entry exists and is of a compatible type.

getRealMatrix

function getRealMatrix() -> Real[_,_]?

Get this as a matrix of reals.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

function getRealMatrix(name:String) -> Real[_,_]?

Get a child as a matrix of reals.

• name: Name of the child.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

getRealVector

function getRealVector() -> Real[_]?

Get this as a vector of reals.

Return: An optional with a value if this is an array with all elements of a compatible type.

function getRealVector(name:String) -> Real[_]?

Get a child as a vector of reals.

• name: Name of the child.

Return: An optional with a value if this is an array with all elements of a compatible type.

getString

function getString() -> String?

Get this as a string.

Return: An optional with a value if this is of a compatible type.

function getString(name:String) -> String?

Get a child as a string.

• name: Name of the child.

Return: An optional with a value if the given entry exists and is of a compatible type.

push

function push() -> Buffer

Push a new element onto the end of an array.

set

function set(value:Boolean)

Set this as a Boolean.

• value: Value.

function set(value:Integer)

Set this as an integer.

• value: Value.

function set(value:Real)

Set this as a real.

• value: Value.

function set(value:String)

Set this as a string.

• value: Value.

function set(value:Object)

Set this as an object.

• value: Value.

function set(value:Boolean[_])

Set this as a vector of Booleans.

• value: Value.

function set(value:Integer[_])

Set this as a vector of integers.

• value: Value.

function set(value:Real[_])

Set this as a vector of reals.

• value: Value.

function set(value:Object[_])

Set this as a vector of objects.

• value: Value.

function set(value:Boolean[_,_])

Set this as matrix of Booleans.

• value: Value.

function set(value:Integer[_,_])

Set this as a matrix of integers.

• value: Value.

function set(value:Real[_,_])

Set this as a matrix of reals.

• value: Value.

function set(value:LLT)

Set this as a symmetric positive definite matrix of reals.

• value: Value.

function set(value:Object[_,_])

Set this as a matrix of objects.

• value: Value.

function set(name:String, value:Boolean)

Set a Boolean.

• name: Name of the child.
• value: Value.

function set(name:String, value:Integer)

Set an integer.

• name: Name of the child.
• value: Value.

function set(name:String, value:Real)

Set a real.

• name: Name of the child.
• value: Value.

function set(name:String, value:String)

Set a string.

• name: Name of the child.
• value: Value.

function set(name:String, value:Object)

Set an object.

• name: Name of the child.
• value: Value.

function set(name:String, value:Boolean[_])

Set a vector of Booleans.

• name: Name of the child.
• value: Value.

function set(name:String, value:Integer[_])

Set a vector of integers.

• name: Name of the child.
• value: Value.

function set(name:String, value:Real[_])

Set a vector of reals.

• name: Name of the child.
• value: Value.

function set(name:String, value:Object[_])

Set a vector of objects.

• name: Name of the child.
• value: Value.

function set(name:String, value:Boolean[_,_])

Set a matrix of Booleans.

• name: Name of the child.
• value: Value.

function set(name:String, value:Integer[_,_])

Set a matrix of integers.

• name: Name of the child.
• value: Value.

function set(name:String, value:Real[_,_])

Set a matrix of reals.

• name: Name of the child.
• value: Value.

function set(name:String, value:LLT)

Set a symmetric positive definite matrix of reals.

• name: Name of the child.
• value: Value.

function set(name:String, value:Object[_,_])

Set a matrix of objects.

• name: Name of the child.
• value: Value.

setArray

function setArray() -> Buffer

Set this as an array.

function setArray(name:String) -> Buffer

Set child as an array.

• name: Name of the child.

setBoolean

function setBoolean(value:Boolean)

Set this as a Boolean.

• value: Value.

function setBoolean(name:String, value:Boolean)

Set child as a Boolean.

• name: Name of the child.
• value: Value.

setBooleanMatrix

function setBooleanMatrix(value:Boolean[_,_])

Set this as matrix of Booleans.

• value: Value.

function setBooleanMatrix(name:String, value:Boolean[_,_])

Set child as a matrix of Booleans.

• name: Name of the child.
• value: Value.

setBooleanVector

function setBooleanVector(value:Boolean[_])

Set this as a vector of Booleans.

• value: Value.

function setBooleanVector(name:String, value:Boolean[_])

Set child as a vector of Booleans.

• name: Name of the child.
• value: Value.

setChild

function setChild(name:String) -> Buffer

Set child.

setInteger

function setInteger(value:Integer)

Set this as an integer.

• value: Value.

function setInteger(name:String, value:Integer)

Set child as an integer.

• name: Name of the child.
• value: Value.

setIntegerMatrix

function setIntegerMatrix(value:Integer[_,_])

Set this as a matrix of integers.

• value: Value.

function setIntegerMatrix(name:String, value:Integer[_,_])

Set child as a matrix of integers.

• name: Name of the child.
• value: Value.

setIntegerVector

function setIntegerVector(value:Integer[_])

Set this as a vector of integers.

• value: Value.

function setIntegerVector(name:String, value:Integer[_])

Set child as a vector of integers.

• name: Name of the child.
• value: Value.

setLLT

function setLLT(value:LLT)

Set this as a symmetric positive definite matrix of reals.

• value: Value.

function setLLT(name:String, value:LLT)

Set child as a symmetric positive definite matrix of reals.

• name: Name of the child.
• value: Value.

setNil

function setNil()

Set this as nil.

function setNil(name:String)

Set child as nil.

• name: Name of the child.

setObject

function setObject() -> Buffer

Set this as an object.

function setObject(name:String) -> Buffer

Set child as an object.

• name: Name of the child.

setObjectMatrix

function setObjectMatrix(value:Object[_,_])

Set this as a matrix of objects.

• value: Value.

function setObjectMatrix(name:String, value:Object[_,_])

Set child as a matrix of objects.

• name: Name of the child.
• value: Value.

setObjectVector

function setObjectVector(value:Object[_])

Set this as a vector of objects.

• value: Value.

function setObjectVector(name:String, value:Object[_])

Set child as a vector of objects.

• name: Name of the child.
• value: Value.

setReal

function setReal(value:Real)

Set this as a real.

• value: Value.

function setReal(name:String, value:Real)

Set child as a real.

• name: Name of the child.
• value: Value.

setRealMatrix

function setRealMatrix(value:Real[_,_])

Set this as a matrix of reals.

• value: Value.

function setRealMatrix(name:String, value:Real[_,_])

Set child as a matrix of reals.

• name: Name of the child.
• value: Value.

setRealVector

function setRealVector(value:Real[_])

Set this as a vector of reals.

• value: Value.

function setRealVector(name:String, value:Real[_])

Set child as a vector of reals.

• name: Name of the child.
• value: Value.

setString

function setString(value:String)

Set this as a string.

• value: Value.

function setString(name:String, value:String)

Set child as a string.

• name: Name of the child.
• value: Value.

size

function size() -> Integer

Get the size of an array.

function size(name:String) -> Integer

Get the size of an array.

walk

function walk() -> Iterator<Buffer>

Iterate through the elements of an array.

function walk(name:String) -> Iterator<Buffer>

Iterate through the elements of a child array.

• name: Name of the child.