write vtkTree data to Newick format. More...

#include <vtkNewickTreeWriter.h>

Inheritance diagram for vtkNewickTreeWriter:

Collaboration diagram for vtkNewickTreeWriter:

Public Types
typedef vtkDataWriter	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkNewickTreeWriter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)

vtkTree *	GetInput ()
vtkTree *	GetInput (int port)

virtual vtkStdString	GetEdgeWeightArrayName ()
virtual void	SetEdgeWeightArrayName (vtkStdString)

virtual vtkStdString	GetNodeNameArrayName ()
virtual void	SetNodeNameArrayName (vtkStdString)
Static Public Member Functions
static vtkNewickTreeWriter *	New ()
static int	IsTypeOf (const char *type)
static vtkNewickTreeWriter *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkNewickTreeWriter ()
	~vtkNewickTreeWriter ()
void	WriteData ()
void	WriteVertex (ostream fp, vtkTree const input, vtkIdType vertex)
virtual int	FillInputPortInformation (int port, vtkInformation *info)
Protected Attributes
vtkStdString	EdgeWeightArrayName
vtkStdString	NodeNameArrayName
vtkAbstractArray *	EdgeWeightArray
vtkAbstractArray *	NodeNameArray

Detailed Description

write vtkTree data to Newick format.

vtkNewickTreeWriter is writes a vtkTree to a Newick formatted file or string.

Tests:: vtkNewickTreeWriter (Tests)

Definition at line 34 of file vtkNewickTreeWriter.h.

Member Typedef Documentation

typedef vtkDataWriter vtkNewickTreeWriter::Superclass

Reimplemented from vtkDataWriter.

Definition at line 38 of file vtkNewickTreeWriter.h.

Constructor & Destructor Documentation

vtkNewickTreeWriter::vtkNewickTreeWriter ( ) [protected]

vtkNewickTreeWriter::~vtkNewickTreeWriter ( ) [inline, protected]

Definition at line 67 of file vtkNewickTreeWriter.h.

Member Function Documentation

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

Created object with default header, ASCII format, and default names for scalars, vectors, tensors, normals, and texture coordinates.

Reimplemented from vtkDataWriter.

static int vtkNewickTreeWriter::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataWriter.

virtual int vtkNewickTreeWriter::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataWriter.

static vtkNewickTreeWriter* vtkNewickTreeWriter::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkDataWriter.

virtual vtkObjectBase* vtkNewickTreeWriter::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkDataWriter.

vtkNewickTreeWriter* vtkNewickTreeWriter::NewInstance ( ) const

Reimplemented from vtkDataWriter.

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

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDataWriter.

vtkTree* vtkNewickTreeWriter::GetInput ( )

Get the input to this writer.

Reimplemented from vtkWriter.

vtkTree* vtkNewickTreeWriter::GetInput ( int port )

Get the input to this writer.

Reimplemented from vtkWriter.

virtual vtkStdString vtkNewickTreeWriter::GetEdgeWeightArrayName ( ) [virtual]

Get/Set the name of the input's tree edge weight array. This array must be part of the input tree's EdgeData. The default name is "weight". If this array cannot be found, then no edge weights will be included in the output of this writer.

virtual void vtkNewickTreeWriter::SetEdgeWeightArrayName ( vtkStdString ) [virtual]

Get/Set the name of the input's tree edge weight array. This array must be part of the input tree's EdgeData. The default name is "weight". If this array cannot be found, then no edge weights will be included in the output of this writer.

virtual vtkStdString vtkNewickTreeWriter::GetNodeNameArrayName ( ) [virtual]

Get/Set the name of the input's tree node name array. This array must be part of the input tree's VertexData. The default name is "node name". If this array cannot be found, then no node names will be included in the output of this writer.

virtual void vtkNewickTreeWriter::SetNodeNameArrayName ( vtkStdString ) [virtual]

Get/Set the name of the input's tree node name array. This array must be part of the input tree's VertexData. The default name is "node name". If this array cannot be found, then no node names will be included in the output of this writer.

void vtkNewickTreeWriter::WriteData ( ) [protected, virtual]

Reimplemented from vtkDataWriter.

void vtkNewickTreeWriter::WriteVertex	(	ostream *	fp,
		vtkTree *const	input,
		vtkIdType	vertex
	)		`[protected]`

Write one vertex. This function calls itself recursively for any children of the input vertex.

virtual int vtkNewickTreeWriter::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)		`[protected, virtual]`

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.