Class: OpenCV::Cv::FileStorage

Inherits:
Object
  • Object
show all
Extended by:
FFI::DataConverter
Includes:
Enumerable
Defined in:
lib/ropencv/ropencv_ruby.rb,
lib/ropencv/ropencv_types.rb

Constants collapse

READ = 
0
WRITE = 
1
APPEND = 
2
MEMORY = 
4
FORMAT_MASK = 
56
FORMAT_AUTO = 
0
FORMAT_XML = 
8
FORMAT_YAML = 
16
FORMAT_JSON = 
24
BASE64 = 
64
WRITE_BASE64 = 
65
UNDEFINED = 
0
VALUE_EXPECTED = 
1
NAME_EXPECTED = 
2
INSIDE_MAP = 
4

Class Method Summary collapse

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(m, *args) ⇒ Object 



225
226
227
228
229
230
231
 
# File 'lib/ropencv/ropencv_ruby.rb', line 225

def method_missing(m,*args)
    if args.empty?
        self[m.to_s]
    else
        super
    end
end

Class Method Details

.file_storage ⇒ Object .file_storage(filename, flags, encoding = Std::String.new()) ⇒ Object

Overloads:

  • .file_storage(filename, flags, encoding = Std::String.new()) ⇒ Object

    Parameters:

Raises:

  • (ArgumentError) 


22952
22953
22954
22955
22956
22957
22958
22959
22960
22961
22962
22963
22964
22965
22966
22967
22968
22969
22970
22971
22972
22973
22974
22975
22976
22977
22978
22979
22980
22981
22982
22983
22984
22985
22986
 
# File 'lib/ropencv/ropencv_types.rb', line 22952

def self.new(*args)
    if args.first.is_a?(FFI::Pointer) || args.first.is_a?(FileStorageStruct)
        raise ArgumentError, "too many arguments for creating #{self.name} from Pointer" unless args.size == 1
        return super(args.first)
    end
    # overloaded method wrapper for cv::FileStorage::FileStorage()
    @@cv_file_storage_file_storage_defaults0 ||= []
    if(args.size >= 0 && args.size <= 0)
        targs = args.clone
        targs.size.upto(-1) do |i|
            targs[i] = @@cv_file_storage_file_storage_defaults0[i]
        end
        begin
                return Rbind::cv_file_storage_file_storage(*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for cv::FileStorage::FileStorage(const std::string filename, int flags, const std::string encoding = String())
    @@cv_file_storage_file_storage__2_defaults1 ||= [nil, nil, Std::String.new()]
    if(args.size >= 2 && args.size <= 3)
        targs = args.clone
        targs.size.upto(2) do |i|
            targs[i] = @@cv_file_storage_file_storage__2_defaults1[i]
        end
        begin
                return Rbind::cv_file_storage_file_storage__2(*targs)
        rescue TypeError => e
            @error = e
        end
    end

    raise ArgumentError, "no constructor for #{self}(#{args.inspect})"
end

.null ⇒ Object

returns a null pointer to the object



22942
22943
22944
 
# File 'lib/ropencv/ropencv_types.rb', line 22942

def self.null
    new(FileStorageStruct.new)
end

Instance Method Details

#<<(val) ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/ropencv/ropencv_ruby.rb', line 208

def <<(val)
    if val.is_a?(1.class)
        write_int(val)
    elsif val.is_a?(Float)
        write_double(val)
    else
        if val.is_a? Std::Vector::Cv_DMatch
            write_std_cv_dmatch(val)
        elsif val.is_a? Std::Vector::Cv_KeyPoint
            write_std_cv_keypoint(val)
        else
            name = val.class.name.split("::").last.downcase
            send("write_#{name}",val)
        end
    end
end

#each(&block) ⇒ Object 



200
201
202
203
204
205
206
 
# File 'lib/ropencv/ropencv_ruby.rb', line 200

def each(&block)
    if block_given?
        root.each(&block)
    else
        to_enum(:each)
    end
end

#end_write_struct ⇒ Void Also known as: endWriteStruct

Note:

method wrapper for void cv::FileStorage::endWriteStruct()

Returns:

  • (Void) 


23393
23394
23395
23396
 
# File 'lib/ropencv/ropencv_types.rb', line 23393

def end_write_struct()
    __validate_pointer__
    Rbind::cv_file_storage_end_write_struct( self)
end

#get_first_top_level_node ⇒ Cv::FileNode Also known as: getFirstTopLevelNode

Note:

method wrapper for const cv::FileNode cv::FileStorage::getFirstTopLevelNode()

Returns:



23232
23233
23234
23235
23236
23237
23238
23239
23240
 
# File 'lib/ropencv/ropencv_types.rb', line 23232

def get_first_top_level_node()
    __validate_pointer__
    result = Rbind::cv_file_storage_get_first_top_level_node( self)
    if result.respond_to?(:__owner__?) && !result.__owner__?
    # store owner insight the pointer to not get garbage collected
        result.instance_variable_get(:@__obj_ptr__).instance_variable_set(:@__owner__,self) 
    end
    result
end

#get_format ⇒ Fixnum Also known as: getFormat

Note:

method wrapper for int cv::FileStorage::getFormat()

Returns:

  • (Fixnum) 


23401
23402
23403
23404
 
# File 'lib/ropencv/ropencv_types.rb', line 23401

def get_format()
    __validate_pointer__
    Rbind::cv_file_storage_get_format( self)
end

#get_node(nodename) ⇒ Cv::FileNode Also known as: getNode

Note:

method wrapper for const cv::FileNode cv::FileStorage::operator

Parameters:

  • nodename (C_string)

Returns:



23259
23260
23261
23262
23263
23264
23265
23266
23267
 
# File 'lib/ropencv/ropencv_types.rb', line 23259

def get_node(nodename)
    __validate_pointer__
    result = Rbind::cv_file_storage_get_node( self, nodename)
    if result.respond_to?(:__owner__?) && !result.__owner__?
    # store owner insight the pointer to not get garbage collected
        result.instance_variable_get(:@__obj_ptr__).instance_variable_set(:@__owner__,self) 
    end
    result
end

#is_opened ⇒ Bool Also known as: isOpened

Note:

method wrapper for bool cv::FileStorage::isOpened()

Returns:

  • (Bool) 


23204
23205
23206
23207
 
# File 'lib/ropencv/ropencv_types.rb', line 23204

def is_opened()
    __validate_pointer__
    Rbind::cv_file_storage_is_opened( self)
end

#open(filename, flags, encoding = Std::String.new()) ⇒ Bool

Note:

method wrapper for bool cv::FileStorage::open(const std::string filename, int flags, const std::string encoding = String())

Parameters:

Returns:

  • (Bool) 


23197
23198
23199
23200
 
# File 'lib/ropencv/ropencv_types.rb', line 23197

def open(filename, flags, encoding = Std::String.new())
    __validate_pointer__
    Rbind::cv_file_storage_open( self, filename, flags, encoding)
end

#release ⇒ Void

Note:

method wrapper for void cv::FileStorage::release()

Returns:

  • (Void) 


23212
23213
23214
23215
 
# File 'lib/ropencv/ropencv_types.rb', line 23212

def release()
    __validate_pointer__
    Rbind::cv_file_storage_release( self)
end

#release_and_get_string ⇒ Std::String Also known as: releaseAndGetString

Note:

method wrapper for const std::string cv::FileStorage::releaseAndGetString()

Returns:



23219
23220
23221
23222
23223
23224
23225
23226
23227
 
# File 'lib/ropencv/ropencv_types.rb', line 23219

def release_and_get_string()
    __validate_pointer__
    result = Rbind::cv_file_storage_release_and_get_string( self)
    if result.respond_to?(:__owner__?) && !result.__owner__?
    # store owner insight the pointer to not get garbage collected
        result.instance_variable_get(:@__obj_ptr__).instance_variable_set(:@__owner__,self) 
    end
    result
end

#root(streamidx = 0) ⇒ Cv::FileNode

Note:

method wrapper for const cv::FileNode cv::FileStorage::root(int streamidx = 0)

Parameters:

  • streamidx (Fixnum) (defaults to: 0)

Returns:



23246
23247
23248
23249
23250
23251
23252
23253
23254
 
# File 'lib/ropencv/ropencv_types.rb', line 23246

def root(streamidx = 0)
    __validate_pointer__
    result = Rbind::cv_file_storage_root( self, streamidx)
    if result.respond_to?(:__owner__?) && !result.__owner__?
    # store owner insight the pointer to not get garbage collected
        result.instance_variable_get(:@__obj_ptr__).instance_variable_set(:@__owner__,self) 
    end
    result
end

#start_write_struct(name, flags, type_name = Std::String.new()) ⇒ Void Also known as: startWriteStruct

Note:

method wrapper for void cv::FileStorage::startWriteStruct(const std::string name, int flags, const std::string typeName = String())

Parameters:

Returns:

  • (Void) 


23385
23386
23387
23388
 
# File 'lib/ropencv/ropencv_types.rb', line 23385

def start_write_struct(name, flags, type_name = Std::String.new())
    __validate_pointer__
    Rbind::cv_file_storage_start_write_struct( self, name, flags, type_name)
end

#to_s ⇒ Object

converts FileStorage into a string by crawling through all its attributes



23052
23053
23054
 
# File 'lib/ropencv/ropencv_types.rb', line 23052

def to_s
    "#<cv::FileStorage >"
end

#write(name, val) ⇒ Void #write(name, val) ⇒ Void #write(name, val) ⇒ Void #write(name, val) ⇒ Void #write(name, val) ⇒ Void

Note:

wrapper for overloaded method write

Overloads:

Raises:

  • (ArgumentError) 


23295
23296
23297
23298
23299
23300
23301
23302
23303
23304
23305
23306
23307
23308
23309
23310
23311
23312
23313
23314
23315
23316
23317
23318
23319
23320
23321
23322
23323
23324
23325
23326
23327
23328
23329
23330
23331
23332
23333
23334
23335
23336
23337
23338
23339
23340
23341
23342
23343
23344
23345
23346
23347
23348
23349
23350
23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
23368
 
# File 'lib/ropencv/ropencv_types.rb', line 23295

def write(*args)
    __validate_pointer__
    # overloaded method wrapper for void cv::FileStorage::write(const std::string name, int val)
    @@cv_file_storage_write_defaults0 ||= [nil, nil]
    if(args.size >= 2 && args.size <= 2)
        targs = args.clone
        targs.size.upto(1) do |i|
            targs[i] = @@cv_file_storage_write_defaults0[i]
        end
        begin
                return Rbind::cv_file_storage_write(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for void cv::FileStorage::write(const std::string name, double val)
    @@cv_file_storage_write__2_defaults1 ||= [nil, nil]
    if(args.size >= 2 && args.size <= 2)
        targs = args.clone
        targs.size.upto(1) do |i|
            targs[i] = @@cv_file_storage_write__2_defaults1[i]
        end
        begin
                return Rbind::cv_file_storage_write__2(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for void cv::FileStorage::write(const std::string name, const std::string val)
    @@cv_file_storage_write__3_defaults2 ||= [nil, nil]
    if(args.size >= 2 && args.size <= 2)
        targs = args.clone
        targs.size.upto(1) do |i|
            targs[i] = @@cv_file_storage_write__3_defaults2[i]
        end
        begin
                return Rbind::cv_file_storage_write__3(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for void cv::FileStorage::write(const std::string name, const cv::Mat val)
    @@cv_file_storage_write__4_defaults3 ||= [nil, nil]
    if(args.size >= 2 && args.size <= 2)
        targs = args.clone
        targs.size.upto(1) do |i|
            targs[i] = @@cv_file_storage_write__4_defaults3[i]
        end
        begin
                return Rbind::cv_file_storage_write__4(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for void cv::FileStorage::write(const std::string name, const std::vector<std::string> val)
    @@cv_file_storage_write__5_defaults4 ||= [nil, nil]
    if(args.size >= 2 && args.size <= 2)
        targs = args.clone
        targs.size.upto(1) do |i|
            targs[i] = @@cv_file_storage_write__5_defaults4[i]
        end
        begin
                return Rbind::cv_file_storage_write__5(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    raise ArgumentError, "No overloaded signature fits to: #{args.map(&:class)}"
end

#write_comment(comment, append = false) ⇒ Void Also known as: writeComment

Note:

method wrapper for void cv::FileStorage::writeComment(const std::string comment, bool append = false)

Parameters:

  • comment (Std::String)
  • append (Bool) (defaults to: false)

Returns:

  • (Void) 


23374
23375
23376
23377
 
# File 'lib/ropencv/ropencv_types.rb', line 23374

def write_comment(comment, append = false)
    __validate_pointer__
    Rbind::cv_file_storage_write_comment( self, comment, append)
end

#write_double(val) ⇒ Cv::FileStorage

Note:

method wrapper for cv::FileStorage& cv::FileStorage::operator<<(double val)

Parameters:

  • val (Double)

Returns:



23095
23096
23097
23098
 
# File 'lib/ropencv/ropencv_types.rb', line 23095

def write_double(val)
    __validate_pointer__
    Rbind::cv_file_storage_write_double( self, val)
end

#write_float(val) ⇒ Cv::FileStorage

Note:

method wrapper for cv::FileStorage& cv::FileStorage::operator<<(float val)

Parameters:

  • val (Float)

Returns:



23087
23088
23089
23090
 
# File 'lib/ropencv/ropencv_types.rb', line 23087

def write_float(val)
    __validate_pointer__
    Rbind::cv_file_storage_write_float( self, val)
end

#write_int(val) ⇒ Cv::FileStorage

Note:

method wrapper for cv::FileStorage& cv::FileStorage::operator<<(int val)

methods

Parameters:

  • val (Fixnum)

Returns:



23079
23080
23081
23082
 
# File 'lib/ropencv/ropencv_types.rb', line 23079

def write_int(val)
    __validate_pointer__
    Rbind::cv_file_storage_write_int( self, val)
end

#write_mat(val) ⇒ Cv::FileStorage

Note:

method wrapper for cv::FileStorage& cv::FileStorage::operator<<(const cv::Mat val)

Parameters:

Returns:



23171
23172
23173
23174
 
# File 'lib/ropencv/ropencv_types.rb', line 23171

def write_mat(val)
    __validate_pointer__
    Rbind::cv_file_storage_write_mat( self, val)
end

#write_point(val) ⇒ Cv::FileStorage

Note:

method wrapper for cv::FileStorage& cv::FileStorage::operator<<(const cv::Point val)

Parameters:

Returns:



23119
23120
23121
23122
 
# File 'lib/ropencv/ropencv_types.rb', line 23119

def write_point(val)
    __validate_pointer__
    Rbind::cv_file_storage_write_point( self, val)
end

#write_point_2d(val) ⇒ Cv::FileStorage Also known as: write_point2d

Note:

method wrapper for cv::FileStorage& cv::FileStorage::operator<<(const cv::Point2d val)

Parameters:

Returns:



23145
23146
23147
23148
 
# File 'lib/ropencv/ropencv_types.rb', line 23145

def write_point_2d(val)
    __validate_pointer__
    Rbind::cv_file_storage_write_point_2d( self, val)
end

#write_point_2f(val) ⇒ Cv::FileStorage Also known as: write_point2f

Note:

method wrapper for cv::FileStorage& cv::FileStorage::operator<<(const cv::Point2f val)

Parameters:

Returns:



23127
23128
23129
23130
 
# File 'lib/ropencv/ropencv_types.rb', line 23127

def write_point_2f(val)
    __validate_pointer__
    Rbind::cv_file_storage_write_point_2f( self, val)
end

#write_point_3d(val) ⇒ Cv::FileStorage Also known as: write_point3d

Note:

method wrapper for cv::FileStorage& cv::FileStorage::operator<<(const cv::Point3d val)

Parameters:

Returns:



23154
23155
23156
23157
 
# File 'lib/ropencv/ropencv_types.rb', line 23154

def write_point_3d(val)
    __validate_pointer__
    Rbind::cv_file_storage_write_point_3d( self, val)
end

#write_point_3f(val) ⇒ Cv::FileStorage Also known as: write_point3f

Note:

method wrapper for cv::FileStorage& cv::FileStorage::operator<<(const cv::Point3f val)

Parameters:

Returns:



23136
23137
23138
23139
 
# File 'lib/ropencv/ropencv_types.rb', line 23136

def write_point_3f(val)
    __validate_pointer__
    Rbind::cv_file_storage_write_point_3f( self, val)
end

#write_rect(val) ⇒ Cv::FileStorage

Note:

method wrapper for cv::FileStorage& cv::FileStorage::operator<<(const cv::Rect val)

Parameters:

Returns:



23163
23164
23165
23166
 
# File 'lib/ropencv/ropencv_types.rb', line 23163

def write_rect(val)
    __validate_pointer__
    Rbind::cv_file_storage_write_rect( self, val)
end

#write_size(val) ⇒ Cv::FileStorage

Note:

method wrapper for cv::FileStorage& cv::FileStorage::operator<<(const cv::Size val)

Parameters:

Returns:



23111
23112
23113
23114
 
# File 'lib/ropencv/ropencv_types.rb', line 23111

def write_size(val)
    __validate_pointer__
    Rbind::cv_file_storage_write_size( self, val)
end

#write_std_cv_dmatch(val) ⇒ Cv::FileStorage

Note:

method wrapper for cv::FileStorage& cv::FileStorage::operator<<(const std::vectorcv::DMatch val)

Parameters:

Returns:



23187
23188
23189
23190
 
# File 'lib/ropencv/ropencv_types.rb', line 23187

def write_std_cv_dmatch(val)
    __validate_pointer__
    Rbind::cv_file_storage_write_std_cv_dmatch( self, val)
end

#write_std_cv_keypoint(val) ⇒ Cv::FileStorage

Note:

method wrapper for cv::FileStorage& cv::FileStorage::operator<<(const std::vectorcv::KeyPoint val)

Parameters:

Returns:



23179
23180
23181
23182
 
# File 'lib/ropencv/ropencv_types.rb', line 23179

def write_std_cv_keypoint(val)
    __validate_pointer__
    Rbind::cv_file_storage_write_std_cv_keypoint( self, val)
end

#write_string(val) ⇒ Cv::FileStorage

Note:

method wrapper for cv::FileStorage& cv::FileStorage::operator<<(const std::string val)

Parameters:

Returns:



23103
23104
23105
23106
 
# File 'lib/ropencv/ropencv_types.rb', line 23103

def write_string(val)
    __validate_pointer__
    Rbind::cv_file_storage_write_string( self, val)
end