class Syskit::GUI::ComponentNetworkView

Generic component network visualization

It displays the task hierarchy as well as the dataflow network

Attributes

dataflow_options[R]

Default rendering options for {ComponentNetworkBaseView#push_plan} for the dataflow graph

hierarchy_options[R]

Default rendering options for {ComponentNetworkBaseView#push_plan} for the hierarchy graph

plan[R]

The plan object that holds the network we render

@return [Roby::Plan]

task[R]

The toplevel task for the model we render

@return [Syskit::Component]

Public Class Methods

new(page) click to toggle source

Calls superclass method Syskit::GUI::ComponentNetworkBaseView.new

# File lib/syskit/gui/component_network_view.rb, line 34
def initialize(page)
    super
    @view_partial_plans = true
    @plan = Roby::Plan.new

    @hierarchy_options = Hash[
        title: 'Task Dependency Hierarchy',
        id: 'hierarchy',
        remove_compositions: false,
        annotations: ['task_info', 'port_details'].to_set,
        zoom: 1
    ]
    @dataflow_options = Hash[
        title: 'Dataflow',
        id: 'dataflow',
        remove_compositions: false,
        show_all_ports: false,
        annotations: ['task_info'].to_set,
        excluded_models: Set.new,
        zoom: 1
    ]

    buttons = []
    buttons << Button.new("dataflow/show_compositions",
                          on_text: 'Show compositions',
                          off_text: 'Hide compositions',
                          state: !dataflow_options[:remove_compositions])
    buttons << Button.new("dataflow/show_all_ports",
                          on_text: 'Show all ports',
                          off_text: 'Hide unused ports',
                          state: dataflow_options[:show_all_ports])

    if defined? OroGen::Logger::Logger
        dataflow_options[:excluded_models] << OroGen::Logger::Logger
        buttons << Button.new("dataflow/show_loggers",
                              on_text: 'Show loggers',
                              off_text: 'Hide loggers',
                              state: false)
    end

    buttons.concat(self.class.common_graph_buttons('dataflow'))
    buttons.concat(self.class.task_annotation_buttons('dataflow', dataflow_options[:annotations]))
    buttons.concat(self.class.graph_annotation_buttons('dataflow', dataflow_options[:annotations]))
    dataflow_options[:buttons] = buttons

    buttons = []
    buttons.concat(self.class.common_graph_buttons('hierarchy'))
    hierarchy_options[:buttons] = buttons
end

Public Instance Methods

process_options(kind, model, options) click to toggle source

# File lib/syskit/gui/component_network_view.rb, line 157
def process_options(kind, model, options)
    options = Kernel.normalize_options options

    name = options[:name]
    if options[:id]
        options[:id] = options[:id] % "#{kind}-#{name}"
    end

    if externals = options.delete(:external_objects)
        options[:external_objects] = externals % "#{kind}-#{name}"
    end
    options
end

render(model, method: :instanciate_model, name: nil, show_requirements: false, instanciate_options: Hash.new, dataflow: Hash.new, hierarchy: Hash.new, **render_options) click to toggle source

Render a model on this view

@param [Model<Component>] model @param [Symbol] method how to render the model. It either is

:instanciate_model
(#{ComponentNetworkBaseView#instanciate_model}) or
:compute_system_network (#{ComponentNetworkBaseView#compute_system_network})

@param [Boolean] show_requirements whether

model.to_instance_requirements should be rendered as well

@param [Hash] instanciate_options options to be passed to

{ComponentNetworkBaseView#instanciate_model} if 'method' is
:intsanciate_model

@param [Hash] dataflow additional arguments for the rendering of the

dataflow grap in {#render_plan}

@param [Hash] hierarchy additional arguments for the rendering of the

hierarchy graph in {#render_plan}

@param [Hash] render_options additional options for the rendering

of both graphs in {#render_plan}

Calls superclass method Syskit::GUI::ComponentNetworkBaseView#render

# File lib/syskit/gui/component_network_view.rb, line 102
def render(model,
           method: :instanciate_model,
           name: nil,
           show_requirements: false,
           instanciate_options: Hash.new,
           dataflow: Hash.new,
           hierarchy: Hash.new,
           **render_options)
    super

    plan.clear

    if show_requirements
        html = ModelViews.render_instance_requirements(page,
                model.to_instance_requirements,
                resolve_dependency_injection: true).join("\n")
        page.push("Resolved Requirements", "<pre>#{html}</pre>")
    end

    begin
        if method == :compute_system_network
            tic = Time.now
            @task = compute_system_network(model, plan)
            timing = Time.now - tic
        else
            @task = instanciate_model(model, plan, instanciate_options)
        end
    rescue Exception => e
        if view_partial_plans? then
            exception = e
        else raise
        end
    end

    render_options[:name] ||= model.object_id.to_s
    if timing
        page.push("", "<p>Network generated in %.3f</p>" % [timing], id: "timing-#{name}")
    end

    hierarchy_options = self.hierarchy_options.
        merge(render_options).
        merge(hierarchy)
    hierarchy_options = process_options('hierarchy', model, hierarchy_options)
    dataflow_options = self.dataflow_options.
        merge(render_options).
        merge(dataflow)
    dataflow_options = process_options('dataflow', model, dataflow_options)


    render_plan
    if exception
        raise exception
    end
end

render_plan(hierarchy: Hash.new, dataflow: Hash.new, **options) click to toggle source

Renders {#plan}

This renders the plan's hierarchy and dataflow

@param [Hash] hierarchy options to pass to

{ComponentNetworkBaseView#push_plan} in addition to 'options'
and {#hierarchy_options}

@param [Hash] dataflow options to pass to

{ComponentNetworkBaseView#push_plan} in addition to 'options'
and {#dataflow_options}

@param [Hash] options options that should be passed to {#push_plan} for both the hierarchy and dataflow graphs

# File lib/syskit/gui/component_network_view.rb, line 183
def render_plan(hierarchy: Hash.new, dataflow: Hash.new, **options)
    all_annotations = Syskit::Graphviz.available_annotations.to_set

    hierarchy_options = options.merge(self.hierarchy_options).merge(hierarchy)
    push_plan('hierarchy', plan, hierarchy_options)
    dataflow_options = Hash[annotations: all_annotations].
        merge(self.dataflow_options).merge(options).merge(dataflow)
    push_plan('dataflow', plan, dataflow_options)
    emit updated
end