Class corresponding to the Segment schema type. More...

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::Segment_base:

Collaboration diagram for neuroml2::Segment_base:

parent
Accessor and modifier functions for the parent optional element.
typedef ::neuroml2::SegmentParent	parent_type
	Element type.

typedef ::xsd::cxx::tree::optional< parent_type >	parent_optional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< parent_type, char >	parent_traits
	Element traits type.

const parent_optional &	parent () const
	Return a read-only (constant) reference to the element container. More...

parent_optional &	parent ()
	Return a read-write reference to the element container. More...

void	parent (const parent_type &x)
	Set the element value. More...

void	parent (const parent_optional &x)
	Set the element value. More...

void	parent (::std::unique_ptr< parent_type > p)
	Set the element value without copying. More...

proximal
Accessor and modifier functions for the proximal optional element.
typedef ::neuroml2::Point3DWithDiam	proximal_type
	Element type.

typedef ::xsd::cxx::tree::optional< proximal_type >	proximal_optional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< proximal_type, char >	proximal_traits
	Element traits type.

const proximal_optional &	proximal () const
	Return a read-only (constant) reference to the element container. More...

proximal_optional &	proximal ()
	Return a read-write reference to the element container. More...

void	proximal (const proximal_type &x)
	Set the element value. More...

void	proximal (const proximal_optional &x)
	Set the element value. More...

void	proximal (::std::unique_ptr< proximal_type > p)
	Set the element value without copying. More...

distal
Accessor and modifier functions for the distal required element.
typedef ::neuroml2::Point3DWithDiam	distal_type
	Element type.

typedef ::xsd::cxx::tree::traits< distal_type, char >	distal_traits
	Element traits type.

const distal_type &	distal () const
	Return a read-only (constant) reference to the element. More...

distal_type &	distal ()
	Return a read-write reference to the element. More...

void	distal (const distal_type &x)
	Set the element value. More...

void	distal (::std::unique_ptr< distal_type > p)
	Set the element value without copying. More...

name
Accessor and modifier functions for the name optional attribute.
typedef ::xml_schema::string	name_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< name_type >	name_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< name_type, char >	name_traits
	Attribute traits type.

const name_optional &	name () const
	Return a read-only (constant) reference to the attribute container. More...

name_optional &	name ()
	Return a read-write reference to the attribute container. More...

void	name (const name_type &x)
	Set the attribute value. More...

void	name (const name_optional &x)
	Set the attribute value. More...

void	name (::std::unique_ptr< name_type > p)
	Set the attribute value without copying. More...

neuroLexId
Accessor and modifier functions for the neuroLexId optional attribute.
typedef ::neuroml2::NeuroLexId	neuroLexId_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< neuroLexId_type >	neuroLexId_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< neuroLexId_type, char >	neuroLexId_traits
	Attribute traits type.

const neuroLexId_optional &	neuroLexId () const
	Return a read-only (constant) reference to the attribute container. More...

neuroLexId_optional &	neuroLexId ()
	Return a read-write reference to the attribute container. More...

void	neuroLexId (const neuroLexId_type &x)
	Set the attribute value. More...

void	neuroLexId (const neuroLexId_optional &x)
	Set the attribute value. More...

void	neuroLexId (::std::unique_ptr< neuroLexId_type > p)
	Set the attribute value without copying. More...

Constructors
	Segment_base (const id_type &, const distal_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

	Segment_base (const id_type &, ::std::unique_ptr< distal_type >)
	Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version). More...

	Segment_base (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...

	Segment_base (const Segment_base &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...

virtual Segment_base *	_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
	Copy the instance polymorphically. More...

Segment_base &	operator= (const Segment_base &x)
	Copy assignment operator. More...

virtual	~Segment_base ()
	Destructor.

Additional Inherited Members
Public Types inherited from neuroml2::BaseNonNegativeIntegerId
typedef ::neuroml2::NonNegativeInteger	id_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< id_type, char >	id_traits
	Attribute traits type.

Public Member Functions inherited from neuroml2::BaseNonNegativeIntegerId
const id_type &	id () const
	Return a read-only (constant) reference to the attribute. More...

id_type &	id ()
	Return a read-write reference to the attribute. More...

void	id (const id_type &x)
	Set the attribute value. More...

void	id (::std::unique_ptr< id_type > p)
	Set the attribute value without copying. More...

	BaseNonNegativeIntegerId (const id_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

	BaseNonNegativeIntegerId (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...

	BaseNonNegativeIntegerId (const BaseNonNegativeIntegerId &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...

BaseNonNegativeIntegerId &	operator= (const BaseNonNegativeIntegerId &x)
	Copy assignment operator. More...

virtual	~BaseNonNegativeIntegerId ()
	Destructor.

Public Member Functions inherited from neuroml2::BaseWithoutId
	BaseWithoutId ()
	Create an instance from the ultimate base and initializers for required elements and attributes.

	BaseWithoutId (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...

	BaseWithoutId (const ::xercesc::DOMAttr &a, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM attribute. More...

	BaseWithoutId (const ::std::string &s, const ::xercesc::DOMElement e, ::xml_schema::flags f=0, ::xml_schema::container c=0)
	Create an instance from a string fragment. More...

	BaseWithoutId (const BaseWithoutId &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...

virtual	~BaseWithoutId ()
	Destructor.

Detailed Description

Class corresponding to the Segment schema type.

A segment defines the smallest unit within a possibly branching structure ( morphology ), such as a dendrite or axon. Its id should be a nonnegative integer ( usually soma/root = 0 ). Its end points are given by the proximal and distal points. The proximal point can be omitted, usually because it is the same as a point on the parent segment, see proximal for details. parent specifies the parent segment. The first segment of a cell ( with no parent ) usually represents the soma. The shape is normally a cylinder ( radii of the proximal and distal equal, but positions different ) or a conical frustum ( radii and positions different ). If the x, y, x positions of the proximal and distal are equal, the segment can be interpreted as a sphere, and in this case the radii of these points must be equal. NOTE: LEMS does not yet support multicompartmental modelling, so the Dynamics here is only appropriate for single compartment modelling.

Definition at line 38518 of file NeuroML_v2.3.hxx.

Constructor & Destructor Documentation

◆ Segment_base() [1/3]

neuroml2::Segment_base::Segment_base	(	const id_type &	id,
		::std::unique_ptr< distal_type >	distal
	)

Create an instance from the ultimate base and initializers for required elements and attributes (::std::unique_ptr version).

This constructor will try to use the passed values directly instead of making copies.

Definition at line 34432 of file NeuroML_v2.3.cxx.

◆ Segment_base() [2/3]

neuroml2::Segment_base::Segment_base	(	const ::xercesc::DOMElement &	e,
		::xml_schema::flags	f = `0`,
		::xml_schema::container *	c = `0`
	)

Create an instance from a DOM element.

Parameters

e	A DOM element to extract the data from.
f	Flags to create the new instance with.
c	A pointer to the object that will contain the new instance.

Definition at line 34457 of file NeuroML_v2.3.cxx.

◆ Segment_base() [3/3]

neuroml2::Segment_base::Segment_base	(	const Segment_base &	x,
		::xml_schema::flags	f = `0`,
		::xml_schema::container *	c = `0`
	)

Copy constructor.

Parameters

x	An instance to make a copy of.
f	Flags to create the copy with.
c	A pointer to the object that will contain the copy.

For polymorphic object models use the _clone function instead.

Definition at line 34444 of file NeuroML_v2.3.cxx.

Member Function Documentation

◆ _clone()

Segment_base * neuroml2::Segment_base::_clone	(	::xml_schema::flags	f = `0`,
		::xml_schema::container *	c = `0`
	)		const

virtual

Copy the instance polymorphically.

Parameters

f	Flags to create the copy with.
c	A pointer to the object that will contain the copy.

Returns: A pointer to the dynamically allocated copy.

This function ensures that the dynamic type of the instance is used for copying and should be used for polymorphic object models instead of the copy constructor.

Reimplemented from neuroml2::BaseNonNegativeIntegerId.

Reimplemented in neuroml2::Segment.

Definition at line 34561 of file NeuroML_v2.3.cxx.

◆ distal() [1/4]

Segment_base::distal_type & neuroml2::Segment_base::distal ( )

Return a read-write reference to the element.

Returns: A reference to the element.

Definition at line 9487 of file NeuroML_v2.3.cxx.

◆ distal() [2/4]

const Segment_base::distal_type & neuroml2::Segment_base::distal ( ) const

Return a read-only (constant) reference to the element.

Returns: A constant reference to the element.

Definition at line 9481 of file NeuroML_v2.3.cxx.

◆ distal() [3/4]

void neuroml2::Segment_base::distal ( ::std::unique_ptr< distal_type > p )

Set the element value without copying.

Parameters

p	A new value to use.

This function will try to use the passed value directly instead of making a copy.

Definition at line 9499 of file NeuroML_v2.3.cxx.

◆ distal() [4/4]

void neuroml2::Segment_base::distal ( const distal_type & x )

Set the element value.

Parameters

x	A new value to set.

This function makes a copy of its argument and sets it as the new value of the element.

Definition at line 9493 of file NeuroML_v2.3.cxx.

◆ name() [1/5]

Segment_base::name_optional & neuroml2::Segment_base::name ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

Definition at line 9511 of file NeuroML_v2.3.cxx.

◆ name() [2/5]

const Segment_base::name_optional & neuroml2::Segment_base::name ( ) const

Return a read-only (constant) reference to the attribute container.

Returns: A constant reference to the optional container.

Definition at line 9505 of file NeuroML_v2.3.cxx.

◆ name() [3/5]

void neuroml2::Segment_base::name ( ::std::unique_ptr< name_type > p )

Set the attribute value without copying.

Parameters

p	A new value to use.

This function will try to use the passed value directly instead of making a copy.

Definition at line 9529 of file NeuroML_v2.3.cxx.

◆ name() [4/5]

void neuroml2::Segment_base::name ( const name_optional & x )

Set the attribute value.

Parameters

x	An optional container with the new value to set.

If the value is present in x then this function makes a copy of this value and sets it as the new value of the attribute. Otherwise the attribute container is set the 'not present' state.

Definition at line 9523 of file NeuroML_v2.3.cxx.

◆ name() [5/5]

void neuroml2::Segment_base::name ( const name_type & x )

Set the attribute value.

Parameters

x	A new value to set.

This function makes a copy of its argument and sets it as the new value of the attribute.

Definition at line 9517 of file NeuroML_v2.3.cxx.

◆ neuroLexId() [1/5]

Segment_base::neuroLexId_optional & neuroml2::Segment_base::neuroLexId ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

Definition at line 9541 of file NeuroML_v2.3.cxx.

◆ neuroLexId() [2/5]

const Segment_base::neuroLexId_optional & neuroml2::Segment_base::neuroLexId ( ) const

Return a read-only (constant) reference to the attribute container.

Returns: A constant reference to the optional container.

Definition at line 9535 of file NeuroML_v2.3.cxx.

◆ neuroLexId() [3/5]

void neuroml2::Segment_base::neuroLexId ( ::std::unique_ptr< neuroLexId_type > p )

Set the attribute value without copying.

Parameters

p	A new value to use.

This function will try to use the passed value directly instead of making a copy.

Definition at line 9559 of file NeuroML_v2.3.cxx.

◆ neuroLexId() [4/5]

void neuroml2::Segment_base::neuroLexId ( const neuroLexId_optional & x )

Set the attribute value.

Parameters

x	An optional container with the new value to set.

If the value is present in x then this function makes a copy of this value and sets it as the new value of the attribute. Otherwise the attribute container is set the 'not present' state.

Definition at line 9553 of file NeuroML_v2.3.cxx.

◆ neuroLexId() [5/5]

void neuroml2::Segment_base::neuroLexId ( const neuroLexId_type & x )

Set the attribute value.

Parameters

x	A new value to set.

This function makes a copy of its argument and sets it as the new value of the attribute.

Definition at line 9547 of file NeuroML_v2.3.cxx.

◆ operator=()

Segment_base & neuroml2::Segment_base::operator= ( const Segment_base & x )

Copy assignment operator.

Parameters

x	An instance to make a copy of.

Returns: A reference to itself.

For polymorphic object models use the _clone function instead.

Definition at line 34568 of file NeuroML_v2.3.cxx.

◆ parent() [1/5]

Segment_base::parent_optional & neuroml2::Segment_base::parent ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

Definition at line 9427 of file NeuroML_v2.3.cxx.

◆ parent() [2/5]

const Segment_base::parent_optional & neuroml2::Segment_base::parent ( ) const

Return a read-only (constant) reference to the element container.

Returns: A constant reference to the optional container.

Definition at line 9421 of file NeuroML_v2.3.cxx.

◆ parent() [3/5]

void neuroml2::Segment_base::parent ( ::std::unique_ptr< parent_type > p )

Set the element value without copying.

Parameters

p	A new value to use.

This function will try to use the passed value directly instead of making a copy.

Definition at line 9445 of file NeuroML_v2.3.cxx.

◆ parent() [4/5]

void neuroml2::Segment_base::parent ( const parent_optional & x )

Set the element value.

Parameters

x	An optional container with the new value to set.

If the value is present in x then this function makes a copy of this value and sets it as the new value of the element. Otherwise the element container is set the 'not present' state.

Definition at line 9439 of file NeuroML_v2.3.cxx.

◆ parent() [5/5]

void neuroml2::Segment_base::parent ( const parent_type & x )

Set the element value.

Parameters

x	A new value to set.

This function makes a copy of its argument and sets it as the new value of the element.

Definition at line 9433 of file NeuroML_v2.3.cxx.

◆ proximal() [1/5]

Segment_base::proximal_optional & neuroml2::Segment_base::proximal ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

Definition at line 9457 of file NeuroML_v2.3.cxx.

◆ proximal() [2/5]

const Segment_base::proximal_optional & neuroml2::Segment_base::proximal ( ) const

Return a read-only (constant) reference to the element container.

Returns: A constant reference to the optional container.

Definition at line 9451 of file NeuroML_v2.3.cxx.

◆ proximal() [3/5]

void neuroml2::Segment_base::proximal ( ::std::unique_ptr< proximal_type > p )

Set the element value without copying.

Parameters

p	A new value to use.

This function will try to use the passed value directly instead of making a copy.

Definition at line 9475 of file NeuroML_v2.3.cxx.

◆ proximal() [4/5]

void neuroml2::Segment_base::proximal ( const proximal_optional & x )

Set the element value.

Parameters

x	An optional container with the new value to set.

If the value is present in x then this function makes a copy of this value and sets it as the new value of the element. Otherwise the element container is set the 'not present' state.

Definition at line 9469 of file NeuroML_v2.3.cxx.

◆ proximal() [5/5]

void neuroml2::Segment_base::proximal ( const proximal_type & x )

Set the element value.

Parameters

x	A new value to set.

This function makes a copy of its argument and sets it as the new value of the element.

Definition at line 9463 of file NeuroML_v2.3.cxx.

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

src/NeuroML_v2.3.hxx
src/NeuroML_v2.3.cxx

parent

proximal

distal

name

neuroLexId

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Segment_base() [1/3]

◆ Segment_base() [2/3]

◆ Segment_base() [3/3]

Member Function Documentation

◆ _clone()

◆ distal() [1/4]

◆ distal() [2/4]

◆ distal() [3/4]

◆ distal() [4/4]

◆ name() [1/5]

◆ name() [2/5]

◆ name() [3/5]

◆ name() [4/5]

◆ name() [5/5]

◆ neuroLexId() [1/5]

◆ neuroLexId() [2/5]

◆ neuroLexId() [3/5]

◆ neuroLexId() [4/5]

◆ neuroLexId() [5/5]

◆ operator=()

◆ parent() [1/5]

◆ parent() [2/5]

◆ parent() [3/5]

◆ parent() [4/5]

◆ parent() [5/5]

◆ proximal() [1/5]

◆ proximal() [2/5]

◆ proximal() [3/5]

◆ proximal() [4/5]

◆ proximal() [5/5]