File Storage Node class. More...

#include "persistence.hpp"

Public Types
enum	Type { NONE = 0, INT = 1, REAL = 2, FLOAT = REAL, STR = 3, STRING = STR, REF = 4, SEQ = 5, MAP = 6, TYPE_MASK = 7, FLOW = 8, USER = 16, EMPTY = 32, NAMED = 64 }
	type of the file storage node More...

Public Member Functions
	FileNode ()
	The constructors. More...

	FileNode (const CvFileStorage fs, const CvFileNode node)

	FileNode (const FileNode &node)

FileNodeIterator	begin () const
	returns iterator pointing to the first node element More...

bool	empty () const
	returns true if the node is empty More...

FileNodeIterator	end () const
	returns iterator pointing to the element following the last node element More...

bool	isInt () const
	returns true if the node is an integer More...

bool	isMap () const
	returns true if the node is a mapping More...

bool	isNamed () const
	returns true if the node has a name More...

bool	isNone () const
	returns true if the node is a "none" object More...

bool	isReal () const
	returns true if the node is a floating-point number More...

bool	isSeq () const
	returns true if the node is a sequence More...

bool	isString () const
	returns true if the node is a text string More...

String	name () const
	returns the node name or an empty string if the node is nameless More...

	operator double () const
	returns the node content as double More...

	operator float () const
	returns the node content as float More...

	operator std::string () const

	operator String () const
	returns the node content as text string More...

CvFileNode *	operator* ()
	returns pointer to the underlying file node More...

const CvFileNode *	operator* () const
	returns pointer to the underlying file node More...

FileNode	operator[] (const String &nodename) const
	Returns element of a mapping node or a sequence node. More...

FileNode	operator[] (const char *nodename) const

FileNode	operator[] (int i) const

void *	readObj () const
	reads the registered object and returns pointer to it More...

void	readRaw (const String &fmt, uchar *vec, size_t len) const
	Reads node elements to the buffer with the specified format. More...

size_t	size () const
	returns the number of elements in the node, if it is a sequence or mapping, or 1 otherwise. More...

int	type () const
	Returns type of the node. More...

Public Attributes
const CvFileStorage *	fs

const CvFileNode *	node

Related Functions
(Note that these are not member functions.)

void	read (const FileNode &node, int &value, int default_value)

void	read (const FileNode &node, float &value, float default_value)

void	read (const FileNode &node, double &value, double default_value)

void	read (const FileNode &node, String &value, const String &default_value)

void	read (const FileNode &node, Mat &mat, const Mat &default_mat=Mat())

void	read (const FileNode &node, SparseMat &mat, const SparseMat &default_mat=SparseMat())

void	read (const FileNode &node, std::vector< KeyPoint > &keypoints)

void	read (const FileNode &node, std::vector< DMatch > &matches)

template<typename _Tp >
static void	read (const FileNode &node, Point_< _Tp > &value, const Point_< _Tp > &default_value)

template<typename _Tp >
static void	read (const FileNode &node, Point3_< _Tp > &value, const Point3_< _Tp > &default_value)

template<typename _Tp >
static void	read (const FileNode &node, Size_< _Tp > &value, const Size_< _Tp > &default_value)

template<typename _Tp >
static void	read (const FileNode &node, Complex< _Tp > &value, const Complex< _Tp > &default_value)

template<typename _Tp >
static void	read (const FileNode &node, Rect_< _Tp > &value, const Rect_< _Tp > &default_value)

template<typename _Tp , int cn>
static void	read (const FileNode &node, Vec< _Tp, cn > &value, const Vec< _Tp, cn > &default_value)

template<typename _Tp >
static void	read (const FileNode &node, Scalar_< _Tp > &value, const Scalar_< _Tp > &default_value)

static void	read (const FileNode &node, Range &value, const Range &default_value)


static void	read (const FileNode &node, bool &value, bool default_value)

static void	read (const FileNode &node, uchar &value, uchar default_value)

static void	read (const FileNode &node, schar &value, schar default_value)

static void	read (const FileNode &node, ushort &value, ushort default_value)

static void	read (const FileNode &node, short &value, short default_value)

template<typename _Tp >
static void	read (FileNodeIterator &it, std::vector< _Tp > &vec, size_t maxCount=(size_t) INT_MAX)

template<typename _Tp >
static void	read (const FileNode &node, std::vector< _Tp > &vec, const std::vector< _Tp > &default_value=std::vector< _Tp >())


template<typename _Tp >
static void	operator>> (const FileNode &n, _Tp &value)
	Reads data from a file storage. More...

template<typename _Tp >
static void	operator>> (const FileNode &n, std::vector< _Tp > &vec)
	Reads data from a file storage. More...

Detailed Description

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.

Examples:: filestorage.cpp.

Constructor & Destructor Documentation

cv::FileNode::FileNode ( )

The constructors.

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

cv::FileNode::FileNode	(	const CvFileStorage *	fs,
		const CvFileNode *	node
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

fs	Pointer to the obsolete file storage structure.
node	File node to be used as initialization for the created file node.

cv::FileNode::FileNode ( const FileNode & node )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

node	File node to be used as initialization for the created file node.

Member Function Documentation

FileNodeIterator cv::FileNode::begin ( ) const

returns iterator pointing to the first node element

Examples:: filestorage.cpp.

bool cv::FileNode::empty ( ) const

returns true if the node is empty

Examples:: filestorage.cpp.

FileNodeIterator cv::FileNode::end ( ) const

returns iterator pointing to the element following the last node element

Examples:: filestorage.cpp.

bool cv::FileNode::isInt ( ) const

returns true if the node is an integer

bool cv::FileNode::isMap ( ) const

returns true if the node is a mapping

bool cv::FileNode::isNamed ( ) const

returns true if the node has a name

bool cv::FileNode::isNone ( ) const

returns true if the node is a "none" object

bool cv::FileNode::isReal ( ) const

returns true if the node is a floating-point number

bool cv::FileNode::isSeq ( ) const

returns true if the node is a sequence

bool cv::FileNode::isString ( ) const

returns true if the node is a text string

String cv::FileNode::name ( ) const

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

cv::FileNode::operator double ( ) const

returns the node content as double

cv::FileNode::operator float ( ) const

returns the node content as float

cv::FileNode::operator std::string ( ) const

cv::FileNode::operator String ( ) const

returns the node content as text string

CvFileNode* cv::FileNode::operator* ( )

returns pointer to the underlying file node

const CvFileNode* cv::FileNode::operator* ( ) const

returns pointer to the underlying file node

FileNode cv::FileNode::operator[] ( const String & nodename ) const

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.

FileNode cv::FileNode::operator[] ( const char * nodename ) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

nodename Name of an element in the mapping node.

FileNode cv::FileNode::operator[] ( int i ) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

i	Index of an element in the sequence node.

void* cv::FileNode::readObj ( ) const

reads the registered object and returns pointer to it

void cv::FileNode::readRaw	(	const String &	fmt,
		uchar *	vec,
		size_t	len
	)		const

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 format specification
vec	Pointer to the destination array.
len	Number of elements to read. If it is greater than number of remaining elements then all of them will be read.

size_t cv::FileNode::size ( ) const

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

int cv::FileNode::type ( ) const

Returns type of the node.

Returns: Type of the node. See FileNode::Type

Examples:: filestorage.cpp.

Friends And Related Function Documentation

template<typename _Tp >

static void operator>>	(	const FileNode &	n,
		_Tp &	value
	)

template<typename _Tp >

static void operator>>	(	const FileNode &	n,
		std::vector< _Tp > &	vec
	)

void read	(	const FileNode &	node,
		int &	value,
		int	default_value
	)

void read	(	const FileNode &	node,
		float &	value,
		float	default_value
	)

void read	(	const FileNode &	node,
		double &	value,
		double	default_value
	)

void read	(	const FileNode &	node,
		String &	value,
		const String &	default_value
	)

void read	(	const FileNode &	node,
		Mat &	mat,
		const Mat &	default_mat = `Mat()`
	)

void read	(	const FileNode &	node,
		SparseMat &	mat,
		const SparseMat &	default_mat = `SparseMat()`
	)

void read	(	const FileNode &	node,
		std::vector< KeyPoint > &	keypoints
	)

void read	(	const FileNode &	node,
		std::vector< DMatch > &	matches
	)

static void read	(	const FileNode &	node,
		Point_< _Tp > &	value,
		const Point_< _Tp > &	default_value
	)

static void read	(	const FileNode &	node,
		Point3_< _Tp > &	value,
		const Point3_< _Tp > &	default_value
	)

static void read	(	const FileNode &	node,
		Size_< _Tp > &	value,
		const Size_< _Tp > &	default_value
	)

static void read	(	const FileNode &	node,
		Complex< _Tp > &	value,
		const Complex< _Tp > &	default_value
	)

static void read	(	const FileNode &	node,
		Rect_< _Tp > &	value,
		const Rect_< _Tp > &	default_value
	)

static void read	(	const FileNode &	node,
		Vec< _Tp, cn > &	value,
		const Vec< _Tp, cn > &	default_value
	)

static void read	(	const FileNode &	node,
		Scalar_< _Tp > &	value,
		const Scalar_< _Tp > &	default_value
	)

static void read	(	const FileNode &	node,
		Range &	value,
		const Range &	default_value
	)

static void read	(	const FileNode &	node,
		bool &	value,
		bool	default_value
	)

static void read	(	const FileNode &	node,
		uchar &	value,
		uchar	default_value
	)

static void read	(	const FileNode &	node,
		schar &	value,
		schar	default_value
	)

static void read	(	const FileNode &	node,
		ushort &	value,
		ushort	default_value
	)

static void read	(	const FileNode &	node,
		short &	value,
		short	default_value
	)

static void read	(	FileNodeIterator &	it,
		std::vector< _Tp > &	vec,
		size_t	maxCount = `(size_t)INT_MAX`
	)

static void read	(	const FileNode &	node,
		std::vector< _Tp > &	vec,
		const std::vector< _Tp > &	default_value = `std::vector<_Tp>()`
	)

const CvFileStorage* cv::FileNode::fs

const CvFileNode* cv::FileNode::node

The documentation for this class was generated from the following file:

core/include/opencv2/core/persistence.hpp

Public Types

Public Member Functions

Public Attributes

Related Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation