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

#include <NeuroML_custom.hxx>

Inheritance diagram for neuroml2::Segment:

Collaboration diagram for neuroml2::Segment:

Public Member Functions
double	length () const

double	volume () const

double	surface_area () const

Public Member Functions inherited from neuroml2::Segment_base
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...

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...

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...

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...

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...

	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...

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

virtual	~Segment_base ()
	Destructor.

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.

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

	Segment (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 (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...

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

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

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

virtual	~Segment ()
	Destructor.

Additional Inherited Members
Public Types inherited from neuroml2::Segment_base
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.

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.

typedef ::neuroml2::Point3DWithDiam	distal_type
	Element type.

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

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.

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.

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.

Detailed Description

Class corresponding to the Segment schema type.

Definition at line 218 of file NeuroML_custom.hxx.

Constructor & Destructor Documentation

◆ Segment() [1/3]

neuroml2::Segment::Segment	(	const id_type &	id,
		::std::unique_ptr< distal_type >	d
	)

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 178 of file NeuroML_custom.cxx.

◆ Segment() [2/3]

neuroml2::Segment::Segment	(	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 183 of file NeuroML_custom.cxx.

◆ Segment() [3/3]

neuroml2::Segment::Segment	(	const Segment &	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 188 of file NeuroML_custom.cxx.

Member Function Documentation

◆ _clone()

Segment * neuroml2::Segment::_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::Segment_base.

Definition at line 193 of file NeuroML_custom.cxx.

◆ length()

double neuroml2::Segment::length ( ) const

Returns: The length of this segment.

Definition at line 143 of file NeuroML_custom.cxx.

◆ operator=()

Segment & neuroml2::Segment::operator= ( const Segment & 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 198 of file NeuroML_custom.cxx.

◆ surface_area()

double neuroml2::Segment::surface_area ( ) const

Returns: The surface area of this segment.

Definition at line 162 of file NeuroML_custom.cxx.

◆ volume()

double neuroml2::Segment::volume ( ) const

Returns: The volume of this segment.

Definition at line 153 of file NeuroML_custom.cxx.

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

/home/runner/work/NeuroML_API/NeuroML_API/src/NeuroML_custom.hxx
/home/runner/work/NeuroML_API/NeuroML_API/src/NeuroML_custom.cxx

Public Member Functions

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Segment() [1/3]

◆ Segment() [2/3]

◆ Segment() [3/3]

Member Function Documentation

◆ _clone()

◆ length()

◆ operator=()

◆ surface_area()

◆ volume()