Package PyFoam :: Package ThirdParty :: Package Gnuplot :: Module PlotItems :: Class _FIFOFileItem
[hide private]
[frames] | no frames]

Class _FIFOFileItem

source code

PlotItem --+    
           |    
   _FileItem --+
               |
              _FIFOFileItem

A _FileItem based on a FIFO (named pipe).

This class depends on the availablity of os.mkfifo(), which only exists under Unix.

Instance Methods [hide private]
 
__init__(self, content, **keyw)
Represent a PlotItem that gnuplot treates as a file.
source code
 
get_base_command_string(self)
Create the gnuplot command for plotting this item.
source code

Inherited from _FileItem: set_option_binary, set_option_colonsep

Inherited from PlotItem: clear_option, command, get_command_option_string, get_option, pipein, set_option, set_string_option

Class Variables [hide private]

Inherited from _FileItem (private): _option_list

Inherited from PlotItem (private): _option_sequence

Method Details [hide private]

__init__(self, content, **keyw)
(Constructor)

source code 
Represent a PlotItem that gnuplot treates as a file.

This class holds the information that is needed to construct
the plot command line, including options that are specific to
file-like gnuplot input.

<filename> is a string representing the filename to be passed
to gnuplot within quotes.  It may be the name of an existing
file, '-' for inline data, or the name of a named pipe.

Keyword arguments:

    'using=<int>' -- plot that column against line number

    'using=<tuple>' -- plot using a:b:c:d etc.  Elements in
        the tuple that are None are output as the empty
        string.

    'using=<string>' -- plot `using <string>' (allows gnuplot's
        arbitrary column arithmetic)

    'every=<value>' -- plot 'every <value>'.  <value> is
        formatted as for 'using' option.

    'index=<value>' -- plot 'index <value>'.  <value> is
        formatted as for 'using' option.

    'binary=<boolean>' -- data in the file is in binary format
        (this option is only allowed for grid data for splot).

    'smooth=<string>' -- smooth the data.  Option should be
        'unique', 'csplines', 'acsplines', 'bezier', or
        'sbezier'.

The keyword arguments recognized by 'PlotItem' can also be
used here.

Note that the 'using' option is interpreted by gnuplot, so
columns must be numbered starting with 1.

By default, gnuplot uses the name of the file plus any 'using'
option as the dataset title.  If you want another title, set
it explicitly using the 'title' option.

Overrides: PlotItem.__init__
(inherited documentation)

get_base_command_string(self)

source code 

Create the gnuplot command for plotting this item.

The basecommand is different each time because each FIFOWriter creates a new FIFO.

Overrides: PlotItem.get_base_command_string