Class: Origen::Specs::Spec_Features

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

Overview

Ruby Data Class that contains Creation Information for the IP Block

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, attrs, applicable_devices, text, internal_comments) ⇒ Spec_Features

Initialize the Feature to be used


35
36
37
38
39
40
41
42
43
# File 'lib/origen/specs/spec_features.rb', line 35

def initialize(id, attrs, applicable_devices, text, internal_comments)
  @id = id
  @type = attrs[:type]
  @feature_ref = attrs[:feature_ref]
  @audience = attrs[:audience]
  @applicable_devices = applicable_devices
  @text = text
  @internal_comments = internal_comments
end

Instance Attribute Details

#applicable_devicesObject

Applicable Devices for this feature. This allows for multiple devices from one piece of silicon

If this feature is on Part B and Part D, then applicable devices will include Part B and Part D, but no other parts

22
23
24
# File 'lib/origen/specs/spec_features.rb', line 22

def applicable_devices
  @applicable_devices
end

#audienceObject

Intended Audience for this feature. Internal or External?


32
33
34
# File 'lib/origen/specs/spec_features.rb', line 32

def audience
  @audience
end

#feature_refObject

Feature Reference

To be used for sub-feature so that they can be linked easily

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

def feature_ref
  @feature_ref
end

#idObject

This is the Id of the Feature that will be referenced Future goal is to be able to tie this ID to a specification in a Product Requirements Document


7
8
9
# File 'lib/origen/specs/spec_features.rb', line 7

def id
  @id
end

#internal_commentsObject

Internal comments about this feature. Why was this feature included here? Any changes from the Product Requirements Document


29
30
31
# File 'lib/origen/specs/spec_features.rb', line 29

def internal_comments
  @internal_comments
end

#textObject

The actual text of the feature


25
26
27
# File 'lib/origen/specs/spec_features.rb', line 25

def text
  @text
end

#typeObject

Feature Type Current supported types are

intro :: Intro Paragraph for the Features Page
feature :: Main Feature (e.g. Additional peripherals include)
subfeature :: Sub Feature that will be a sub-bullet to feature.  (e.g. Four I2C controllers)

14
15
16
# File 'lib/origen/specs/spec_features.rb', line 14

def type
  @type
end