Sophie

Sophie

distrib > Mandriva > 2010.1 > x86_64 > media > contrib-release > by-pkgid > 2eca861f24be6048290ed27335ec22aa > files > 671

flumotion-doc-0.6.1-1mdv2010.0.x86_64.rpm

<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>flumotion.component.converters.pipeline.pipeline.Converter</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;flumotion ::
        <a href="flumotion.component-module.html">Package&nbsp;component</a> ::
        <a href="flumotion.component.converters-module.html">Package&nbsp;converters</a> ::
        <a href="flumotion.component.converters.pipeline-module.html">Package&nbsp;pipeline</a> ::
        <a href="flumotion.component.converters.pipeline.pipeline-module.html">Module&nbsp;pipeline</a> ::
        Class&nbsp;Converter
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Converter</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.component.converters.pipeline.pipeline-pysrc.html#Converter">source&nbsp;code</a></span></p>
<pre class="base-tree">
             object --+                
                      |                
<a href="flumotion.common.common.InitMixin-class.html">common.common.InitMixin</a> --+            
                          |            
<a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a> --+            
                          |            
    <a href="flumotion.component.component.BaseComponent-class.html">component.BaseComponent</a> --+        
                              |        
 <a href="flumotion.component.feedcomponent010.FeedComponent-class.html">feedcomponent010.FeedComponent</a> --+    
                                  |    
 <a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html">feedcomponent.ParseLaunchComponent</a> --+
                                      |
                                     <strong class="uidshort">Converter</strong>
</pre>

<hr />
<!-- ==================== NESTED CLASSES ==================== -->
<a name="section-NestedClasses"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Nested Classes</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-NestedClasses"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.component.component.BaseComponent-class.html">component.BaseComponent</a></code></b>:
      <code><a href="flumotion.component.component.BaseComponentMedium-class.html">componentMediumClass</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="flumotion.component.converters.pipeline.pipeline.Converter-class.html#get_pipeline_string" class="summary-sig-name">get_pipeline_string</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">properties</span>)</span><br />
      Method that must be implemented by subclasses to produce the gstparse
      string for the component's pipeline.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="flumotion.component.converters.pipeline.pipeline-pysrc.html#Converter.get_pipeline_string">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html">feedcomponent.ParseLaunchComponent</a></code></b>:
      <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html#add_default_eater_feeder">add_default_eater_feeder</a></code>,
      <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html#configure_pipeline">configure_pipeline</a></code>,
      <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html#create_pipeline">create_pipeline</a></code>,
      <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html#get_eater_template">get_eater_template</a></code>,
      <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html#get_feeder_template">get_feeder_template</a></code>,
      <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html#get_queue_string">get_queue_string</a></code>,
      <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html#init">init</a></code>,
      <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html#parse_pipeline">parse_pipeline</a></code>,
      <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html#parse_tmpl">parse_tmpl</a></code>,
      <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html#set_pipeline">set_pipeline</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html">feedcomponent010.FeedComponent</a></code></b>:
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#addEffect">addEffect</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#attachPadMonitorToFeeder">attachPadMonitorToFeeder</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#bus_message_received_cb">bus_message_received_cb</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#cleanup">cleanup</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#connect_feeders">connect_feeders</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#do_pipeline_playing">do_pipeline_playing</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#do_setup">do_setup</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#do_stop">do_stop</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#eatFromFD">eatFromFD</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#feedToFD">feedToFD</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#get_element">get_element</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#get_element_property">get_element_property</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#get_master_clock">get_master_clock</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#get_pipeline">get_pipeline</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#install_eater_continuity_watch">install_eater_continuity_watch</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#install_eater_event_probes">install_eater_event_probes</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#make_message_for_gstreamer_error">make_message_for_gstreamer_error</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#provide_master_clock">provide_master_clock</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#reconnectEater">reconnectEater</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#set_element_property">set_element_property</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#set_master_clock">set_master_clock</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#setup_completed">setup_completed</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#stop_pipeline">stop_pipeline</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#try_start_pipeline">try_start_pipeline</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#unblock_eater">unblock_eater</a></code>
      </p>
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html">feedcomponent010.FeedComponent</a></code></b> (private):
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#_feeder_probe_calllater" onclick="show_private();">_feeder_probe_calllater</a></code>,
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#_setup_pipeline" onclick="show_private();">_setup_pipeline</a></code>
      </p></div>
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.component.component.BaseComponent-class.html">component.BaseComponent</a></code></b>:
      <code><a href="flumotion.component.component.BaseComponent-class.html#__init__">__init__</a></code>,
      <code><a href="flumotion.component.component.BaseComponent-class.html#addMessage">addMessage</a></code>,
      <code><a href="flumotion.component.component.BaseComponent-class.html#adminCallRemote">adminCallRemote</a></code>,
      <code><a href="flumotion.component.component.BaseComponent-class.html#check_properties">check_properties</a></code>,
      <code><a href="flumotion.component.component.BaseComponent-class.html#do_check">do_check</a></code>,
      <code><a href="flumotion.component.component.BaseComponent-class.html#fixRenamedProperties">fixRenamedProperties</a></code>,
      <code><a href="flumotion.component.component.BaseComponent-class.html#getMood">getMood</a></code>,
      <code><a href="flumotion.component.component.BaseComponent-class.html#getName">getName</a></code>,
      <code><a href="flumotion.component.component.BaseComponent-class.html#getWorkerName">getWorkerName</a></code>,
      <code><a href="flumotion.component.component.BaseComponent-class.html#setMedium">setMedium</a></code>,
      <code><a href="flumotion.component.component.BaseComponent-class.html#setMood">setMood</a></code>,
      <code><a href="flumotion.component.component.BaseComponent-class.html#setShutdownHook">setShutdownHook</a></code>,
      <code><a href="flumotion.component.component.BaseComponent-class.html#setWorkerName">setWorkerName</a></code>,
      <code><a href="flumotion.component.component.BaseComponent-class.html#setup">setup</a></code>,
      <code><a href="flumotion.component.component.BaseComponent-class.html#stop">stop</a></code>,
      <code><a href="flumotion.component.component.BaseComponent-class.html#waitForHappy">waitForHappy</a></code>
      </p>
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.component.component.BaseComponent-class.html">component.BaseComponent</a></code></b> (private):
      <code><a href="flumotion.component.component.BaseComponent-class.html#_pollCPU" onclick="show_private();">_pollCPU</a></code>,
      <code><a href="flumotion.component.component.BaseComponent-class.html#_pollMemory" onclick="show_private();">_pollMemory</a></code>
      </p></div>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a></code></b>:
      <code><a href="flumotion.extern.log.log.Loggable-class.html#debug">debug</a></code>,
      <code><a href="flumotion.extern.log.log.Loggable-class.html#doLog">doLog</a></code>,
      <code><a href="flumotion.extern.log.log.Loggable-class.html#error">error</a></code>,
      <code><a href="flumotion.extern.log.log.Loggable-class.html#info">info</a></code>,
      <code><a href="flumotion.extern.log.log.Loggable-class.html#log">log</a></code>,
      <code><a href="flumotion.extern.log.log.Loggable-class.html#logFunction">logFunction</a></code>,
      <code><a href="flumotion.extern.log.log.Loggable-class.html#logObjectName">logObjectName</a></code>,
      <code><a href="flumotion.extern.log.log.Loggable-class.html#warning">warning</a></code>,
      <code><a href="flumotion.extern.log.log.Loggable-class.html#warningFailure">warningFailure</a></code>,
      <code><a href="flumotion.extern.log.log.Loggable-class.html#writeMarker">writeMarker</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Class Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassVariables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="logCategory"></a><span class="summary-name">logCategory</span> = <code title="'conv-pipe'"><code class="variable-quote">'</code><code class="variable-string">conv-pipe</code><code class="variable-quote">'</code></code><br />
      Implementors can provide a category to log their messages under.
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html">feedcomponent.ParseLaunchComponent</a></code></b>:
      <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html#DELIMITER">DELIMITER</a></code>,
      <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html#DEPAY_TMPL">DEPAY_TMPL</a></code>,
      <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html#EATER_TMPL">EATER_TMPL</a></code>,
      <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html#FDSRC_TMPL">FDSRC_TMPL</a></code>,
      <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html#FEEDER_TMPL">FEEDER_TMPL</a></code>,
      <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html#checkOffset">checkOffset</a></code>,
      <code><a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html#checkTimestamp">checkTimestamp</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html">feedcomponent010.FeedComponent</a></code></b>:
      <code><a href="flumotion.component.feedcomponent010.FeedComponent-class.html#FEEDER_STATS_UPDATE_FREQUENCY">FEEDER_STATS_UPDATE_FREQUENCY</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceVariables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.component.component.BaseComponent-class.html">component.BaseComponent</a></code></b>:
      <code><a href="flumotion.component.component.BaseComponent-class.html#medium">medium</a></code>,
      <code><a href="flumotion.component.component.BaseComponent-class.html#name">name</a></code>,
      <code><a href="flumotion.component.component.BaseComponent-class.html#uiState">uiState</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="get_pipeline_string"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_pipeline_string</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">properties</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="flumotion.component.converters.pipeline.pipeline-pysrc.html#Converter.get_pipeline_string">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Method that must be implemented by subclasses to produce the gstparse 
  string for the component's pipeline. Subclasses should not chain up; this
  method raises a NotImplemented error.</p>
  <p>Returns: a new pipeline string representation.</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="flumotion.component.feedcomponent.ParseLaunchComponent-class.html#get_pipeline_string">feedcomponent.ParseLaunchComponent.get_pipeline_string</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sun Sep 13 13:14:07 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>