Class FileNode

File Storage Node class

Inheritance
System.Object
DisposableObject
DisposableCvObject
FileNode
Implements
System.Collections.IEnumerable<FileNode>
Inherited Members
Namespace: OpenCvSharp
Assembly: OpenCvSharp.dll
Syntax
public class FileNode : DisposableCvObject, ICvPtrHolder

Constructors

| Improve this Doc View Source

FileNode()

The default constructor

Declaration
public FileNode()
| Improve this Doc View Source

FileNode(IntPtr)

Initializes from cv::FileNode*

Declaration
public FileNode(IntPtr ptr)
Parameters
Type Name Description
IntPtr ptr

Properties

| Improve this Doc View Source

Empty

Returns true if the node is empty

Declaration
public bool Empty { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsInt

Returns true if the node is an integer

Declaration
public bool IsInt { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsMap

Returns true if the node is a mapping

Declaration
public bool IsMap { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsNamed

Returns true if the node has a name

Declaration
public bool IsNamed { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsNone

Returns true if the node is a "none" object

Declaration
public bool IsNone { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsReal

Returns true if the node is a floating-point number

Declaration
public bool IsReal { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsSeq

Returns true if the node is a sequence

Declaration
public bool IsSeq { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsString

Returns true if the node is a text string

Declaration
public bool IsString { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Item[Int32]

returns element of a sequence node

Declaration
public FileNode this[int i] { get; }
Parameters
Type Name Description
System.Int32 i
Property Value
Type Description
FileNode
| Improve this Doc View Source

Item[String]

returns element of a mapping node

Declaration
public FileNode this[string nodeName] { get; }
Parameters
Type Name Description
System.String nodeName
Property Value
Type Description
FileNode
| Improve this Doc View Source

Name

Returns the node name or an empty string if the node is nameless

Declaration
public string Name { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Size

Returns the number of elements in the node, if it is a sequence or mapping, or 1 otherwise.

Declaration
public long Size { get; }
Property Value
Type Description
System.Int64
| Improve this Doc View Source

Type

Returns type of the node.

Declaration
public FileNode.Types Type { get; }
Property Value
Type Description
FileNode.Types

Type of the node.

Methods

| Improve this Doc View Source

Begin()

returns iterator pointing to the first node element

Declaration
public FileNodeIterator Begin()
Returns
Type Description
FileNodeIterator
| Improve this Doc View Source

DisposeUnmanaged()

Releases unmanaged resources

Declaration
protected override void DisposeUnmanaged()
Overrides
| Improve this Doc View Source

End()

returns iterator pointing to the element following the last node element

Declaration
public FileNodeIterator End()
Returns
Type Description
FileNodeIterator
| Improve this Doc View Source

GetEnumerator()

Get FileNode iterator

Declaration
public IEnumerator<FileNode> GetEnumerator()
Returns
Type Description
System.Collections.IEnumerator<FileNode>
| Improve this Doc View Source

ReadDMatch()

Reads the node element as DMatch

Declaration
public DMatch ReadDMatch()
Returns
Type Description
OpenCvSharp.DMatch
| Improve this Doc View Source

ReadDMatches()

Reads the node element as DMatch[]

Declaration
public DMatch[] ReadDMatches()
Returns
Type Description
OpenCvSharp.DMatch[]
| Improve this Doc View Source

ReadDouble(Double)

Reads the node element as Double

Declaration
public double ReadDouble(double defaultValue = 0)
Parameters
Type Name Description
System.Double defaultValue
Returns
Type Description
System.Double
| Improve this Doc View Source

ReadFloat(Single)

Reads the node element as Single (float)

Declaration
public float ReadFloat(float defaultValue = 0F)
Parameters
Type Name Description
System.Single defaultValue
Returns
Type Description
System.Single
| Improve this Doc View Source

ReadInt(Int32)

Reads the node element as Int32 (int)

Declaration
public int ReadInt(int defaultValue = 0)
Parameters
Type Name Description
System.Int32 defaultValue
Returns
Type Description
System.Int32
| Improve this Doc View Source

ReadKeyPoint()

Reads the node element as KeyPoint

Declaration
public KeyPoint ReadKeyPoint()
Returns
Type Description
OpenCvSharp.KeyPoint
| Improve this Doc View Source

ReadKeyPoints()

Reads the node element as KeyPoint[]

Declaration
public KeyPoint[] ReadKeyPoints()
Returns
Type Description
OpenCvSharp.KeyPoint[]
| Improve this Doc View Source

ReadMat(Mat)

Reads the node element as Mat

Declaration
public Mat ReadMat(Mat defaultMat = null)
Parameters
Type Name Description
Mat defaultMat
Returns
Type Description
Mat
| Improve this Doc View Source

ReadPoint()

Reads the node element as Point

Declaration
public Point ReadPoint()
Returns
Type Description
OpenCvSharp.Point
| Improve this Doc View Source

ReadPoint2d()

Reads the node element as Point2d

Declaration
public Point2d ReadPoint2d()
Returns
Type Description
OpenCvSharp.Point2d
| Improve this Doc View Source

ReadPoint2f()

Reads the node element as Point2f

Declaration
public Point2f ReadPoint2f()
Returns
Type Description
OpenCvSharp.Point2f
| Improve this Doc View Source

ReadPoint3d()

Reads the node element as Point3d

Declaration
public Point3d ReadPoint3d()
Returns
Type Description
OpenCvSharp.Point3d
| Improve this Doc View Source

ReadPoint3f()

Reads the node element as Point3f

Declaration
public Point3f ReadPoint3f()
Returns
Type Description
OpenCvSharp.Point3f
| Improve this Doc View Source

ReadPoint3i()

Reads the node element as Point3i

Declaration
public Point3i ReadPoint3i()
Returns
Type Description
OpenCvSharp.Point3i
| Improve this Doc View Source

ReadRange()

Reads the node element as Range

Declaration
public Range ReadRange()
Returns
Type Description
OpenCvSharp.Range
| Improve this Doc View Source

ReadRaw(String, IntPtr, Int64)

Reads node elements to the buffer with the specified format

Declaration
public void ReadRaw(string fmt, IntPtr vec, long len)
Parameters
Type Name Description
System.String fmt
IntPtr vec
System.Int64 len
| Improve this Doc View Source

ReadRect()

Reads the node element as Rect

Declaration
public Rect ReadRect()
Returns
Type Description
OpenCvSharp.Rect
| Improve this Doc View Source

ReadRect2d()

Reads the node element as Rect2d

Declaration
public Rect2d ReadRect2d()
Returns
Type Description
OpenCvSharp.Rect2d
| Improve this Doc View Source

ReadRect2f()

Reads the node element as Rect2f

Declaration
public Rect2f ReadRect2f()
Returns
Type Description
OpenCvSharp.Rect2f
| Improve this Doc View Source

ReadScalar()

Reads the node element as Scalar

Declaration
public Scalar ReadScalar()
Returns
Type Description
OpenCvSharp.Scalar
| Improve this Doc View Source

ReadSize()

Reads the node element as Size

Declaration
public Size ReadSize()
Returns
Type Description
OpenCvSharp.Size
| Improve this Doc View Source

ReadSize2d()

Reads the node element as Size2d

Declaration
public Size2d ReadSize2d()
Returns
Type Description
OpenCvSharp.Size2d
| Improve this Doc View Source

ReadSize2f()

Reads the node element as Size2f

Declaration
public Size2f ReadSize2f()
Returns
Type Description
OpenCvSharp.Size2f
| Improve this Doc View Source

ReadSparseMat(SparseMat)

Reads the node element as SparseMat

Declaration
public SparseMat ReadSparseMat(SparseMat defaultMat = null)
Parameters
Type Name Description
SparseMat defaultMat
Returns
Type Description
SparseMat
| Improve this Doc View Source

ReadString(String)

Reads the node element as String

Declaration
public string ReadString(string defaultValue = null)
Parameters
Type Name Description
System.String defaultValue
Returns
Type Description
System.String
| Improve this Doc View Source

ReadVec2b()

Reads the node element as Vector

Declaration
public Vec2b ReadVec2b()
Returns
Type Description
Vec2b
| Improve this Doc View Source

ReadVec2d()

Reads the node element as Vector

Declaration
public Vec2d ReadVec2d()
Returns
Type Description
Vec2d
| Improve this Doc View Source

ReadVec2f()

Reads the node element as Vector

Declaration
public Vec2f ReadVec2f()
Returns
Type Description
Vec2f
| Improve this Doc View Source

ReadVec2i()

Reads the node element as Vector

Declaration
public Vec2i ReadVec2i()
Returns
Type Description
Vec2i
| Improve this Doc View Source

ReadVec2s()

Reads the node element as Vector

Declaration
public Vec2s ReadVec2s()
Returns
Type Description
Vec2s
| Improve this Doc View Source

ReadVec2w()

Reads the node element as Vector

Declaration
public Vec2w ReadVec2w()
Returns
Type Description
Vec2w
| Improve this Doc View Source

ReadVec3b()

Declaration
public Vec3b ReadVec3b()
Returns
Type Description
Vec3b
| Improve this Doc View Source

ReadVec3d()

Reads the node element as Vector

Declaration
public Vec3d ReadVec3d()
Returns
Type Description
Vec3d
| Improve this Doc View Source

ReadVec3f()

Reads the node element as Vector

Declaration
public Vec3f ReadVec3f()
Returns
Type Description
Vec3f
| Improve this Doc View Source

ReadVec3i()

Reads the node element as Vector

Declaration
public Vec3i ReadVec3i()
Returns
Type Description
Vec3i
| Improve this Doc View Source

ReadVec3s()

Reads the node element as Vector

Declaration
public Vec3s ReadVec3s()
Returns
Type Description
Vec3s
| Improve this Doc View Source

ReadVec3w()

Reads the node element as Vector

Declaration
public Vec3w ReadVec3w()
Returns
Type Description
Vec3w
| Improve this Doc View Source

ReadVec4b()

Reads the node element as Vector

Declaration
public Vec4b ReadVec4b()
Returns
Type Description
Vec4b
| Improve this Doc View Source

ReadVec4d()

Reads the node element as Vector

Declaration
public Vec4d ReadVec4d()
Returns
Type Description
Vec4d
| Improve this Doc View Source

ReadVec4f()

Reads the node element as Vector

Declaration
public Vec4f ReadVec4f()
Returns
Type Description
Vec4f
| Improve this Doc View Source

ReadVec4i()

Reads the node element as Vector

Declaration
public Vec4i ReadVec4i()
Returns
Type Description
Vec4i
| Improve this Doc View Source

ReadVec4s()

Reads the node element as Vector

Declaration
public Vec4s ReadVec4s()
Returns
Type Description
Vec4s
| Improve this Doc View Source

ReadVec4w()

Reads the node element as Vector

Declaration
public Vec4w ReadVec4w()
Returns
Type Description
Vec4w
| Improve this Doc View Source

ReadVec6b()

Reads the node element as Vector

Declaration
public Vec6b ReadVec6b()
Returns
Type Description
Vec6b
| Improve this Doc View Source

ReadVec6d()

Reads the node element as Vector

Declaration
public Vec6d ReadVec6d()
Returns
Type Description
Vec6d
| Improve this Doc View Source

ReadVec6f()

Reads the node element as Vector

Declaration
public Vec6f ReadVec6f()
Returns
Type Description
Vec6f
| Improve this Doc View Source

ReadVec6i()

Reads the node element as Vector

Declaration
public Vec6i ReadVec6i()
Returns
Type Description
Vec6i
| Improve this Doc View Source

ReadVec6s()

Reads the node element as Vector

Declaration
public Vec6s ReadVec6s()
Returns
Type Description
Vec6s
| Improve this Doc View Source

ReadVec6w()

Reads the node element as Vector

Declaration
public Vec6w ReadVec6w()
Returns
Type Description
Vec6w
| Improve this Doc View Source

ToDouble()

Returns the node content as double

Declaration
public double ToDouble()
Returns
Type Description
System.Double
| Improve this Doc View Source

ToInt32()

Returns the node content as an integer. If the node stores floating-point number, it is rounded.

Declaration
public int ToInt32()
Returns
Type Description
System.Int32
| Improve this Doc View Source

ToMat()

Returns the node content as OpenCV Mat

Declaration
public Mat ToMat()
Returns
Type Description
Mat
| Improve this Doc View Source

ToSingle()

Returns the node content as System.Single

Declaration
public float ToSingle()
Returns
Type Description
System.Single
| Improve this Doc View Source

ToString()

Returns the node content as text string

Declaration
public override string ToString()
Returns
Type Description
System.String

Operators

| Improve this Doc View Source

Explicit(FileNode to Mat)

Returns the node content as OpenCV Mat

Declaration
public static explicit operator Mat(FileNode node)
Parameters
Type Name Description
FileNode node
Returns
Type Description
Mat
| Improve this Doc View Source

Explicit(FileNode to Double)

Returns the node content as double

Declaration
public static explicit operator double (FileNode node)
Parameters
Type Name Description
FileNode node
Returns
Type Description
System.Double
| Improve this Doc View Source

Explicit(FileNode to Int32)

Returns the node content as an integer. If the node stores floating-point number, it is rounded.

Declaration
public static explicit operator int (FileNode node)
Parameters
Type Name Description
FileNode node
Returns
Type Description
System.Int32
| Improve this Doc View Source

Explicit(FileNode to Single)

Returns the node content as float

Declaration
public static explicit operator float (FileNode node)
Parameters
Type Name Description
FileNode node
Returns
Type Description
System.Single
| Improve this Doc View Source

Explicit(FileNode to String)

Returns the node content as text string

Declaration
public static explicit operator string (FileNode node)
Parameters
Type Name Description
FileNode node
Returns
Type Description
System.String

Explicit Interface Implementations

| Improve this Doc View Source

IEnumerable.GetEnumerator()

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type Description
System.Collections.IEnumerator

Implements

System.Collections.IEnumerable<>