Printed_spore Class Reference

A Alternaria spore element that was printed to a file. More...

#include <spore.h>

Inheritance diagram for Printed_spore:

Collaboration diagram for Printed_spore:

List of all members.

Public Member Functions
	Printed_spore (const Spore_density *density)
	Constructs a Printed_spore.
	Printed_spore (std::istream &in, const Spore_density *density) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Constructs a Printed_spore 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_spore from an input stream.
Spore *	convert (Structure *parent) const throw (jwscxx::base::Arg_error)
	Converts this Printed_spore to a Spore.
Protected Attributes
const Spore_density *	density
	Parameters for density functions over the Spore.

---

Detailed Description

A Alternaria spore element that was printed to a file.

Contains ancestor and descendant IDs instead of pointers.

See also:

Spore

Definition at line 356 of file spore.h.

---

Constructor & Destructor Documentation

Printed_spore::Printed_spore

(

const Spore_density *

density

)

Constructs a Printed_spore.

Initializes all members to 0.

Parameters:

density

Spore_density to use for the Spore.

Definition at line 1293 of file spore.cpp.

Printed_spore::Printed_spore	(	std::istream &	in,
		const Spore_density *	density
	)		throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)

Constructs a Printed_spore by reading values from an input stream.

Parameters:

in	Input stream to read this Printed_spore from.
density	Spore_density to use for the Spore.

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 1320 of file spore.cpp.

---

Member Function Documentation

void Printed_spore::read

(

std::istream &

in

)

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

Reads values for this Printed_spore from an input stream.

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

    Structure: Spore::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

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 1358 of file spore.cpp.

Spore * Printed_spore::convert

(

Structure *

parent

)

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

Converts this Printed_spore to a Spore.

Parameters:

parent

Parent Structure. Use 0 for the root.

Note:

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

Returns:

A Spore created from this Printed_spore with its Spore::parent set to parent.

Exceptions:

jwscxx::base::Arg_error

Spore values are not in the density parameter ranges.

Implements Printed_apical_structure.

Definition at line 1403 of file spore.cpp.

---

Member Data Documentation

const Spore_density* Printed_spore::density [protected]

Parameters for density functions over the Spore.

Definition at line 384 of file spore.h.

---

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

• spore.h
• spore.cpp