FileStorage Class OpenCvSharp Class Library
XML/YAML File Storage Class.
Inheritance Hierarchy

SystemObject
  OpenCvSharpDisposableObject
    OpenCvSharpDisposableCvObject
      OpenCvSharp.CPlusPlusFileStorage

Namespace:  OpenCvSharp.CPlusPlus
Assembly:  OpenCvSharp.CPlusPlus (in OpenCvSharp.CPlusPlus.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax

public class FileStorage : DisposableCvObject

The FileStorage type exposes the following members.

Constructors

  NameDescription
Public methodFileStorage
Default constructor. You should call FileStorage::open() after initialization.
Public methodFileStorage(String, FileStorageMode, String)
The full constructor
Top
Properties

  NameDescription
Protected propertyAllocatedMemory
Gets or sets a memory address allocated by AllocMemory.
(Inherited from DisposableObject.)
Protected propertyAllocatedMemorySize
Gets or sets the byte length of the allocated memory
(Inherited from DisposableObject.)
Public propertyCvPtr
Native pointer of OpenCV structure
(Inherited from DisposableCvObject.)
Public propertyElName
the currently written element
Public propertyIsDisposed
Gets a value indicating whether this instance has been disposed.
(Inherited from DisposableObject.)
Public propertyIsEnabledDispose
Gets or sets a value indicating whether you permit disposing this instance.
(Inherited from DisposableObject.)
Public propertyItem
Returns the specified element of the top-level mapping
Public propertyState
the writer state
Public propertyStructs
the stack of written structures
Top
Methods

  NameDescription
Protected methodAllocGCHandle
Pins the object to be allocated by cvSetData.
(Inherited from DisposableObject.)
Protected methodAllocMemory
Allocates the specified size of memory.
(Inherited from DisposableObject.)
Public methodDispose
Releases the resources
(Inherited from DisposableObject.)
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the FileStorage and optionally releases the managed resources
(Overrides DisposableCvObjectDispose(Boolean).)
Public methodEquals (Inherited from Object.)
Protected methodFinalize
Destructor
(Inherited from DisposableObject.)
Public methodStatic memberGetDefaultObjectName
Returns the normalized object name for the specified file name
Public methodGetFirstTopLevelNode
Returns the first element of the top-level mapping
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodIsOpened
Returns true if the object is associated with currently opened file.
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodNotifyMemoryPressure
Notifies the allocated size of memory.
(Inherited from DisposableObject.)
Public methodOpen
operator that performs PCA. The previously stored data, if any, is released
Public methodRelease
Closes the file and releases all the memory buffers
Public methodReleaseAndGetString
Closes the file, releases all the memory buffers and returns the text string
Public methodRoot
Returns the top-level mapping. YAML supports multiple streams
Public methodThrowIfDisposed
If this object is disposed, then ObjectDisposedException is thrown.
(Inherited from DisposableObject.)
Public methodToLegacy
Returns pointer to the underlying C FileStorage structure
Public methodToString (Inherited from Object.)
Public methodWrite(String, Mat)
Public methodWrite(String, SparseMat)
Public methodWrite(String, IEnumerableKeyPoint)
Public methodWrite(String, Double)
Public methodWrite(String, Int32)
Public methodWrite(String, Single)
Public methodWrite(String, String)
Public methodWriteObj
Writes the registered C structure (CvMat, CvMatND, CvSeq). See cvWrite()
Public methodWriteRaw
Writes one or more numbers of the specified format to the currently written structure
Public methodWriteScalar(Double)
Public methodWriteScalar(Int32)
Public methodWriteScalar(Single)
Public methodWriteScalar(String)
Top
Operators

  NameDescription
Public operatorStatic member(FileStorage to CvFileStorage)
Returns pointer to the underlying C FileStorage structure
Top
Fields

  NameDescription
Protected fielddataHandle
Gets or sets a handle which allocates using cvSetData.
(Inherited from DisposableObject.)
Protected fieldptr
Data pointer
(Inherited from DisposableCvObject.)
Top
See Also

Reference