class Origen::Specs::Exhibit

This class is used to store spec exhibit information used to document IP

Attributes

block_id[RW]

Block ID that this exhibit is being used in.

description[RW]

Description for the Exhibit

description_override[RW]

Description Override. This allows for the SoC to use a different description

id[RW]

ID for the exhibit. This allows the exhibit to reference easier

include_exhibit[RW]

Do we include the exhibit in this block

markup[RW]

Markup needed for the exhibit

reference[RW]

Reference link

reference_override[RW]

Reference Override. This allows for the SoC to use a different figure (e.g. Power Supplies are different)

title[RW]

Title for the Exhibit.

title_override[RW]

Title Override. Allows for the SoC to override the title so that it makes more sense

type[RW]

Type of exhibit. Currently only :fig is supported. In the future, this could be :topic or :table or anything else

Public Class Methods

new(id, type, overrides, options = {}) click to toggle source
# File lib/origen/specs/exhibit.rb, line 38
def initialize(id, type, overrides, options = {})
  @id = id
  @type = type
  @title = options[:title]
  @description = options[:description]
  @reference = options[:reference]
  @title_override = overrides[:title]
  @reference_override = overrides[:reference]
  @description_override = overrides[:description]
  @markup = options[:markup]
  @include_exhibit = true
  @include_exhibit = options[:include_exhibit] unless options[:include_exhibit].nil?
  @block_id = options[:block_id]
end