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 =
(7<<3)
FORMAT_AUTO =
0
FORMAT_XML =
(1<<3)
FORMAT_YAML =
(2<<3)
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



219
220
221
222
223
224
225
# File 'lib/ropencv/ropencv_ruby.rb', line 219

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

Class Method Details

.file_storageObject .file_storage(source, flags, encoding = Cv::String.new()) ⇒ Object

Overloads:

  • .file_storage(source, flags, encoding = Cv::String.new()) ⇒ Object

    Parameters:

Raises:

  • (ArgumentError)


13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
13980
# File 'lib/ropencv/ropencv_types.rb', line 13946

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 cv::String source, int flags, const cv::String encoding = string())
    @@cv_file_storage_file_storage2_defaults1 ||= [nil, nil, Cv::String.new()]
    if(args.size >= 2 && args.size <= 3)
        targs = args.clone
        targs.size.upto(2) do |i|
            targs[i] = @@cv_file_storage_file_storage2_defaults1[i]
        end
        begin
                return Rbind::cv_file_storage_file_storage2(*targs)
        rescue TypeError => e
            @error = e
        end
    end

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

.nullObject

returns a null pointer to the object



13936
13937
13938
# File 'lib/ropencv/ropencv_types.rb', line 13936

def self.null
    new(FileStorageStruct.new)
end

Instance Method Details

#<<(val) ⇒ Object



208
209
210
211
212
213
214
215
216
217
# File 'lib/ropencv/ropencv_ruby.rb', line 208

def <<(val)
    if val.is_a?(Fixnum)
        write_int(val)
    elsif val.is_a?(Float)
        write_double(val)
    else
        name = val.class.name.split("::").last.downcase
        send("write_#{name}",val)
    end
end

#[](nodename) ⇒ Cv::FileNode

Note:

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

Parameters:

  • nodename (C_string)

Returns:



14234
14235
14236
14237
14238
14239
14240
14241
14242
# File 'lib/ropencv/ropencv_types.rb', line 14234

def [](nodename)
    __validate_pointer__
    result = Rbind::cv_file_storage_operator_array( 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

#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

#get_first_top_level_nodeCv::FileNode Also known as: getFirstTopLevelNode

Note:

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

Returns:



14207
14208
14209
14210
14211
14212
14213
14214
14215
# File 'lib/ropencv/ropencv_types.rb', line 14207

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

#is_openedBool Also known as: isOpened

Note:

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

Returns:

  • (Bool)


14179
14180
14181
14182
# File 'lib/ropencv/ropencv_types.rb', line 14179

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

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

Note:

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

Parameters:

Returns:

  • (Bool)


14172
14173
14174
14175
# File 'lib/ropencv/ropencv_types.rb', line 14172

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

#releaseVoid

Note:

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

Returns:

  • (Void)


14187
14188
14189
14190
# File 'lib/ropencv/ropencv_types.rb', line 14187

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

#release_and_get_stringCv::String Also known as: releaseAndGetString

Note:

method wrapper for cv::String cv::FileStorage::releaseAndGetString()

Returns:



14194
14195
14196
14197
14198
14199
14200
14201
14202
# File 'lib/ropencv/ropencv_types.rb', line 14194

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 cv::FileNode cv::FileStorage::root(int streamidx = 0)

Parameters:

  • streamidx (Fixnum) (defaults to: 0)

Returns:



14221
14222
14223
14224
14225
14226
14227
14228
14229
# File 'lib/ropencv/ropencv_types.rb', line 14221

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

#to_sObject

converts FileStorage into a string by crawling through all its attributes



14046
14047
14048
# File 'lib/ropencv/ropencv_types.rb', line 14046

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

#write_double(val) ⇒ Cv::FileStorage

Note:

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

Parameters:

  • val (Double)

Returns:



14086
14087
14088
14089
# File 'lib/ropencv/ropencv_types.rb', line 14086

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:



14078
14079
14080
14081
# File 'lib/ropencv/ropencv_types.rb', line 14078

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:



14070
14071
14072
14073
# File 'lib/ropencv/ropencv_types.rb', line 14070

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:



14162
14163
14164
14165
# File 'lib/ropencv/ropencv_types.rb', line 14162

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:



14110
14111
14112
14113
# File 'lib/ropencv/ropencv_types.rb', line 14110

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:



14136
14137
14138
14139
# File 'lib/ropencv/ropencv_types.rb', line 14136

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:



14118
14119
14120
14121
# File 'lib/ropencv/ropencv_types.rb', line 14118

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:



14145
14146
14147
14148
# File 'lib/ropencv/ropencv_types.rb', line 14145

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:



14127
14128
14129
14130
# File 'lib/ropencv/ropencv_types.rb', line 14127

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:



14154
14155
14156
14157
# File 'lib/ropencv/ropencv_types.rb', line 14154

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:



14102
14103
14104
14105
# File 'lib/ropencv/ropencv_types.rb', line 14102

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

#write_string(val) ⇒ Cv::FileStorage

Note:

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

Parameters:

Returns:



14094
14095
14096
14097
# File 'lib/ropencv/ropencv_types.rb', line 14094

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