Skip to content

Reader

class Reader < Object

Abstract reader.

Member Functions

Name Description
getObject Get this as an object.
getLength Get the length of 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.
getObject Get an object.
getLength Get the length of an array.
getBoolean Get a Boolean.
getInteger Get an integer.
getReal Get a real.
getString Get a string.
getBooleanVector Get a vector of Booleans.
getIntegerVector Get a vector of integers.
getRealVector Get a vector of reals.
getBooleanMatrix Get a matrix of Booleans.
getIntegerMatrix Get a matrix of integers.
getRealMatrix Get a matrix of reals.
getObject Get an object.
getLength Get the length of an array.
getBoolean Get a Boolean.
getInteger Get an integer.
getReal Get a real.
getString Get a string.
getBooleanVector Get a vector of Booleans.
getIntegerVector Get a vector of integers.
getRealVector Get a vector of reals.
getBooleanMatrix Get a matrix of Booleans.
getIntegerMatrix Get a matrix of integers.
getRealMatrix Get a matrix of reals.

Member Fibers

Name Description
getArray Get this as an array.
getArray Get an array.
getArray Get an array.

Member Function Details

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 Boolean.

  • name: Name of the entry.

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

function getBoolean(path:[String]) -> Boolean?

Get a Boolean.

  • path: Path of the entry.

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 matrix of Booleans.

  • name: Name of the entry.

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(path:[String]) -> Boolean[_,_]?

Get a matrix of Booleans.

  • path: Path of the entry.

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 vector of Booleans.

  • name: Name of the entry.

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

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

Get a vector of Booleans.

  • path: Path of the entry.

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

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 an integer.

  • name: Name of the entry.

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

function getInteger(path:[String]) -> Integer?

Get an integer.

  • path: Path of the entry.

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 matrix of integers.

  • name: Name of the entry.

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(path:[String]) -> Integer[_,_]?

Get a matrix of integers.

  • path: Path of the entry.

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 vector of integers.

  • name: Name of the entry.

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

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

Get a vector of integers.

  • path: Path of the entry.

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

getLength

function getLength() -> Integer?

Get the length of an array.

Return: An optional with a value giving the length if this is an array.

function getLength(name:String) -> Integer?

Get the length of an array.

  • name: Name of the entry.

Return: An optional with a value giving the length if the given entry is an array.

function getLength(path:[String]) -> Integer?

Get the length of an array.

  • path: Path of the entry.

Return: An optional with a value giving the length if the given entry is an array.

getObject

function getObject() -> Reader?

Get this as an object.

function getObject(name:String) -> Reader?

Get an object.

  • name: Name of the entry.

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

function getObject(path:[String]) -> Reader?

Get an object.

  • path: Path of the entry.

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 real.

  • name: Name of the entry.

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

function getReal(path:[String]) -> Real?

Get a real.

  • path: Path of the entry.

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 matrix of reals.

  • name: Name of the entry.

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(path:[String]) -> Real[_,_]?

Get a matrix of reals.

  • path: Path of the entry.

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 vector of reals.

  • name: Name of the entry.

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

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

Get a vector of reals.

  • path: Path of the entry.

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 string.

  • name: Name of the entry.

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

function getString(path:[String]) -> String?

Get a string.

  • path: Path of the entry.

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

Member Fiber Details

getArray

fiber getArray() -> Reader

Get this as an array.

Return: a fiber object that yields each of the elements of the array in turn, or which never yields if this is an empty array or not an array at all.

fiber getArray(name:String) -> Reader

Get an array.

  • name: Name of the entry.

Return: a fiber object that yields each of the elements of the array in turn, or which never yields if this is an empty array or not an array at all.

fiber getArray(path:[String]) -> Reader

Get an array.

  • path: Path of the entry.

Return: a fiber object that yields each of the elements of the array in turn, or which never yields if this is an empty array or not an array at all.