FileStorage Class |
XML/YAML File Storage Class.
Inheritance HierarchyNamespace: OpenCvSharp
Assembly: OpenCvSharp (in OpenCvSharp.dll) Version: 3.4.1.20180605-33-CaRLSharp
SyntaxThe FileStorage type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FileStorage |
Default constructor.
You should call FileStorage::open() after initialization.
|
| FileStorage(String, FileStorageMode, String) |
The full constructor
|
Properties| Name | Description | |
|---|---|---|
 | AllocatedMemory |
Gets or sets a memory address allocated by AllocMemory.
(Inherited from DisposableObject.) |
| AllocatedMemorySize |
Gets or sets the byte length of the allocated memory
(Inherited from DisposableObject.) |
 | CvPtr |
Native pointer of OpenCV structure
(Inherited from DisposableCvObject.) |
| ElName |
the currently written element
|
| IsDisposed |
Gets a value indicating whether this instance has been disposed.
(Inherited from DisposableObject.) |
| IsEnabledDispose |
Gets or sets a value indicating whether you permit disposing this instance.
(Inherited from DisposableObject.) |
| Item |
Returns the specified element of the top-level mapping
|
| State |
the writer state
|
| Structs |
the stack of written structures
|
Methods| Name | Description | |
|---|---|---|
| Add(Double) |
Writes data to a file storage.
|
| Add(Int32) |
Writes data to a file storage.
|
| Add(Single) |
Writes data to a file storage.
|
| Add(String) |
Writes data to a file storage.
|
| Add(DMatch) |
Writes data to a file storage.
|
| Add(IEnumerableDMatch) |
Writes data to a file storage.
|
| Add(KeyPoint) |
Writes data to a file storage.
|
| Add(IEnumerableKeyPoint) |
Writes data to a file storage.
|
| Add(Mat) |
Writes data to a file storage.
|
| Add(Point) |
/Writes data to a file storage.
|
| Add(Point2d) |
Writes data to a file storage.
|
| Add(Point2f) |
Writes data to a file storage.
|
| Add(Point3d) |
Writes data to a file storage.
|
| Add(Point3f) |
Writes data to a file storage.
|
| Add(Point3i) |
Writes data to a file storage.
|
| Add(Range) |
Writes data to a file storage.
|
| Add(Rect) |
Writes data to a file storage.
|
| Add(Rect2d) |
Writes data to a file storage.
|
| Add(Rect2f) |
Writes data to a file storage.
|
| Add(Scalar) |
Writes data to a file storage.
|
| Add(Size) |
Writes data to a file storage.
|
| Add(Size2d) |
Writes data to a file storage.
|
| Add(Size2f) |
Writes data to a file storage.
|
| Add(SparseMat) |
Writes data to a file storage.
|
| Add(Vec2b) |
Writes data to a file storage.
|
| Add(Vec2d) |
Writes data to a file storage.
|
| Add(Vec2f) |
Writes data to a file storage.
|
| Add(Vec2i) |
Writes data to a file storage.
|
| Add(Vec2s) |
Writes data to a file storage.
|
| Add(Vec2w) |
Writes data to a file storage.
|
| Add(Vec3b) |
Writes data to a file storage.
|
| Add(Vec3d) |
Writes data to a file storage.
|
| Add(Vec3f) |
Writes data to a file storage.
|
| Add(Vec3i) |
Writes data to a file storage.
|
| Add(Vec3s) |
Writes data to a file storage.
|
| Add(Vec3w) |
Writes data to a file storage.
|
| Add(Vec4b) |
Writes data to a file storage.
|
| Add(Vec4d) |
Writes data to a file storage.
|
| Add(Vec4f) |
Writes data to a file storage.
|
| Add(Vec4i) |
Writes data to a file storage.
|
| Add(Vec4s) |
Writes data to a file storage.
|
| Add(Vec4w) |
Writes data to a file storage.
|
| Add(Vec6b) |
Writes data to a file storage.
|
| Add(Vec6d) |
Writes data to a file storage.
|
| Add(Vec6f) |
Writes data to a file storage.
|
| Add(Vec6i) |
Writes data to a file storage.
|
| Add(Vec6s) |
Writes data to a file storage.
|
| Add(Vec6w) |
Writes data to a file storage.
|
 | AllocGCHandle |
Pins the object to be allocated by cvSetData.
(Inherited from DisposableObject.) |
| AllocMemory |
Allocates the specified size of memory.
(Inherited from DisposableObject.) |
| Dispose |
Releases the resources
(Inherited from DisposableObject.) |
| DisposeManaged |
Releases managed resources
(Inherited from DisposableObject.) |
| DisposeUnmanaged |
Releases unmanaged resources
(Overrides DisposableCvObjectDisposeUnmanaged.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize |
Destructor
(Inherited from DisposableObject.) |
 | GetDefaultObjectName |
Returns the normalized object name for the specified file name
|
| GetFirstTopLevelNode |
Returns the first element of the top-level mapping
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsOpened |
Returns true if the object is associated with currently opened file.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| NotifyMemoryPressure |
Notifies the allocated size of memory.
(Inherited from DisposableObject.) |
| Open |
operator that performs PCA. The previously stored data, if any, is released
|
| Release |
Closes the file and releases all the memory buffers
|
| ReleaseAndGetString |
Closes the file, releases all the memory buffers and returns the text string
|
| Root |
Returns the top-level mapping. YAML supports multiple streams
|
| ThrowIfDisposed |
If this object is disposed, then ObjectDisposedException is thrown.
(Inherited from DisposableObject.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Write(String, Mat) | |
| Write(String, SparseMat) | |
| Write(String, IEnumerableDMatch) | |
| Write(String, IEnumerableKeyPoint) | |
| Write(String, Double) | |
| Write(String, Int32) | |
| Write(String, Single) | |
| Write(String, String) | |
| WriteObj |
Writes the registered C structure (CvMat, CvMatND, CvSeq). See cvWrite()
|
| WriteRaw |
Writes one or more numbers of the specified format to the currently written structure
|
| WriteScalar(Double) | |
| WriteScalar(Int32) | |
| WriteScalar(Single) | |
| WriteScalar(String) |
Fields| Name | Description | |
|---|---|---|
 | dataHandle |
Gets or sets a handle which allocates using cvSetData.
(Inherited from DisposableObject.) |
| ptr |
Data pointer
(Inherited from DisposableCvObject.) |
See Also