Your IP : 216.73.216.48


Current Path : /usr/X11R6/share/apps/rocs/engineapi/
Upload File :
Current File : //usr/X11R6/share/apps/rocs/engineapi/GraphNode.xml

<?xml version="1.0"?>
<object inherit="Data">
<name>Graph Node</name>
<id>GraphNode</id>
<componentType>Data</componentType>
<description>
<para>
A node is the data element of a graph.
</para>
</description>
<syntax>
</syntax>
<properties>
</properties>
<methods>
<method>
    <name>neighbors()</name>
    <description>
        <para>Return list all nodes connected to this node. This method respects if edges are directed.</para>
    </description>
    <returnType>array</returnType>
    <parameters>
    </parameters>
</method>
<method>
    <name>edges()</name>
    <description>
        <para>Return a list of all edges (incoming and outgoing) of this node.</para>
    </description>
    <returnType>array</returnType>
    <parameters>
    </parameters>
</method>
<method>
    <name>edges(type)</name>
    <description>
        <para>Return a list of all edges (incoming and outgoing) of this node of a specified type.</para>
    </description>
    <returnType>array</returnType>
    <parameters>
        <parameter>
            <name>type</name>
            <type>int</type>
            <info>Identifier of an edge type.</info>
        </parameter>
    </parameters>
</method>
<method>
    <name>inEdges()</name>
    <description>
        <para>Return a list of incoming edges of this node.</para>
    </description>
    <returnType>array</returnType>
    <parameters>
    </parameters>
</method>
<method>
    <name>inEdges(type)</name>
    <description>
        <para>Return a list of all incoming edges of this node of a specified type.</para>
    </description>
    <returnType>array</returnType>
    <parameters>
        <parameter>
            <name>type</name>
            <type>int</type>
            <info>Identifier of an edge type.</info>
        </parameter>
    </parameters>
</method>
<method>
    <name>outEdges()</name>
    <description>
        <para>Return a list of all outgoing edges of this node.</para>
    </description>
    <returnType>array</returnType>
    <parameters>
    </parameters>
</method>
<method>
    <name>outEdges(type)</name>
    <description>
        <para>Return a list of all outgoing edges of this node of a specified type.</para>
    </description>
    <returnType>array</returnType>
    <parameters>
        <parameter>
            <name>type</name>
            <type>int</type>
            <info>Identifier of an edge type.</info>
        </parameter>
    </parameters>
</method>
<method>
    <name>edgesTo(target)</name>
    <description>
        <para>Return a list of all edges of this node to the specified node.</para>
    </description>
    <returnType>array</returnType>
    <parameters>
        <parameter>
            <name>target</name>
            <type>GraphNode</type>
            <info>Target node.</info>
        </parameter>
    </parameters>
</method>
</methods>
</object>