An Alternaria structure element that was printed to a file. More...

#include <structure.h>

Inheritance diagram for Printed_structure:

Public Member Functions
virtual	~Printed_structure ()
	Deletes this Printed_structure.
uint32_t	get_id () const
size_t	get_level () const
uint32_t	get_parent () const
virtual Structure *	convert (Structure *parent) const =0 throw (jwscxx::base::Arg_error)
	Converts this Printed_structure to a Structure.
virtual Structure *	recursively_convert (Structure parent, std::list< class Printed_apical_structure >::const_iterator apical_begin, std::list< class Printed_apical_structure * >::const_iterator apical_end, std::list< class Printed_lateral_structure * >::const_iterator lateral_begin, std::list< class Printed_lateral_structure * >::const_iterator lateral_end) const =0 throw (jwscxx::base::Arg_error)
	Recursively converts this Printed_structure and all its descendants to Structure.
virtual void	read (std::istream &in)=0 throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Reads values for this Printed_structure from an input stream.
Static Public Member Functions
static bool	is_on_istream (std::istream &in, const char *type_str) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Peeks at the input stream to see if a Printed_structure can be read from it.
Protected Member Functions
void	read_id (std::istream &in) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Reads the ID.
void	read_level (std::istream &in) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Reads the level.
void	read_centroid (std::istream &in) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Reads the centroid.
void	read_length (std::istream &in) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Reads the length.
void	read_width (std::istream &in) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Reads the width.
void	read_theta (std::istream &in) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Reads the theta angle.
void	read_base_theta (std::istream &in) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Reads the base_theta angle.
void	read_psi (std::istream &in) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Reads the psi angle.
void	read_base_psi (std::istream &in) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Reads the base_psi angle.
void	read_opacity (std::istream &in) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Reads the opacity.
void	read_log_prob (std::istream &in) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Reads the log probability.
void	read_parent (std::istream &in) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Reads the parent ID.
void	read_apical (std::istream &in) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Reads the apical ID.
void	read_laterals (std::istream &in) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error)
	Reads the lateral IDs.
Protected Attributes
uint32_t	parent
	Parent ID of this Printed_structure.
uint32_t	apical
	Apical growth structure ID.
std::list< uint32_t >	laterals
	Lateral intra structure IDs.
float	centroid_x
	Centroid x position.
float	centroid_y
	Centroid y position.
float	centroid_z
	Centroid z position.
double	log_prob
	See Structure::log_prob.
float	length
	See Structure::length.
float	width
	See Structure::width.
float	theta
	See Structure::theta.
float	base_theta
	See Structure::base_theta.
float	psi
	See Structure::psi.
float	base_psi
	See Structure::base_psi.
float	opacity
	See Structure::opacity.
uint32_t	id
	See Structure::id.
size_t	level
	See Structure::level.

Detailed Description

An Alternaria structure element that was printed to a file.

Contains ancestor and descendant IDs instead of pointers.

See also:: Structure

Definition at line 787 of file structure.h.

Constructor & Destructor Documentation

virtual Printed_structure::~Printed_structure ( ) [inline, virtual]

Deletes this Printed_structure.

Definition at line 792 of file structure.h.

Member Function Documentation

uint32_t Printed_structure::get_id ( ) const [inline]

Returns:: The ID of this Printed_structure.

Definition at line 796 of file structure.h.

size_t Printed_structure::get_level ( ) const [inline]

Returns:: The level of this Printed_structure.

Definition at line 800 of file structure.h.

uint32_t Printed_structure::get_parent ( ) const [inline]

Returns:: The parent ID of this Printed_structure.

Definition at line 804 of file structure.h.

virtual Structure* Printed_structure::convert ( Structure * parent ) const throw (jwscxx::base::Arg_error) [pure virtual]

Converts this Printed_structure to a Structure.

Implemented in Printed_apical_structure, Printed_lateral_structure, Printed_apical_hypha, Printed_lateral_hypha, and Printed_spore.

virtual Structure* Printed_structure::recursively_convert	(	Structure *	parent,
		std::list< class Printed_apical_structure * >::const_iterator	apical_begin,
		std::list< class Printed_apical_structure * >::const_iterator	apical_end,
		std::list< class Printed_lateral_structure * >::const_iterator	lateral_begin,
		std::list< class Printed_lateral_structure * >::const_iterator	lateral_end
	)		const throw (jwscxx::base::Arg_error) `[pure virtual]`

Recursively converts this Printed_structure and all its descendants to Structure.

Implemented in Printed_apical_structure, and Printed_lateral_structure.

virtual void Printed_structure::read ( std::istream & in ) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error) [pure virtual]

Reads values for this Printed_structure from an input stream.

Implemented in Printed_apical_hypha, Printed_lateral_hypha, and Printed_spore.

bool Printed_structure::is_on_istream	(	std::istream &	in,
		const char *	type_str
	)		throw (jwscxx::base::IO_error, jwscxx::base::Arg_error) `[static]`

Peeks at the input stream to see if a Printed_structure can be read from it.

Parameters:

in	Input stream to check for the Printed_structure.
type_str	Type of Printed structure to check for.

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 2032 of file structure.cpp.

void Printed_structure::read_id ( std::istream & in ) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error) [protected]

Reads the ID.

Parameters:

in	Input stream to read 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.

Definition at line 1648 of file structure.cpp.

void Printed_structure::read_level ( std::istream & in ) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error) [protected]

Reads the level.

Parameters:

in	Input stream to read 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.

Definition at line 1672 of file structure.cpp.

void Printed_structure::read_centroid ( std::istream & in ) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error) [protected]

Reads the centroid.

Parameters:

in	Input stream to read 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.

Definition at line 1696 of file structure.cpp.

void Printed_structure::read_length ( std::istream & in ) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error) [protected]

Reads the length.

Parameters:

in	Input stream to read 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.

Definition at line 1749 of file structure.cpp.

void Printed_structure::read_width ( std::istream & in ) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error) [protected]

Reads the width.

Parameters:

in	Input stream to read 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.

Definition at line 1774 of file structure.cpp.

void Printed_structure::read_theta ( std::istream & in ) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error) [protected]

Reads the theta angle.

Parameters:

in	Input stream to read 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.

Definition at line 1799 of file structure.cpp.

void Printed_structure::read_base_theta ( std::istream & in ) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error) [protected]

Reads the base_theta angle.

Parameters:

in	Input stream to read 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.

Definition at line 1824 of file structure.cpp.

void Printed_structure::read_psi ( std::istream & in ) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error) [protected]

Reads the psi angle.

Parameters:

in	Input stream to read 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.

Definition at line 1849 of file structure.cpp.

void Printed_structure::read_base_psi ( std::istream & in ) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error) [protected]

Reads the base_psi angle.

Parameters:

in	Input stream to read 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.

Definition at line 1874 of file structure.cpp.

void Printed_structure::read_opacity ( std::istream & in ) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error) [protected]

Reads the opacity.

Parameters:

in	Input stream to read 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.

Definition at line 1899 of file structure.cpp.

void Printed_structure::read_log_prob ( std::istream & in ) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error) [protected]

Reads the log probability.

Parameters:

in	Input stream to read 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.

Definition at line 1924 of file structure.cpp.

void Printed_structure::read_parent ( std::istream & in ) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error) [protected]

Reads the parent ID.

Parameters:

in	Input stream to read from.

Exceptions:

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

Definition at line 1948 of file structure.cpp.

void Printed_structure::read_apical ( std::istream & in ) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error) [protected]

Reads the apical ID.

Parameters:

in	Input stream to read from.

Exceptions:

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

Definition at line 1972 of file structure.cpp.

void Printed_structure::read_laterals ( std::istream & in ) throw (jwscxx::base::IO_error, jwscxx::base::Arg_error) [protected]

Reads the lateral IDs.

Parameters:

in	Input stream to read from.

Exceptions:

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

Definition at line 1996 of file structure.cpp.

Member Data Documentation

uint32_t Printed_structure::parent [protected]

Parent ID of this Printed_structure.

If there is no parent, set to 0.

Definition at line 912 of file structure.h.

uint32_t Printed_structure::apical [protected]

Apical growth structure ID.

If there is no apical, set to 0.

Definition at line 919 of file structure.h.

std::list<uint32_t> Printed_structure::laterals [protected]

Lateral intra structure IDs.

Definition at line 922 of file structure.h.

float Printed_structure::centroid_x [protected]

Centroid x position.

Definition at line 925 of file structure.h.

float Printed_structure::centroid_y [protected]

Centroid y position.

Definition at line 928 of file structure.h.

float Printed_structure::centroid_z [protected]

Centroid z position.

Definition at line 931 of file structure.h.

double Printed_structure::log_prob [protected]

See Structure::log_prob.

Definition at line 934 of file structure.h.

float Printed_structure::length [protected]

See Structure::length.

Definition at line 937 of file structure.h.

float Printed_structure::width [protected]

See Structure::width.

Definition at line 940 of file structure.h.

float Printed_structure::theta [protected]

See Structure::theta.

Definition at line 943 of file structure.h.

float Printed_structure::base_theta [protected]

See Structure::base_theta.

Definition at line 946 of file structure.h.

float Printed_structure::psi [protected]

See Structure::psi.

Definition at line 949 of file structure.h.

float Printed_structure::base_psi [protected]

See Structure::base_psi.

Definition at line 952 of file structure.h.

float Printed_structure::opacity [protected]

See Structure::opacity.

Definition at line 955 of file structure.h.

uint32_t Printed_structure::id [protected]

See Structure::id.

Definition at line 958 of file structure.h.

size_t Printed_structure::level [protected]

See Structure::level.

Definition at line 961 of file structure.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation