Printed_lateral_hypha Class Reference

A Alternaria lateral hypha element that was printed to a file. More...

#include <hypha.h>

Inheritance diagram for Printed_lateral_hypha:

Collaboration diagram for Printed_lateral_hypha:

List of all members.

Public Member Functions
	Printed_lateral_hypha (const Lateral_hypha_density *level_1_density, const Lateral_hypha_density *level_n_density)
	Constructs a Printed_lateral_hypha.
	Printed_lateral_hypha (std::istream &in, const Lateral_hypha_density *level_1_density, const Lateral_hypha_density *level_n_density) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Constructs a Printed_lateral_hypha by reading values from an input stream.
void	read (std::istream &in) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Reads values for this Printed_lateral_hypha from an input stream.
Lateral_hypha *	convert (Structure *parent) const throw (jwscxx::base::Arg_error)
	Converts this Printed_lateral_hypha to an Lateral_hypha.
Protected Attributes
const Lateral_hypha_density *	level_1_density
	Parameters for density functions over Lateral_hypha at level 1.
const Lateral_hypha_density *	level_n_density
	Parameters for density functions over Lateral_hypha at level > 1.

---

Detailed Description

A Alternaria lateral hypha element that was printed to a file.

Contains ancestor and descendant IDs instead of pointers.

See also:

Lateral_hypha

Definition at line 590 of file hypha.h.

---

Constructor & Destructor Documentation

Printed_lateral_hypha::Printed_lateral_hypha	(	const Lateral_hypha_density *	level_1_density,
		const Lateral_hypha_density *	level_n_density
	)

Constructs a Printed_lateral_hypha.

Initializes all members to 0.

Parameters:

level_1_density	Density to use for Lateral_hypha at level 1.
level_n_density	Density to use for Lateral_hypha at level > 1.

Definition at line 1872 of file hypha.cpp.

Printed_lateral_hypha::Printed_lateral_hypha	(	std::istream &	in,
		const Lateral_hypha_density *	level_1_density,
		const Lateral_hypha_density *	level_n_density
	)		throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)

Constructs a Printed_lateral_hypha by reading values from an input stream.

Parameters:

in	Input stream to read this Printed_lateral_hypha from.
density	Lateral_hypha_density to use for the Lateral_hypha.

Exceptions:

jwscxx::base::Arg_error	A member is not properly formatted or missing a value.
jwscxx::base::IO_error	Could not read a line from the input stream.

Definition at line 1905 of file hypha.cpp.

---

Member Function Documentation

void Printed_lateral_hypha::read

(

std::istream &

in

)

throw (jwscxx::base::IO_error, jwscxx::base::Arg_error) [virtual]

Reads values for this Printed_lateral_hypha from an input stream.

Expects the following format for a Printed_structure to be on the input stream:

    Structure: Lateral_hypha::type_str()
           ID: id
     Centroid: x y z
       Length: length
        Width: width
   Base Theta: base_theta
     Base Psi: base_psi
        Theta: theta
          Psi: psi
      Opacity: opacity
       Parent: parent
       Apical: apical
     Laterals: L1 ... Ln
     Log Prob: logprob
     Lat Dist: latdist

Note:

If the value of parent and/or apical is 0, then this Printed_structure has no parent and/or apical.

Parameters:

in	Input stream to read this Printed_structure from.

Exceptions:

jwscxx::base::Arg_error	A member is not properly formatted or missing a value.
jwscxx::base::IO_error	Could not read a line from the input stream.

Implements Printed_structure.

Definition at line 1949 of file hypha.cpp.

Lateral_hypha * Printed_lateral_hypha::convert

(

Structure *

parent

)

const throw (jwscxx::base::Arg_error) [virtual]

Converts this Printed_lateral_hypha to an Lateral_hypha.

Parameters:

parent

Parent Structure. Use 0 for the root.

Note:

Does not add the created Lateral_hypha to the parent in any way.

Returns:

An Lateral_hypha created from this Printed_lateral_hypha with its Lateral_hypha::parent set to parent.

Exceptions:

jwscxx::base::Arg_error

Lateral_hypha values are not in the density parameter ranges.

Implements Printed_lateral_structure.

Definition at line 1996 of file hypha.cpp.

---

Member Data Documentation

const Lateral_hypha_density* Printed_lateral_hypha::level_1_density [protected]

Parameters for density functions over Lateral_hypha at level 1.

Definition at line 634 of file hypha.h.

const Lateral_hypha_density* Printed_lateral_hypha::level_n_density [protected]

Parameters for density functions over Lateral_hypha at level > 1.

Definition at line 640 of file hypha.h.

---

The documentation for this class was generated from the following files:

• hypha.h
• hypha.cpp