Class: Origen::Specs::Exhibit

Inherits:
Object
  • Object
show all
Defined in:
lib/origen/specs/exhibit.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, type, overrides, options = {}) ⇒ Exhibit

Returns a new instance of Exhibit.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# 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

Instance Attribute Details

#block_id ⇒ Object

Block ID that this exhibit is being used in.



27
28
29
 
# File 'lib/origen/specs/exhibit.rb', line 27

def block_id
  @block_id
end

#description ⇒ Object

Description for the Exhibit



15
16
17
 
# File 'lib/origen/specs/exhibit.rb', line 15

def description
  @description
end

#description_override ⇒ Object

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



36
37
38
 
# File 'lib/origen/specs/exhibit.rb', line 36

def description_override
  @description_override
end

#id ⇒ Object

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



6
7
8
 
# File 'lib/origen/specs/exhibit.rb', line 6

def id
  @id
end

#include_exhibit ⇒ Object

Do we include the exhibit in this block



24
25
26
 
# File 'lib/origen/specs/exhibit.rb', line 24

def include_exhibit
  @include_exhibit
end

#markup ⇒ Object

Markup needed for the exhibit



21
22
23
 
# File 'lib/origen/specs/exhibit.rb', line 21

def markup
  @markup
end

#reference ⇒ Object

Reference link



18
19
20
 
# File 'lib/origen/specs/exhibit.rb', line 18

def reference
  @reference
end

#reference_override ⇒ Object

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



33
34
35
 
# File 'lib/origen/specs/exhibit.rb', line 33

def reference_override
  @reference_override
end

#title ⇒ Object

Title for the Exhibit.



12
13
14
 
# File 'lib/origen/specs/exhibit.rb', line 12

def title
  @title
end

#title_override ⇒ Object

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



30
31
32
 
# File 'lib/origen/specs/exhibit.rb', line 30

def title_override
  @title_override
end

#type ⇒ Object

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



9
10
11
 
# File 'lib/origen/specs/exhibit.rb', line 9

def type
  @type
end