class Babeltrace2::BTComponentClass

Constants

GetSupportedMipVersionsMethodStatus
PortConnectedMethodStatus
QueryMethodStatus
SetDescriptionStatus
SetHelpStatus
SetMethodStatus
SinkConsumeMethodStatus
SinkGraphIsConfiguredMethodStatus
Type

Public Class Methods

from_handle(handle, retain: true, auto_release: true) click to toggle source
# File lib/babeltrace2/graph/component-class.rb, line 38
def self.from_handle(handle, retain: true, auto_release: true)
  case Babeltrace2.bt_component_class_get_type(handle)
  when :BT_COMPONENT_CLASS_TYPE_SOURCE
    handle = BTComponentClassSourceHandle.new(handle)
    BTComponentClassSource
  when :BT_COMPONENT_CLASS_TYPE_FILTER
    handle = BTComponentClassFilterHandle.new(handle)
    BTComponentClassFilter
  when :BT_COMPONENT_CLASS_TYPE_SINK
    handle = BTComponentClassSinkHandle.new(handle)
    BTComponentClassSink
  else
    raise Error.new("Unknown component class type")
  end.new(handle, retain: retain, auto_release: auto_release)
end

Public Instance Methods

description()
Alias for: get_description
description=(description) click to toggle source
# File lib/babeltrace2/graph/component-class-dev.rb, line 397
def description=(description)
  set_description(description)
  description
end
filter?()
Alias for: is_filter
finalize_method=(method) click to toggle source
# File lib/babeltrace2/graph/component-class-dev.rb, line 425
def finalize_method=(method)
  set_finalize_method(method)
  method
end
get_description() click to toggle source
# File lib/babeltrace2/graph/component-class.rb, line 79
def get_description
  Babeltrace2.bt_component_class_get_description(@handle)
end
Also aliased as: description
get_help() click to toggle source
# File lib/babeltrace2/graph/component-class.rb, line 84
def get_help
  Babeltrace2.bt_component_class_get_help(@handle)
end
Also aliased as: help
get_name() click to toggle source
# File lib/babeltrace2/graph/component-class.rb, line 74
def get_name
  Babeltrace2.bt_component_class_get_name(@handle)
end
Also aliased as: name
get_supported_mip_versions_method=(method) click to toggle source
# File lib/babeltrace2/graph/component-class-dev.rb, line 441
def get_supported_mip_versions_method=(method)
  set_get_supported_mip_versions_method(method)
  method
end
get_type() click to toggle source
# File lib/babeltrace2/graph/component-class.rb, line 54
def get_type
  Babeltrace2.bt_component_class_get_type(@handle)
end
Also aliased as: type
help()
Alias for: get_help
help=(help_text) click to toggle source
# File lib/babeltrace2/graph/component-class-dev.rb, line 409
def help=(help_text)
  set_help(help_text)
  help_text
end
initialize_method=(method) click to toggle source
# File lib/babeltrace2/graph/component-class-dev.rb, line 457
def initialize_method=(method)
  set_initialize_method(method)
  method
end
is_filter() click to toggle source
# File lib/babeltrace2/graph/component-class.rb, line 64
def is_filter
  get_type == :BT_COMPONENT_CLASS_TYPE_FILTER
end
Also aliased as: filter?
is_sink() click to toggle source
# File lib/babeltrace2/graph/component-class.rb, line 69
def is_sink
  get_type == :BT_COMPONENT_CLASS_TYPE_SINK
end
Also aliased as: sink?
is_source() click to toggle source
# File lib/babeltrace2/graph/component-class.rb, line 59
def is_source
  get_type == :BT_COMPONENT_CLASS_TYPE_SOURCE
end
Also aliased as: source?
name()
Alias for: get_name
query_method=(method) click to toggle source
# File lib/babeltrace2/graph/component-class-dev.rb, line 473
def query_method=(method)
  set_query_method(method)
  method
end
set_description(description) click to toggle source
# File lib/babeltrace2/graph/component-class-dev.rb, line 390
def set_description(description)
  raise ArgumentError, "description is nil" unless description
  res = Babeltrace2.bt_component_class_set_description(@handle, description)
  raise Babeltrace2.process_error(res) if res != :BT_COMPONENT_CLASS_SET_DESCRIPTION_STATUS_OK
  self
end
set_finalize_method(method = nil, &block) click to toggle source
# File lib/babeltrace2/graph/component-class-dev.rb, line 414
def set_finalize_method(method = nil, &block)
  if method.nil?
    raise ArgumentError, "method or block must be provided" unless block_given?
    method = block
  end
  method = _wrap_finalize_method(method)
  res = _set_finalize_method(method)
  raise Babeltrace2.process_error(res) if res != :BT_COMPONENT_CLASS_SET_METHOD_STATUS_OK
  self
end
set_get_supported_mip_versions_method(method = nil, &block) click to toggle source
# File lib/babeltrace2/graph/component-class-dev.rb, line 430
def set_get_supported_mip_versions_method(method = nil, &block)
  if method.nil?
    raise ArgumentError, "method or block must be provided" unless block_given?
    method = block
  end
  method = _wrap_get_supported_mip_versions_method(method)
  res = _set_get_supported_mip_versions_method(method)
  raise Babeltrace2.process_error(res) if res != :BT_COMPONENT_CLASS_SET_METHOD_STATUS_OK
  self
end
set_help(help_text) click to toggle source
# File lib/babeltrace2/graph/component-class-dev.rb, line 402
def set_help(help_text)
  raise ArgumentError, "help_text is nil" unless help_text
  res = Babeltrace2.bt_component_class_set_help(@handle, help_text)
  raise Babeltrace2.process_error(res) if res != :BT_COMPONENT_CLASS_SET_HELP_STATUS_OK
  self
end
set_initialize_method(method = nil, &block) click to toggle source
# File lib/babeltrace2/graph/component-class-dev.rb, line 446
def set_initialize_method(method = nil, &block)
  if method.nil?
    raise ArgumentError, "method or block must be provided" unless block_given?
    method = block
  end
  method = _wrap_initialize_method(method)
  res = _set_initialize_method(method)
  raise Babeltrace2.process_error(res) if res != :BT_COMPONENT_CLASS_SET_METHOD_STATUS_OK
  self
end
set_query_method(method = nil, &block) click to toggle source
# File lib/babeltrace2/graph/component-class-dev.rb, line 462
def set_query_method(method = nil, &block)
  if method.nil?
    raise ArgumentError, "method or block must be provided" unless block_given?
    method = block
  end
  method = _wrap_query_method(method)
  res = _set_query_method(method)
  raise Babeltrace2.process_error(res) if res != :BT_COMPONENT_CLASS_SET_METHOD_STATUS_OK
  self
end
sink?()
Alias for: is_sink
source?()
Alias for: is_source
type()
Alias for: get_type