class Origen::Specs::Documentation

This class is used to store documentation map that the user can change

Attributes

applicable_devices[RW]

Applicable Devices for the map

audience[RW]

Audience is part of the 4-D Hash for the Tables. Corresponds to Spec 4-D Hash

interface[RW]

Exhibit References that should be referenced within the table title

level[RW]

Level that Section is at. Allows for a key to be found.

mode[RW]

Mode is part of the 4-D Hash for the Tables. Corresponds to Spec 4-D Hash

section[RW]

This is the Section Header for the Documentation Map. Usually these are main headers Examples:

I. Overall DC Electricals
II. General AC Charactertistics
III. Power Sequencing
sub_type[RW]

SubType is part of the 4-D Hash for the Tables. Corresponds to Spec 4-D Hash

subsection[RW]

This is the subsection header for the Documentation Map. These are found under main headers Examples

I. Overall DC electrical
  A. Absolute Maximum Ratings
  B. Recommend Operating Conditions
  C. Output Driver
type[RW]

Type is part of the 4-D Hash for the Tables. Corresponds to Spec 4-D Hash Usual values

  • DC -> Direct Current

  • AC -> Alternate Current

  • Temp -> Temperature

  • Supply -> Supply

Public Class Methods

new(header_info = {}, selection = {}, applicable_devs = [], link = nil) click to toggle source

Initialize the Class

# File lib/origen/specs/documentation.rb, line 51
def initialize(header_info = {}, selection = {}, applicable_devs = [], link = nil)
  @level = header_info[:level]
  @section = header_info[:section]
  @subsection = header_info[:subsection]
  @interface = selection[:interface]
  @mode = selection[:mode]
  @type = selection[:type]
  @sub_type = selection[:sub_type]
  @audience = selection[:audience]
  @applicable_devices = applicable_devs
  @link = link
end