neurolots  0.3.4
NeuroLOTs
nlgenerator::JointNode Class Reference
+ Collaboration diagram for nlgenerator::JointNode:

Public Member Functions

NLGENERATOR_API JointNode (const Eigen::Vector3f &position_, float radius_)
 Constructor. More...
 
NLGENERATOR_API ~JointNode (void)
 Default destructor.
 
NLGENERATOR_API Eigen::Vector3f & position (void)
 Method that returns the joint node position. More...
 
NLGENERATOR_API float & radius (void)
 Method that returns the join node radius. More...
 
NLGENERATOR_API bool & connectedSoma (void)
 Method that returns the connected soma conditional. More...
 
NLGENERATOR_API nlgeometry::SectionQuadPtr sectionQuad (nsol::NodePtr neighbour_)
 Method that returns the corresponding section quad for each neighbour nsol node. More...
 
NLGENERATOR_API nlgeometry::SectionQuadPtr sectionQuad (void)
 Method that returns the first section quad. More...
 
NLGENERATOR_API nsol::NodePtr neighbour (void)
 Method that return the first neighbour node. More...
 
NLGENERATOR_API unsigned int numberNeighbors (void)
 Method that returns the number of neighbors of the joint node. More...
 
NLGENERATOR_API void addNeighbour (nsol::NodePtr neighbour_)
 Method that adds a new nsol neighbour node to the joint. More...
 
NLGENERATOR_API void computeGeometry (void)
 Method that computes the joint node geometry.
 

Protected Attributes

Eigen::Vector3f _position
 Joint node position.
 
float _radius
 Joint node radius.
 
bool _connectedSoma
 Conditional that indicates if the joint node is connected to the soma.
 
std::unordered_map< nsol::NodePtr, nlgeometry::SectionQuadPtr_neighbors
 Joint node neighbour nodes.
 

Detailed Description

Definition at line 38 of file JointNode.h.

Constructor & Destructor Documentation

NLGENERATOR_API nlgenerator::JointNode::JointNode ( const Eigen::Vector3f &  position_,
float  radius_ 
)

Constructor.

Parameters
position_position of the joint node
radius_radius of the joint node

Member Function Documentation

NLGENERATOR_API void nlgenerator::JointNode::addNeighbour ( nsol::NodePtr  neighbour_)

Method that adds a new nsol neighbour node to the joint.

Parameters
neighbour_nsol neighbour node
NLGENERATOR_API bool& nlgenerator::JointNode::connectedSoma ( void  )

Method that returns the connected soma conditional.

Returns
the connected soma conditional
NLGENERATOR_API nsol::NodePtr nlgenerator::JointNode::neighbour ( void  )

Method that return the first neighbour node.

Returns
the first neigbour node
NLGENERATOR_API unsigned int nlgenerator::JointNode::numberNeighbors ( void  )

Method that returns the number of neighbors of the joint node.

Returns
the number of neighbors of the joint node
NLGENERATOR_API Eigen::Vector3f& nlgenerator::JointNode::position ( void  )

Method that returns the joint node position.

Returns
the joint node position
NLGENERATOR_API float& nlgenerator::JointNode::radius ( void  )

Method that returns the join node radius.

Returns
the joint node radius
NLGENERATOR_API nlgeometry::SectionQuadPtr nlgenerator::JointNode::sectionQuad ( nsol::NodePtr  neighbour_)

Method that returns the corresponding section quad for each neighbour nsol node.

Parameters
neighbour_nsol neighbour node
Returns
the corresponding section quad
NLGENERATOR_API nlgeometry::SectionQuadPtr nlgenerator::JointNode::sectionQuad ( void  )

Method that returns the first section quad.

Returns
the first section quad

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