Included Modules

  • Ziya::YamlHelpers::Base

Class Index

Quicksearch

Ziya::YamlHelpers::Gauges

Public Instance Methods

components() click to toggle source

Alias for #dials

dial( comp_class, comp_name=nil ) click to toggle source

generates a gauge element declaration

Example

 <%= dial :rect %>
 => --- !ruby/object:Ziya::Gauges::Support::Rect


    # File lib/ziya/yaml_helpers/gauges.rb, line 20
20:   def dial( comp_class, comp_name=nil )
21:     clazz = clazz( comp_class, "Gauges::Support" )
22:     comp_name ? "- :#{comp_name}: #{clazz}" : "- #{clazz}"
23:   end
dials() click to toggle source

generates a yaml hash of dials

Example

 <%= dials %>
 => components: !omap


    # File lib/ziya/yaml_helpers/gauges.rb, line 29
29:   def dials
30:     "components: !omap"
31:   end
Also aliased as: components
gauge( class_name ) click to toggle source

generates a gauge yaml class declaration

Example

 <%= gauge :thermo %>

 produces:

 --- !ruby/object:Ziya::Gauges::Thermo
   components: !omap


    # File lib/ziya/yaml_helpers/gauges.rb, line 12
12:   def gauge( class_name )
13:     "--- #{clazz( class_name, 'Gauges' )}\n#{dials}" 
14:   end

secsequence

--- SEC00287

seccomment

--- ""

method_list

--- 
- methods: 
  - visibility: public
    aref: M000011
    name: components
    m_desc: |-
      <p>
      Alias for <a href="Gauges.html#M000010">#dials</a>
      </p>
    params: ()
  - visibility: public
    aref: M000009
    name: dial
    sourcecode: "    <span class=\"ruby-comment cmt\"># File lib/ziya/yaml_helpers/gauges.rb, line 20</span>\n\
      20:   <span class=\"ruby-keyword kw\">def</span> <span class=\"ruby-identifier\">dial</span>( <span class=\"ruby-identifier\">comp_class</span>, <span class=\"ruby-identifier\">comp_name</span>=<span class=\"ruby-keyword kw\">nil</span> )\n\
      21:     <span class=\"ruby-identifier\">clazz</span> = <span class=\"ruby-identifier\">clazz</span>( <span class=\"ruby-identifier\">comp_class</span>, <span class=\"ruby-value str\">&quot;Gauges::Support&quot;</span> )\n\
      22:     <span class=\"ruby-identifier\">comp_name</span> <span class=\"ruby-value\">? </span><span class=\"ruby-node\">&quot;- :#{comp_name}: #{clazz}&quot;</span> <span class=\"ruby-operator\">:</span> <span class=\"ruby-node\">&quot;- #{clazz}&quot;</span>\n\
      23:   <span class=\"ruby-keyword kw\">end</span>"
    m_desc: |-
      <p>
      generates a gauge element declaration
      </p>
      <h4>Example</h4>
      <pre>
       &lt;%= dial :rect %&gt;
       =&gt; --- !ruby/object:Ziya::Gauges::Support::Rect
      </pre>
    params: ( comp_class, comp_name=nil )
  - visibility: public
    aref: M000010
    name: dials
    sourcecode: "    <span class=\"ruby-comment cmt\"># File lib/ziya/yaml_helpers/gauges.rb, line 29</span>\n\
      29:   <span class=\"ruby-keyword kw\">def</span> <span class=\"ruby-identifier\">dials</span>\n\
      30:     <span class=\"ruby-value str\">&quot;components: !omap&quot;</span>\n\
      31:   <span class=\"ruby-keyword kw\">end</span>"
    aka: 
    - aref: Gauges.html#M000011
      name: components
    m_desc: |-
      <p>
      generates a yaml hash of dials
      </p>
      <h4>Example</h4>
      <pre>
       &lt;%= dials %&gt;
       =&gt; components: !omap
      </pre>
    params: ()
  - visibility: public
    aref: M000008
    name: gauge
    sourcecode: "    <span class=\"ruby-comment cmt\"># File lib/ziya/yaml_helpers/gauges.rb, line 12</span>\n\
      12:   <span class=\"ruby-keyword kw\">def</span> <span class=\"ruby-identifier\">gauge</span>( <span class=\"ruby-identifier\">class_name</span> )\n\
      13:     <span class=\"ruby-node\">&quot;--- #{clazz( class_name, 'Gauges' )}\\n#{dials}&quot;</span> \n\
      14:   <span class=\"ruby-keyword kw\">end</span>"
    m_desc: |-
      <p>
      generates a gauge yaml class declaration
      </p>
      <h4>Example</h4>
      <pre>
       &lt;%= gauge :thermo %&gt;
      
       produces:
      
       --- !ruby/object:Ziya::Gauges::Thermo
         components: !omap
      </pre>
    params: ( class_name )
  category: Instance
  type: Public

sectitle

---

[Validate]

Generated with the Darkfish Rdoc Generator.