View Source Evision.FileNode (Evision v0.2.1)

Summary

Types

t()

Type that represents an FileNode struct.

Functions

empty

The constructors.

isInt

isMap

isNamed

isNone

isReal

isSeq

isString

Returns keys of a mapping node.

mat

name

rawSize

real

size

string

Returns type of the node.

Types

@type t() :: %Evision.FileNode{ref: reference()}

Type that represents an FileNode struct.

  • ref. reference()

    The underlying erlang resource variable.

Functions

@spec at(t(), integer()) :: t() | {:error, String.t()}

at

Positional Arguments
  • self: Evision.FileNode.t()

  • i: int.

    Index of an element in the sequence node.

Return
  • retval: Evision.FileNode.t()

Has overloading in C++

Python prototype (for reference only):

at(i) -> retval
@spec empty(t()) :: boolean() | {:error, String.t()}

empty

Positional Arguments
  • self: Evision.FileNode.t()
Return
  • retval: bool

Python prototype (for reference only):

empty() -> retval
@spec fileNode() :: t() | {:error, String.t()}

The constructors.

Return
  • self: Evision.FileNode.t()

These constructors are used to create a default file node, construct it from obsolete structures or from the another file node.

Python prototype (for reference only):

FileNode() -> <FileNode object>
@spec getNode(t(), binary()) :: t() | {:error, String.t()}

getNode

Positional Arguments
  • self: Evision.FileNode.t()

  • nodename: c_string.

    Name of an element in the mapping node.

Return
  • retval: Evision.FileNode.t()

Has overloading in C++

Python prototype (for reference only):

getNode(nodename) -> retval
@spec isInt(t()) :: boolean() | {:error, String.t()}

isInt

Positional Arguments
  • self: Evision.FileNode.t()
Return
  • retval: bool

Python prototype (for reference only):

isInt() -> retval
@spec isMap(t()) :: boolean() | {:error, String.t()}

isMap

Positional Arguments
  • self: Evision.FileNode.t()
Return
  • retval: bool

Python prototype (for reference only):

isMap() -> retval
@spec isNamed(t()) :: boolean() | {:error, String.t()}

isNamed

Positional Arguments
  • self: Evision.FileNode.t()
Return
  • retval: bool

Python prototype (for reference only):

isNamed() -> retval
@spec isNone(t()) :: boolean() | {:error, String.t()}

isNone

Positional Arguments
  • self: Evision.FileNode.t()
Return
  • retval: bool

Python prototype (for reference only):

isNone() -> retval
@spec isReal(t()) :: boolean() | {:error, String.t()}

isReal

Positional Arguments
  • self: Evision.FileNode.t()
Return
  • retval: bool

Python prototype (for reference only):

isReal() -> retval
@spec isSeq(t()) :: boolean() | {:error, String.t()}

isSeq

Positional Arguments
  • self: Evision.FileNode.t()
Return
  • retval: bool

Python prototype (for reference only):

isSeq() -> retval
@spec isString(t()) :: boolean() | {:error, String.t()}

isString

Positional Arguments
  • self: Evision.FileNode.t()
Return
  • retval: bool

Python prototype (for reference only):

isString() -> retval
@spec keys(t()) :: [binary()] | {:error, String.t()}

Returns keys of a mapping node.

Positional Arguments
  • self: Evision.FileNode.t()
Return
  • retval: [String]

@returns Keys of a mapping node.

Python prototype (for reference only):

keys() -> retval
@spec mat(t()) :: Evision.Mat.t() | {:error, String.t()}

mat

Positional Arguments
  • self: Evision.FileNode.t()
Return
  • retval: Evision.Mat.t()

Python prototype (for reference only):

mat() -> retval
@spec name(t()) :: binary() | {:error, String.t()}

name

Positional Arguments
  • self: Evision.FileNode.t()
Return
  • retval: string

Python prototype (for reference only):

name() -> retval
@spec rawSize(t()) :: integer() | {:error, String.t()}

rawSize

Positional Arguments
  • self: Evision.FileNode.t()
Return
  • retval: size_t

Python prototype (for reference only):

rawSize() -> retval
@spec real(t()) :: number() | {:error, String.t()}

real

Positional Arguments
  • self: Evision.FileNode.t()
Return
  • retval: double

Internal method used when reading FileStorage. Sets the type (int, real or string) and value of the previously created node.

Python prototype (for reference only):

real() -> retval
@spec size(t()) :: integer() | {:error, String.t()}

size

Positional Arguments
  • self: Evision.FileNode.t()
Return
  • retval: size_t

Python prototype (for reference only):

size() -> retval
@spec string(t()) :: binary() | {:error, String.t()}

string

Positional Arguments
  • self: Evision.FileNode.t()
Return
  • retval: string

Python prototype (for reference only):

string() -> retval
@spec type(t()) :: integer() | {:error, String.t()}

Returns type of the node.

Positional Arguments
  • self: Evision.FileNode.t()
Return
  • retval: int

@returns Type of the node. See FileNode::Type

Python prototype (for reference only):

type() -> retval