api/Rex/Parser/GraphML/Element/Edge.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
  Class: Rex::Parser::GraphML::Element::Edge
  
    &mdash; Documentation by YARD 0.9.37
  
</title>

  <link rel="stylesheet" href="../../../../css/style.css" type="text/css" />

  <link rel="stylesheet" href="../../../../css/common.css" type="text/css" />

<script type="text/javascript">
  pathId = "Rex::Parser::GraphML::Element::Edge";
  relpath = '../../../../';
</script>


  <script type="text/javascript" charset="utf-8" src="../../../../js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="../../../../js/app.js"></script>


  </head>
  <body>
    <div class="nav_wrap">
      <iframe id="nav" src="../../../../class_list.html?1"></iframe>
      <div id="resizer"></div>
    </div>

    <div id="main" tabindex="-1">
      <div id="header">
        <div id="menu">
  
    <a href="../../../../_index.html">Index (E)</a> &raquo;
    <span class='title'><span class='object_link'><a href="../../../../Rex.html" title="Rex (module)">Rex</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../../Parser.html" title="Rex::Parser (module)">Parser</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../GraphML.html" title="Rex::Parser::GraphML (module)">GraphML</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Element.html" title="Rex::Parser::GraphML::Element (module)">Element</a></span></span>
     &raquo; 
    <span class="title">Edge</span>
  
</div>

        <div id="search">
  
    <a class="full_list_link" id="class_list_link"
        href="../../../../class_list.html">

        <svg width="24" height="24">
          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
        </svg>
    </a>
  
</div>
        <div class="clear"></div>
      </div>

      <div id="content"><h1>Class: Rex::Parser::GraphML::Element::Edge
  
  
</h1>
<div class="box_info">
  
  <dl>
    <dt>Inherits:</dt>
    <dd>
      <span class="inheritName"><span class='object_link'><a href="../AttributeContainer.html" title="Rex::Parser::GraphML::AttributeContainer (class)">AttributeContainer</a></span></span>
      
        <ul class="fullTree">
          <li>Object</li>
          
            <li class="next"><span class='object_link'><a href="../AttributeContainer.html" title="Rex::Parser::GraphML::AttributeContainer (class)">AttributeContainer</a></span></li>
          
            <li class="next">Rex::Parser::GraphML::Element::Edge</li>
          
        </ul>
        <a href="#" class="inheritanceTree">show all</a>
      
    </dd>
  </dl>
  

  <dl>
    <dt>Defined in:</dt>
    <dd>lib/rex/parser/graphml.rb</dd>
  </dl>
  
</div>

<h2>Overview</h2><div class="docstring">
  <div class="discussion">
    
<p>An edge element defines a connection between two nodes. Connections are optionally directional. See: <a href="http://graphml.graphdrawing.org/specification/xsd.html#element-edge">graphml.graphdrawing.org/specification/xsd.html#element-edge</a></p>


  </div>
</div>
<div class="tags">
  

</div>
  
    <h2>
      Constant Summary
      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
    </h2>

    <dl class="constants">
      
        <dt id="ELEMENT_NAME-constant" class="">ELEMENT_NAME =
          
        </dt>
        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>edge</span><span class='tstring_end'>&#39;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
      
    </dl>
  

  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
  <ul class="summary">
    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#directed-instance_method" title="#directed (instance method)">#<strong>directed</strong>  &#x21d2; Object </a>
    

  </span>
  
  
      <span class="note title readonly">readonly</span>
    
    
    <span class="summary_desc"><div class='inline'>
<p>!@attribute directed   @return [Boolean] Whether or not this edge only connects in one direction.</p>
</div></span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong>  &#x21d2; Object </a>
    

  </span>
  
  
      <span class="note title readonly">readonly</span>
    
    
    <span class="summary_desc"><div class='inline'>
<p>!@attribute id   @return [String] The optional, unique identifier of this edge.</p>
</div></span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#source-instance_method" title="#source (instance method)">#<strong>source</strong>  &#x21d2; Object </a>
    

  </span>
  
  
      <span class="note title readonly">readonly</span>
    
    
    <span class="summary_desc"><div class='inline'>
<p>!@attribute source   @return [String] The id of the node that this edge originated from.</p>
</div></span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#target-instance_method" title="#target (instance method)">#<strong>target</strong>  &#x21d2; Object </a>
    

  </span>
  
  
      <span class="note title readonly">readonly</span>
    
    
    <span class="summary_desc"><div class='inline'>
<p>!@attribute target   @return [String] The id of the node that this edge is destined for.</p>
</div></span>
  
</li>

    
  </ul>


  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../AttributeContainer.html" title="Rex::Parser::GraphML::AttributeContainer (class)">AttributeContainer</a></span></h3>
  <p class="inherited"><span class='object_link'><a href="../AttributeContainer.html#attributes-instance_method" title="Rex::Parser::GraphML::AttributeContainer#attributes (method)">#attributes</a></span></p>


    <h2>
      Class Method Summary
      <small><a href="#" class="summary_toggle">collapse</a></small>
    </h2>

    <ul class="summary">
      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#from_xml_attributes-class_method" title="from_xml_attributes (class method)">.<strong>from_xml_attributes</strong>(xml_attrs, edgedefault)  &#x21d2; Object </a>
    

  </span>
  
  
    <span class="summary_desc"><div class='inline'></div></span>
  
</li>

      
    </ul>
  
    <h2>
      Instance Method Summary
      <small><a href="#" class="summary_toggle">collapse</a></small>
    </h2>

    <ul class="summary">
      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(source, target, directed, id: nil)  &#x21d2; Edge </a>
    

  </span>
  
  
    <span class="note title constructor">constructor</span>
  
  
    <span class="summary_desc"><div class='inline'>
<p>A new instance of Edge.</p>
</div></span>
  
</li>

      
    </ul>
  

  <div id="constructor_details" class="method_details_list">
  <h2>Constructor Details</h2>
  
    <div class="method_details first">
  <h3 class="signature first" id="initialize-instance_method">
  
    #<strong>initialize</strong>(source, target, directed, id: nil)  &#x21d2; <tt><span class='object_link'><a href="" title="Rex::Parser::GraphML::Element::Edge (class)">Edge</a></span></tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>Returns a new instance of Edge.</p>


  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>source</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        &mdash;
        <div class='inline'>
<p>The id of the node that this edge originated from.</p>
</div>
      
    </li>
  
    <li>
      
        <span class='name'>target</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        &mdash;
        <div class='inline'>
<p>The id of the node that this edge is destined for.</p>
</div>
      
    </li>
  
    <li>
      
        <span class='name'>directed</span>
      
      
        <span class='type'>(<tt>Boolean</tt>)</span>
      
      
        &mdash;
        <div class='inline'>
<p>Whether or not this edge only connects in one direction.</p>
</div>
      
    </li>
  
    <li>
      
        <span class='name'>id</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>nil</tt>)</em>
      
      
        &mdash;
        <div class='inline'>
<p>The optional, unique identifier of this edge.</p>
</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


185
186
187
188
189
190
191</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/rex/parser/graphml.rb', line 185</span>

<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_source'>source</span><span class='comma'>,</span> <span class='id identifier rubyid_target'>target</span><span class='comma'>,</span> <span class='id identifier rubyid_directed'>directed</span><span class='comma'>,</span> <span class='label'>id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
  <span class='ivar'>@source</span> <span class='op'>=</span> <span class='id identifier rubyid_source'>source</span>
  <span class='ivar'>@target</span> <span class='op'>=</span> <span class='id identifier rubyid_target'>target</span>
  <span class='ivar'>@directed</span> <span class='op'>=</span> <span class='id identifier rubyid_directed'>directed</span>
  <span class='ivar'>@id</span> <span class='op'>=</span> <span class='id identifier rubyid_id'>id</span>
  <span class='kw'>super</span><span class='lparen'>(</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
  
</div>

  <div id="instance_attr_details" class="attr_details">
    <h2>Instance Attribute Details</h2>
    
      
      <span id=""></span>
      <div class="method_details first">
  <h3 class="signature first" id="directed-instance_method">
  
    #<strong>directed</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>!@attribute directed</p>

<pre class="code ruby"><code class="ruby">@return [Boolean] Whether or not this edge only connects in one direction.
</code></pre>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


220
221
222</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/rex/parser/graphml.rb', line 220</span>

<span class='kw'>def</span> <span class='id identifier rubyid_directed'>directed</span>
  <span class='ivar'>@directed</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id=""></span>
      <div class="method_details ">
  <h3 class="signature " id="id-instance_method">
  
    #<strong>id</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>!@attribute id</p>

<pre class="code ruby"><code class="ruby">@return [String] The optional, unique identifier of this edge.
</code></pre>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


223
224
225</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/rex/parser/graphml.rb', line 223</span>

<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
  <span class='ivar'>@id</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id=""></span>
      <div class="method_details ">
  <h3 class="signature " id="source-instance_method">
  
    #<strong>source</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>!@attribute source</p>

<pre class="code ruby"><code class="ruby">@return [String] The id of the node that this edge originated from.
</code></pre>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


214
215
216</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/rex/parser/graphml.rb', line 214</span>

<span class='kw'>def</span> <span class='id identifier rubyid_source'>source</span>
  <span class='ivar'>@source</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      
      <span id=""></span>
      <div class="method_details ">
  <h3 class="signature " id="target-instance_method">
  
    #<strong>target</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
  

</h3><div class="docstring">
  <div class="discussion">
    
<p>!@attribute target</p>

<pre class="code ruby"><code class="ruby">@return [String] The id of the node that this edge is destined for.
</code></pre>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


217
218
219</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/rex/parser/graphml.rb', line 217</span>

<span class='kw'>def</span> <span class='id identifier rubyid_target'>target</span>
  <span class='ivar'>@target</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
  </div>


  <div id="class_method_details" class="method_details_list">
    <h2>Class Method Details</h2>

    
      <div class="method_details first">
  <h3 class="signature first" id="from_xml_attributes-class_method">
  
    .<strong>from_xml_attributes</strong>(xml_attrs, edgedefault)  &#x21d2; <tt>Object</tt> 
  

</h3><div class="docstring">
  <div class="discussion">
    

  </div>
</div>
<div class="tags">
  
<p class="tag_title">Raises:</p>
<ul class="raise">
  
    <li>
      
      
        <span class='type'>(<tt><span class='object_link'><a href="../Error/InvalidAttributeError.html" title="Rex::Parser::GraphML::Error::InvalidAttributeError (class)">Error::InvalidAttributeError</a></span></tt>)</span>
      
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/rex/parser/graphml.rb', line 193</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_xml_attributes'>from_xml_attributes</span><span class='lparen'>(</span><span class='id identifier rubyid_xml_attrs'>xml_attrs</span><span class='comma'>,</span> <span class='id identifier rubyid_edgedefault'>edgedefault</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_source'>source</span> <span class='op'>=</span> <span class='id identifier rubyid_xml_attrs'>xml_attrs</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>source</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
  <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../Error.html" title="Rex::Parser::GraphML::Error (module)">Error</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Error/InvalidAttributeError.html" title="Rex::Parser::GraphML::Error::InvalidAttributeError (class)">InvalidAttributeError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Error/InvalidAttributeError.html#initialize-instance_method" title="Rex::Parser::GraphML::Error::InvalidAttributeError#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>edge</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>source</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_source'>source</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>

  <span class='id identifier rubyid_target'>target</span> <span class='op'>=</span> <span class='id identifier rubyid_xml_attrs'>xml_attrs</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>target</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
  <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../Error.html" title="Rex::Parser::GraphML::Error (module)">Error</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Error/InvalidAttributeError.html" title="Rex::Parser::GraphML::Error::InvalidAttributeError (class)">InvalidAttributeError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Error/InvalidAttributeError.html#initialize-instance_method" title="Rex::Parser::GraphML::Error::InvalidAttributeError#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>edge</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>target</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_target'>target</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>

  <span class='id identifier rubyid_directed'>directed</span> <span class='op'>=</span> <span class='id identifier rubyid_xml_attrs'>xml_attrs</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>directed</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
  <span class='kw'>if</span> <span class='id identifier rubyid_directed'>directed</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
    <span class='id identifier rubyid_directed'>directed</span> <span class='op'>=</span> <span class='id identifier rubyid_edgedefault'>edgedefault</span> <span class='op'>==</span> <span class='symbol'>:directed</span>
  <span class='kw'>elsif</span> <span class='qwords_beg'>%w[</span><span class='tstring_content'>true</span><span class='words_sep'> </span><span class='tstring_content'>false</span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_directed'>directed</span>
    <span class='id identifier rubyid_directed'>directed</span> <span class='op'>=</span> <span class='id identifier rubyid_directed'>directed</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>true</span><span class='tstring_end'>&#39;</span></span>
  <span class='kw'>else</span>
    <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../Error.html" title="Rex::Parser::GraphML::Error (module)">Error</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Error/InvalidAttributeError.html" title="Rex::Parser::GraphML::Error::InvalidAttributeError (class)">InvalidAttributeError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Error/InvalidAttributeError.html#initialize-instance_method" title="Rex::Parser::GraphML::Error::InvalidAttributeError#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>edge</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>directed</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>details:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>must be either true or false when specified</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>missing:</span> <span class='kw'>false</span><span class='rparen'>)</span>
  <span class='kw'>end</span>

  <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_source'>source</span><span class='comma'>,</span> <span class='id identifier rubyid_target'>target</span><span class='comma'>,</span> <span class='id identifier rubyid_directed'>directed</span><span class='comma'>,</span> <span class='label'>id:</span> <span class='id identifier rubyid_xml_attrs'>xml_attrs</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
  </div>

</div>

      <div id="footer">
  Generated on Fri May  8 17:04:06 2026 by
  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.9.37 (ruby-3.1.5).
</div>

    </div>
  </body>
</html>