vtkKWStateMachineDOTWriter Class Reference

a state machine DOT writer. More...

#include <vtkKWStateMachineDOTWriter.h>

Inheritance diagram for vtkKWStateMachineDOTWriter:
Inheritance graph
[legend]
Collaboration diagram for vtkKWStateMachineDOTWriter:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkKWStateMachineWriter Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

Static Public Member Functions

static vtkKWStateMachineDOTWriter * New ()
static int IsTypeOf (const char *type)
static vtkKWStateMachineDOTWriter * SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkKWStateMachineDOTWriter ()
 ~vtkKWStateMachineDOTWriter ()

Protected Attributes

char * GraphLabel
char * GraphFontName
int GraphFontSize
double GraphFontColor [3]
int GraphDirection
char * StateFontName
int StateFontSize
double StateFontColor [3]
char * InputFontName
int InputFontSize
double InputFontColor [3]
char * ClusterFontName
int ClusterFontSize
double ClusterFontColor [3]
int PutStatesAtSameRank
int CommandVisibility



enum  { GraphDirectionTopToBottom, GraphDirectionLeftToRight }
virtual int WriteToStream (ostream &os)
virtual int WriteToFile (const char *filename)
virtual char * GetStateFontName ()
virtual void SetStateFontName (const char *)
virtual void SetStateFontSize (int)
virtual int GetStateFontSize ()
virtual void SetStateFontColor (double, double, double)
virtual void SetStateFontColor (double[3])
virtual double * GetStateFontColor ()
virtual void GetStateFontColor (double &, double &, double &)
virtual void GetStateFontColor (double[3])
virtual char * GetInputFontName ()
virtual void SetInputFontName (const char *)
virtual void SetInputFontSize (int)
virtual int GetInputFontSize ()
virtual void SetInputFontColor (double, double, double)
virtual void SetInputFontColor (double[3])
virtual double * GetInputFontColor ()
virtual void GetInputFontColor (double &, double &, double &)
virtual void GetInputFontColor (double[3])
virtual char * GetGraphLabel ()
virtual void SetGraphLabel (const char *)
virtual char * GetGraphFontName ()
virtual void SetGraphFontName (const char *)
virtual void SetGraphFontSize (int)
virtual int GetGraphFontSize ()
virtual void SetGraphFontColor (double, double, double)
virtual void SetGraphFontColor (double[3])
virtual double * GetGraphFontColor ()
virtual void GetGraphFontColor (double &, double &, double &)
virtual void GetGraphFontColor (double[3])
virtual void SetGraphDirection (int)
virtual int GetGraphDirection ()
virtual void SetGraphDirectionToTopToBottom ()
virtual void SetGraphDirectionToLeftToRight ()
virtual void PutStatesAtSameRankOn ()
virtual void PutStatesAtSameRankOff ()
virtual int GetPutStatesAtSameRank ()
virtual void SetPutStatesAtSameRank (int)
virtual void CommandVisibilityOn ()
virtual void CommandVisibilityOff ()
virtual int GetCommandVisibility ()
virtual void SetCommandVisibility (int)
virtual char * GetClusterFontName ()
virtual void SetClusterFontName (const char *)
virtual void SetClusterFontSize (int)
virtual int GetClusterFontSize ()
virtual void SetClusterFontColor (double, double, double)
virtual void SetClusterFontColor (double[3])
virtual double * GetClusterFontColor ()
virtual void GetClusterFontColor (double &, double &, double &)
virtual void GetClusterFontColor (double[3])

Detailed Description

a state machine DOT writer.

This class is a state machine writer for the DOT format, based on the reference document: http://www.graphviz.org/Documentation/dotguide.pdf The resulting file can be rendered using dot: dot -T png -o foo.png foo.txt It can also be used directly from a Wiki page if your MediaWiki supports the GraphViz extension (http://meta.wikimedia.org/wiki/GraphViz). A state machine is defined by a set of states, a set of inputs and a transition matrix that defines for each pair of (state,input) what is the next state to assume.

Thanks:
This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149. Information on the National Centers for Biomedical Computing can be obtained from http://nihroadmap.nih.gov/bioinformatics.
See also:
vtkKWStateMachineWriter vtkKWStateMachine

Definition at line 41 of file vtkKWStateMachineDOTWriter.h.

Member Typedef Documentation

typedef vtkKWStateMachineWriter vtkKWStateMachineDOTWriter::Superclass

Reimplemented from vtkKWStateMachineWriter.

Definition at line 46 of file vtkKWStateMachineDOTWriter.h.

Member Enumeration Documentation

anonymous enum

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

Enumerator:
GraphDirectionTopToBottom 
GraphDirectionLeftToRight 

Definition at line 124 of file vtkKWStateMachineDOTWriter.h.

Constructor & Destructor Documentation

vtkKWStateMachineDOTWriter::vtkKWStateMachineDOTWriter (  )  [protected]
vtkKWStateMachineDOTWriter::~vtkKWStateMachineDOTWriter (  )  [protected]

Member Function Documentation

static vtkKWStateMachineDOTWriter* vtkKWStateMachineDOTWriter::New (  )  [static]

Reimplemented from vtkObject.

virtual const char* vtkKWStateMachineDOTWriter::GetClassName (  )  [virtual]

Reimplemented from vtkKWStateMachineWriter.

static int vtkKWStateMachineDOTWriter::IsTypeOf ( const char *  type  )  [static]

Reimplemented from vtkKWStateMachineWriter.

virtual int vtkKWStateMachineDOTWriter::IsA ( const char *  type  )  [virtual]

Reimplemented from vtkKWStateMachineWriter.

static vtkKWStateMachineDOTWriter* vtkKWStateMachineDOTWriter::SafeDownCast ( vtkObject *  o  )  [static]

Reimplemented from vtkKWStateMachineWriter.

void vtkKWStateMachineDOTWriter::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Reimplemented from vtkKWStateMachineWriter.

virtual int vtkKWStateMachineDOTWriter::WriteToStream ( ostream &  os  )  [virtual]

Write state machine representation to stream or file. Returns 1 on success and 0 on failure.

virtual int vtkKWStateMachineDOTWriter::WriteToFile ( const char *  filename  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual char* vtkKWStateMachineDOTWriter::GetStateFontName (  )  [virtual]

Set/Get the font name used for state labels. Defaults to Helvetica. It is best to stick to Times, Helvetica, Courier or Symbol

virtual void vtkKWStateMachineDOTWriter::SetStateFontName ( const char *   )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::SetStateFontSize ( int   )  [virtual]

Set/Get the font size used for state labels. Defaults to 9.

virtual int vtkKWStateMachineDOTWriter::GetStateFontSize (  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::SetStateFontColor ( double  ,
double  ,
double   
) [virtual]

Set/Get the font color used for state labels. Defaults to black.

virtual void vtkKWStateMachineDOTWriter::SetStateFontColor ( double  [3]  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual double* vtkKWStateMachineDOTWriter::GetStateFontColor (  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::GetStateFontColor ( double &  ,
double &  ,
double &   
) [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::GetStateFontColor ( double  [3]  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual char* vtkKWStateMachineDOTWriter::GetInputFontName (  )  [virtual]

Set/Get the font name used for input labels. Defaults to Helvetica. It is best to stick to Times, Helvetica, Courier or Symbol

virtual void vtkKWStateMachineDOTWriter::SetInputFontName ( const char *   )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::SetInputFontSize ( int   )  [virtual]

Set/Get the font size used for input labels. Defaults to 8.

virtual int vtkKWStateMachineDOTWriter::GetInputFontSize (  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::SetInputFontColor ( double  ,
double  ,
double   
) [virtual]

Set/Get the font color used for input labels. Defaults to blue.

virtual void vtkKWStateMachineDOTWriter::SetInputFontColor ( double  [3]  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual double* vtkKWStateMachineDOTWriter::GetInputFontColor (  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::GetInputFontColor ( double &  ,
double &  ,
double &   
) [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::GetInputFontColor ( double  [3]  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual char* vtkKWStateMachineDOTWriter::GetGraphLabel (  )  [virtual]

Set/Get graph label (at the bottom of the graph).

virtual void vtkKWStateMachineDOTWriter::SetGraphLabel ( const char *   )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual char* vtkKWStateMachineDOTWriter::GetGraphFontName (  )  [virtual]

Set/Get the font name used for graph labels. Defaults to Helvetica. Graph labels do not include state or input labels. It is best to stick to Times, Helvetica, Courier or Symbol

virtual void vtkKWStateMachineDOTWriter::SetGraphFontName ( const char *   )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::SetGraphFontSize ( int   )  [virtual]

Set/Get the font size used for graph labels. Defaults to 12. Graph labels do not include state or input labels.

virtual int vtkKWStateMachineDOTWriter::GetGraphFontSize (  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::SetGraphFontColor ( double  ,
double  ,
double   
) [virtual]

Set/Get the font color used for graph labels. Defaults to black. Graph labels do not include state or input labels.

virtual void vtkKWStateMachineDOTWriter::SetGraphFontColor ( double  [3]  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual double* vtkKWStateMachineDOTWriter::GetGraphFontColor (  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::GetGraphFontColor ( double &  ,
double &  ,
double &   
) [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::GetGraphFontColor ( double  [3]  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::SetGraphDirection ( int   )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual int vtkKWStateMachineDOTWriter::GetGraphDirection (  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::SetGraphDirectionToTopToBottom (  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::SetGraphDirectionToLeftToRight (  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::PutStatesAtSameRankOn (  )  [virtual]

Set/Get if the all states should be put at the same rank. If GraphDirection is TopToBottom, all nodes will share the same rank horizontally, except the clusters which will still be set up in a vertical fashion. If the GraphDirection is LeftToRight, all nodes will share the same rank vertically, except the clusters which will still be set up in a horizontal fashion. Experiment :)

virtual void vtkKWStateMachineDOTWriter::PutStatesAtSameRankOff (  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual int vtkKWStateMachineDOTWriter::GetPutStatesAtSameRank (  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::SetPutStatesAtSameRank ( int   )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::CommandVisibilityOn (  )  [virtual]

Set/Get if the callbacks/commands associated to the state and transitions should be shown (default) or hidden.

virtual void vtkKWStateMachineDOTWriter::CommandVisibilityOff (  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual int vtkKWStateMachineDOTWriter::GetCommandVisibility (  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::SetCommandVisibility ( int   )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual char* vtkKWStateMachineDOTWriter::GetClusterFontName (  )  [virtual]

Set/Get the font name used for cluster labels. Defaults to Helvetica. It is best to stick to Times, Helvetica, Courier or Symbol

virtual void vtkKWStateMachineDOTWriter::SetClusterFontName ( const char *   )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::SetClusterFontSize ( int   )  [virtual]

Set/Get the font size used for cluster labels. Defaults to 10.

virtual int vtkKWStateMachineDOTWriter::GetClusterFontSize (  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::SetClusterFontColor ( double  ,
double  ,
double   
) [virtual]

Set/Get the font color used for cluster labels. Defaults to black.

virtual void vtkKWStateMachineDOTWriter::SetClusterFontColor ( double  [3]  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual double* vtkKWStateMachineDOTWriter::GetClusterFontColor (  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::GetClusterFontColor ( double &  ,
double &  ,
double &   
) [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

virtual void vtkKWStateMachineDOTWriter::GetClusterFontColor ( double  [3]  )  [virtual]

Set/Get the preferred graph direction. Defaults to top to bottom. BTX

Member Data Documentation

char* vtkKWStateMachineDOTWriter::GraphLabel [protected]

Definition at line 181 of file vtkKWStateMachineDOTWriter.h.

char* vtkKWStateMachineDOTWriter::GraphFontName [protected]

Definition at line 182 of file vtkKWStateMachineDOTWriter.h.

int vtkKWStateMachineDOTWriter::GraphFontSize [protected]

Definition at line 183 of file vtkKWStateMachineDOTWriter.h.

double vtkKWStateMachineDOTWriter::GraphFontColor[3] [protected]

Definition at line 184 of file vtkKWStateMachineDOTWriter.h.

int vtkKWStateMachineDOTWriter::GraphDirection [protected]

Definition at line 185 of file vtkKWStateMachineDOTWriter.h.

char* vtkKWStateMachineDOTWriter::StateFontName [protected]

Definition at line 187 of file vtkKWStateMachineDOTWriter.h.

int vtkKWStateMachineDOTWriter::StateFontSize [protected]

Definition at line 188 of file vtkKWStateMachineDOTWriter.h.

double vtkKWStateMachineDOTWriter::StateFontColor[3] [protected]

Definition at line 189 of file vtkKWStateMachineDOTWriter.h.

char* vtkKWStateMachineDOTWriter::InputFontName [protected]

Definition at line 191 of file vtkKWStateMachineDOTWriter.h.

int vtkKWStateMachineDOTWriter::InputFontSize [protected]

Definition at line 192 of file vtkKWStateMachineDOTWriter.h.

double vtkKWStateMachineDOTWriter::InputFontColor[3] [protected]

Definition at line 193 of file vtkKWStateMachineDOTWriter.h.

char* vtkKWStateMachineDOTWriter::ClusterFontName [protected]

Definition at line 195 of file vtkKWStateMachineDOTWriter.h.

int vtkKWStateMachineDOTWriter::ClusterFontSize [protected]

Definition at line 196 of file vtkKWStateMachineDOTWriter.h.

double vtkKWStateMachineDOTWriter::ClusterFontColor[3] [protected]

Definition at line 197 of file vtkKWStateMachineDOTWriter.h.

int vtkKWStateMachineDOTWriter::PutStatesAtSameRank [protected]

Definition at line 199 of file vtkKWStateMachineDOTWriter.h.

int vtkKWStateMachineDOTWriter::CommandVisibility [protected]

Definition at line 200 of file vtkKWStateMachineDOTWriter.h.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Tue Apr 27 02:37:53 2010 for KWWidgets by  doxygen 1.6.1