FileNode (JavaCPP Presets for OpenCV 4.7.0-1.5.9 API)

java.lang.Object
- org.bytedeco.javacpp.Pointer
- - org.bytedeco.opencv.opencv_core.FileNode

All Implemented Interfaces:

AutoCloseable
```
@Namespace(value="cv")
 @NoOffset
 @Properties(inherit=opencv_core.class)
public class FileNode
extends Pointer
```
\brief File Storage Node class.
The node is used to store each and every element of the file storage opened for reading. When XML/YAML file is read, it is first parsed and stored in the memory as a hierarchical collection of nodes. Each node can be a "leaf" that is contain a single number or a string, or be a collection of other nodes. There can be named collections (mappings) where each element has a name and it is accessed by a name, and ordered collections (sequences) where elements do not have names but rather accessed by index. Type of the file node can be determined using FileNode::type method.
Note that file nodes are only used for navigating file storages opened for reading. When a file storage is opened for writing, no data is stored in memory after it is written.

Nested Class Summary
- Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer
  Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`EMPTY` enum cv::FileNode::
`static int`	`FLOAT` enum cv::FileNode::
`static int`	`FLOW` enum cv::FileNode::
`static int`	`INT` enum cv::FileNode::
`static int`	`MAP` enum cv::FileNode::
`static int`	`NAMED` enum cv::FileNode::
`static int`	`NONE` enum cv::FileNode::
`static int`	`REAL` enum cv::FileNode::
`static int`	`SEQ` enum cv::FileNode::
`static int`	`STR` enum cv::FileNode::
`static int`	`STRING` enum cv::FileNode::
`static int`	`TYPE_MASK` enum cv::FileNode::
`static int`	`UNIFORM` enum cv::FileNode::

Fields inherited from class org.bytedeco.javacpp.Pointer
address, capacity, limit, position

Constructor Summary

Constructors
Constructor and Description
`FileNode()` \brief The constructors.
`FileNode(FileNode node)` \overload
`FileNode(FileStorage fs, long blockIdx, long ofs)` Deprecated.
`FileNode(long size)` Native array allocator.
`FileNode(Pointer p)` Pointer cast constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BytePointer`	`asBytePointer()` returns the node content as text string
`double`	`asDouble()` returns the node content as double
`float`	`asFloat()` returns the node content as float
`int`	`asInt()` returns the node content as an integer.
`FileNode`	`at(int i)` \overload
`FileNodeIterator`	`begin()` returns iterator pointing to the first node element
`long`	`blockIdx()`
`FileNode`	`blockIdx(long setter)`
`boolean`	`empty()` returns true if the node is empty
`FileNodeIterator`	`end()` returns iterator pointing to the element following the last node element
`FileNode`	`get(BytePointer nodename)` \brief Returns element of a mapping node or a sequence node.
`FileNode`	`get(String nodename)`
`FileNode`	`getNode(BytePointer nodename)` \overload
`FileNode`	`getNode(String nodename)`
`FileNode`	`getPointer(long i)`
`static boolean`	`isCollection(int flags)`
`static boolean`	`isEmptyCollection(int flags)`
`static boolean`	`isFlow(int flags)`
`boolean`	`isInt()` returns true if the node is an integer
`boolean`	`isMap()` returns true if the node is a mapping
`static boolean`	`isMap(int flags)`
`boolean`	`isNamed()` returns true if the node has a name
`boolean`	`isNone()` returns true if the node is a "none" object
`boolean`	`isReal()` returns true if the node is a floating-point number
`boolean`	`isSeq()` returns true if the node is a sequence
`static boolean`	`isSeq(int flags)`
`boolean`	`isString()` returns true if the node is a text string
`StringVector`	`keys()` \brief Returns keys of a mapping node.
`Mat`	`mat()` Simplified reading API to use with bindings.
`BytePointer`	`name()` returns the node name or an empty string if the node is nameless
`long`	`ofs()`
`FileNode`	`ofs(long setter)`
`FileNode`	`position(long position)`
`BytePointer`	`ptr()`
`FileNode`	`put(FileNode node)`
`long`	`rawSize()` returns raw size of the FileNode in bytes
`void`	`readRaw(BytePointer fmt, Pointer vec, long len)` \brief Reads node elements to the buffer with the specified format.
`void`	`readRaw(String fmt, Pointer vec, long len)`
`double`	`real()` Simplified reading API to use with bindings.
`void`	`setValue(int type, Pointer value)`
`void`	`setValue(int type, Pointer value, int len)` Internal method used when reading FileStorage.
`long`	`size()` returns the number of elements in the node, if it is a sequence or mapping, or 1 otherwise.
`BytePointer`	`string()` Simplified reading API to use with bindings.
`int`	`type()` \brief Returns type of the node.

Methods inherited from class org.bytedeco.javacpp.Pointer
address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail
- NONE
```
public static final int NONE
```
  enum cv::FileNode::
  
  See Also:
  
  Constant Field Values
- INT
```
public static final int INT
```
  enum cv::FileNode::
  
  See Also:
  
  Constant Field Values
- REAL
```
public static final int REAL
```
  enum cv::FileNode::
  
  See Also:
  
  Constant Field Values
- FLOAT
```
public static final int FLOAT
```
  enum cv::FileNode::
  
  See Also:
  
  Constant Field Values
- STR
```
public static final int STR
```
  enum cv::FileNode::
  
  See Also:
  
  Constant Field Values
- STRING
```
public static final int STRING
```
  enum cv::FileNode::
  
  See Also:
  
  Constant Field Values
- SEQ
```
public static final int SEQ
```
  enum cv::FileNode::
  
  See Also:
  
  Constant Field Values
- MAP
```
public static final int MAP
```
  enum cv::FileNode::
  
  See Also:
  
  Constant Field Values
- TYPE_MASK
```
public static final int TYPE_MASK
```
  enum cv::FileNode::
  
  See Also:
  
  Constant Field Values
- FLOW
```
public static final int FLOW
```
  enum cv::FileNode::
  
  See Also:
  
  Constant Field Values
- UNIFORM
```
public static final int UNIFORM
```
  enum cv::FileNode::
  
  See Also:
  
  Constant Field Values
- EMPTY
```
public static final int EMPTY
```
  enum cv::FileNode::
  
  See Also:
  
  Constant Field Values
- NAMED
```
public static final int NAMED
```
  enum cv::FileNode::
  
  See Also:
  
  Constant Field Values

Constructor Detail
- FileNode
```
public FileNode(Pointer p)
```
  Pointer cast constructor. Invokes Pointer(Pointer).
- FileNode
```
public FileNode(long size)
```
  Native array allocator. Access with Pointer.position(long).
- FileNode
```
public FileNode()
```
  \brief The constructors.
  These constructors are used to create a default file node, construct it from obsolete structures or from the another file node.
- FileNode
```
public FileNode(@Const
                FileStorage fs,
                @Cast(value="size_t")
                long blockIdx,
                @Cast(value="size_t")
                long ofs)
```
  Deprecated.
  
  \overload
  
  Parameters:
  
  fs - Pointer to the file storage structure.
  
  blockIdx - Index of the memory block where the file node is stored
  
  ofs - Offset in bytes from the beginning of the serialized storage
- FileNode
```
public FileNode(@Const @ByRef
                FileNode node)
```
  \overload
  
  Parameters:
  
  node - File node to be used as initialization for the created file node.

Method Detail

position

public FileNode position(long position)

Overrides:: position in class Pointer

getPointer
```
public FileNode getPointer(long i)
```
Overrides:

getPointer in class Pointer

put

@ByRef
 @Name(value="operator =")
public FileNode put(@Const @ByRef
                                                        FileNode node)

get

@ByVal
 @Name(value="operator []")
public FileNode get(@opencv_core.Str
                                                         BytePointer nodename)

\brief Returns element of a mapping node or a sequence node.

Parameters:: nodename - Name of an element in the mapping node.
Returns:: Returns the element with the given identifier.

get

@ByVal
 @Name(value="operator []")
public FileNode get(@opencv_core.Str
                                                         String nodename)

getNode

@ByVal
 @Name(value="operator []")
public FileNode getNode(@Cast(value="const char*")
                                                             BytePointer nodename)

\overload

Parameters:: nodename - Name of an element in the mapping node.

getNode

@ByVal
 @Name(value="operator []")
public FileNode getNode(String nodename)

at

@ByVal
 @Name(value="operator []")
public FileNode at(int i)

\overload

Parameters:: i - Index of an element in the sequence node.

keys
```
@ByVal
public StringVector keys()
```
\brief Returns keys of a mapping node.

Returns:

Keys of a mapping node.

type
```
public int type()
```
\brief Returns type of the node.

Returns:

Type of the node. See FileNode::Type

empty

@Cast(value="bool")
public boolean empty()

returns true if the node is empty

isNone
```
@Cast(value="bool")
public boolean isNone()
```
returns true if the node is a "none" object

isSeq

@Cast(value="bool")
public boolean isSeq()

returns true if the node is a sequence

isMap

@Cast(value="bool")
public boolean isMap()

returns true if the node is a mapping

isInt

@Cast(value="bool")
public boolean isInt()

returns true if the node is an integer

isReal
```
@Cast(value="bool")
public boolean isReal()
```
returns true if the node is a floating-point number

isString
```
@Cast(value="bool")
public boolean isString()
```
returns true if the node is a text string

isNamed

@Cast(value="bool")
public boolean isNamed()

returns true if the node has a name

name
```
@StdString
public BytePointer name()
```
returns the node name or an empty string if the node is nameless

size
```
@Cast(value="size_t")
public long size()
```
returns the number of elements in the node, if it is a sequence or mapping, or 1 otherwise.

rawSize
```
@Cast(value="size_t")
public long rawSize()
```
returns raw size of the FileNode in bytes

asInt
```
@Name(value="operator int")
public int asInt()
```
returns the node content as an integer. If the node stores floating-point number, it is rounded.

asFloat

@Name(value="operator float")
public float asFloat()

returns the node content as float

asDouble

@Name(value="operator double")
public double asDouble()

returns the node content as double

asBytePointer

@Name(value="operator std::string")
 @StdString
public BytePointer asBytePointer()

returns the node content as text string

isMap

@Cast(value="bool")
public static boolean isMap(int flags)

isSeq

@Cast(value="bool")
public static boolean isSeq(int flags)

isCollection

@Cast(value="bool")
public static boolean isCollection(int flags)

isEmptyCollection

@Cast(value="bool")
public static boolean isEmptyCollection(int flags)

isFlow

@Cast(value="bool")
public static boolean isFlow(int flags)

ptr

@Cast(value="uchar*")
public BytePointer ptr()

begin
```
@ByVal
public FileNodeIterator begin()
```
returns iterator pointing to the first node element

end
```
@ByVal
public FileNodeIterator end()
```
returns iterator pointing to the element following the last node element

readRaw
```
public void readRaw(@opencv_core.Str
                    BytePointer fmt,
                    Pointer vec,
                    @Cast(value="size_t")
                    long len)
```
\brief Reads node elements to the buffer with the specified format.
Usually it is more convenient to use operator >> instead of this method.

Parameters:

fmt - Specification of each array element. See \ref format_spec "format specification"

vec - Pointer to the destination array.

len - Number of bytes to read (buffer size limit). If it is greater than number of remaining elements then all of them will be read.

readRaw

public void readRaw(@opencv_core.Str
                    String fmt,
                    Pointer vec,
                    @Cast(value="size_t")
                    long len)

setValue

public void setValue(int type,
                     @Const
                     Pointer value,
                     int len)

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

setValue

public void setValue(int type,
                     @Const
                     Pointer value)

real
```
public double real()
```
Simplified reading API to use with bindings.

string
```
@StdString
public BytePointer string()
```
Simplified reading API to use with bindings.

mat
```
@ByVal
public Mat mat()
```
Simplified reading API to use with bindings.

blockIdx

@Cast(value="size_t")
public long blockIdx()

blockIdx

public FileNode blockIdx(long setter)

ofs

@Cast(value="size_t")
public long ofs()

ofs
```
public FileNode ofs(long setter)
```

Class FileNode

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.bytedeco.javacpp.Pointer

Methods inherited from class java.lang.Object

Field Detail

NONE

INT

REAL

FLOAT

STR

STRING

SEQ

MAP

TYPE_MASK

FLOW

UNIFORM

EMPTY

NAMED

Constructor Detail

FileNode

FileNode

FileNode

FileNode

FileNode

Method Detail

position

getPointer

put

get

get

getNode

getNode

at

keys

type

empty

isNone

isSeq

isMap

isInt

isReal

isString

isNamed

name

size

rawSize

asInt

asFloat

asDouble

asBytePointer

isMap

isSeq

isCollection

isEmptyCollection

isFlow

ptr

begin

end

readRaw

readRaw

setValue

setValue

real

string

mat

blockIdx

blockIdx

ofs

ofs