#include <AbstractVesselNetworkComponent.hpp>

Inheritance diagram for AbstractVesselNetworkComponent< DIM >:

Collaboration diagram for AbstractVesselNetworkComponent< DIM >:

Public Member Functions
	AbstractVesselNetworkComponent ()

virtual	~AbstractVesselNetworkComponent ()

virtual unsigned	GetId () const

virtual double	GetOutputDataValue (const std::string &rKey)

virtual std::map< std::string, double >	GetOutputData ()=0

virtual std::vector< std::string >	GetOutputDataKeys ()

virtual units::quantity< unit::length >	GetRadius () const

virtual void	SetId (unsigned id)

virtual void	SetOutputData (const std::string &rKey, double value)

virtual void	SetRadius (units::quantity< unit::length > radius)

Protected Attributes
std::map< std::string, double >	mOutputData

unsigned	mId

units::quantity< unit::length >	mRadius

Private Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Friends
class	boost::serialization::access

Detailed Description

template<unsigned DIM>
class AbstractVesselNetworkComponent< DIM >

This class contains functionality common to all components of a vessel network.

Definition at line 54 of file AbstractVesselNetworkComponent.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

AbstractVesselNetworkComponent< DIM >::AbstractVesselNetworkComponent ( )

Constructor.

Definition at line 40 of file AbstractVesselNetworkComponent.cpp.

template<unsigned DIM>

AbstractVesselNetworkComponent< DIM >::~AbstractVesselNetworkComponent ( )

virtual

Destructor

Definition at line 49 of file AbstractVesselNetworkComponent.cpp.

Member Function Documentation

template<unsigned DIM>

unsigned AbstractVesselNetworkComponent< DIM >::GetId ( ) const

virtual

Return the component Id

Returns: the component id

Definition at line 54 of file AbstractVesselNetworkComponent.cpp.

References AbstractVesselNetworkComponent< DIM >::mId.

Referenced by VesselNetworkWriter< DIM >::GetOutput(), VesselSegment< DIM >::GetOutputData(), VesselNode< DIM >::GetOutputData(), and Vessel< DIM >::GetOutputData().

template<unsigned DIM>

virtual std::map<std::string, double> AbstractVesselNetworkComponent< DIM >::GetOutputData ( )

pure virtual

Return a map of output data for writers

Returns: a map of component data for use by the vtk writer

Implemented in VesselNetwork< DIM >, Vessel< DIM >, VesselNode< DIM >, and VesselSegment< DIM >.

Referenced by AbstractVesselNetworkComponent< DIM >::GetOutputDataKeys(), and AbstractVesselNetworkComponent< DIM >::GetOutputDataValue().

template<unsigned DIM>

std::vector< std::string > AbstractVesselNetworkComponent< DIM >::GetOutputDataKeys ( )

virtual

Return the keys of the output data map

Returns: a map of component data for use by the vtk writer

Definition at line 77 of file AbstractVesselNetworkComponent.cpp.

References AbstractVesselNetworkComponent< DIM >::GetOutputData(), and AbstractVesselNetworkComponent< DIM >::mOutputData.

template<unsigned DIM>

double AbstractVesselNetworkComponent< DIM >::GetOutputDataValue ( const std::string & rKey )

virtual

Return the output data for the given key. This method is relatively slow compared to GetOutputData as the data map is reconstructed each time. It is used by the Python framework.

Parameters