Joe Verbout
opencv on mbed
FileNodeIterator Class Reference
[XML/YAML Persistence]
used to iterate through sequences and mappings. More...
#include <persistence.hpp>
Public Member Functions | |
| FileNodeIterator () | |
| The constructors. | |
| FileNodeIterator (const CvFileStorage *fs, const CvFileNode *node, size_t ofs=0) | |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| FileNodeIterator (const FileNodeIterator &it) | |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| FileNode | operator* () const |
| returns the currently observed element | |
| FileNode | operator-> () const |
| accesses the currently observed element methods | |
| FileNodeIterator & | operator++ () |
| moves iterator to the next node | |
| FileNodeIterator | operator++ (int) |
| moves iterator to the next node | |
| FileNodeIterator & | operator-- () |
| moves iterator to the previous node | |
| FileNodeIterator | operator-- (int) |
| moves iterator to the previous node | |
| FileNodeIterator & | operator+= (int ofs) |
| moves iterator forward by the specified offset (possibly negative) | |
| FileNodeIterator & | operator-= (int ofs) |
| moves iterator backward by the specified offset (possibly negative) | |
| FileNodeIterator & | readRaw (const String &fmt, uchar *vec, size_t maxCount=(size_t) INT_MAX) |
| Reads node elements to the buffer with the specified format. | |
Related Functions | |
(Note that these are not member functions.) | |
| template<typename _Tp > | |
| static FileNodeIterator & | operator>> (FileNodeIterator &it, _Tp &value) |
| Reads data from a file storage. | |
| template<typename _Tp > | |
| static FileNodeIterator & | operator>> (FileNodeIterator &it, std::vector< _Tp > &vec) |
| Reads data from a file storage. | |
Detailed Description
used to iterate through sequences and mappings.
A standard STL notation, with node.begin(), node.end() denoting the beginning and the end of a sequence, stored in node. See the data reading sample in the beginning of the section.
Definition at line 580 of file persistence.hpp.
Constructor & Destructor Documentation
| FileNodeIterator | ( | ) |
The constructors.
These constructors are used to create a default iterator, set it to specific element in a file node or construct it from another iterator.
| FileNodeIterator | ( | const CvFileStorage * | fs, |
| const CvFileNode * | node, | ||
| size_t | ofs = 0 |
||
| ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
- Parameters:
-
fs File storage for the iterator. node File node for the iterator. ofs Index of the element in the node. The created iterator will point to this element.
| FileNodeIterator | ( | const FileNodeIterator & | it ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
- Parameters:
-
it Iterator to be used as initialization for the created iterator.
Member Function Documentation
| FileNode operator* | ( | ) | const |
returns the currently observed element
| FileNodeIterator operator++ | ( | int | ) |
moves iterator to the next node
| FileNodeIterator& operator++ | ( | ) |
moves iterator to the next node
| FileNodeIterator& operator+= | ( | int | ofs ) |
moves iterator forward by the specified offset (possibly negative)
| FileNodeIterator& operator-- | ( | ) |
moves iterator to the previous node
| FileNodeIterator operator-- | ( | int | ) |
moves iterator to the previous node
| FileNodeIterator& operator-= | ( | int | ofs ) |
moves iterator backward by the specified offset (possibly negative)
| FileNode operator-> | ( | ) | const |
accesses the currently observed element methods
| FileNodeIterator& readRaw | ( | const String & | fmt, |
| uchar * | vec, | ||
| size_t | maxCount = (size_t) INT_MAX |
||
| ) |
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. maxCount Number of elements to read. If it is greater than number of remaining elements then all of them will be read.
Friends And Related Function Documentation
| static FileNodeIterator & operator>> | ( | FileNodeIterator & | it, |
| _Tp & | value | ||
| ) | [related] |
Reads data from a file storage.
Definition at line 1095 of file persistence.hpp.
| static FileNodeIterator & operator>> | ( | FileNodeIterator & | it, |
| std::vector< _Tp > & | vec | ||
| ) | [related] |
Reads data from a file storage.
Definition at line 1104 of file persistence.hpp.
Generated on Tue Jul 12 2022 16:42:43 by
1.7.2