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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::Cell:

Collaboration diagram for neuroml2::Cell:

morphology
Accessor and modifier functions for the morphology optional attribute.
typedef ::neuroml2::Morphology	morphology_type
	Element type.

typedef ::xsd::cxx::tree::optional< morphology_type >	morphology_optional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< morphology_type, char >	morphology_traits
	Element traits type.

typedef ::neuroml2::NmlId	morphology1_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< morphology1_type >	morphology1_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< morphology1_type, char >	morphology1_traits
	Attribute traits type.

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

morphology_optional &	morphology ()
	Return a read-write reference to the element container. More...

void	morphology (const morphology_type &x)
	Set the element value. More...

void	morphology (const morphology_optional &x)
	Set the element value. More...

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

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

morphology1_optional &	morphology1 ()
	Return a read-write reference to the attribute container. More...

void	morphology1 (const morphology1_type &x)
	Set the attribute value. More...

void	morphology1 (const morphology1_optional &x)
	Set the attribute value. More...

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

biophysicalProperties
Accessor and modifier functions for the biophysicalProperties optional attribute.
typedef ::neuroml2::BiophysicalProperties	biophysicalProperties_type
	Element type.

typedef ::xsd::cxx::tree::optional< biophysicalProperties_type >	biophysicalProperties_optional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< biophysicalProperties_type, char >	biophysicalProperties_traits
	Element traits type.

typedef ::neuroml2::NmlId	biophysicalProperties1_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< biophysicalProperties1_type >	biophysicalProperties1_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< biophysicalProperties1_type, char >	biophysicalProperties1_traits
	Attribute traits type.

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

biophysicalProperties_optional &	biophysicalProperties ()
	Return a read-write reference to the element container. More...

void	biophysicalProperties (const biophysicalProperties_type &x)
	Set the element value. More...

void	biophysicalProperties (const biophysicalProperties_optional &x)
	Set the element value. More...

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

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

biophysicalProperties1_optional &	biophysicalProperties1 ()
	Return a read-write reference to the attribute container. More...

void	biophysicalProperties1 (const biophysicalProperties1_type &x)
	Set the attribute value. More...

void	biophysicalProperties1 (const biophysicalProperties1_optional &x)
	Set the attribute value. More...

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

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

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

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

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

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

virtual	~Cell ()
	Destructor.

Additional Inherited Members
Public Types inherited from neuroml2::BaseCell
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::Standalone
typedef ::neuroml2::Notes	notes_type
	Element type.

typedef ::xsd::cxx::tree::optional< notes_type >	notes_optional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< notes_type, char >	notes_traits
	Element traits type.

typedef ::neuroml2::Property	property_type
	Element type.

typedef ::xsd::cxx::tree::sequence< property_type >	property_sequence
	Element sequence container type.

typedef property_sequence::iterator	property_iterator
	Element iterator type.

typedef property_sequence::const_iterator	property_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< property_type, char >	property_traits
	Element traits type.

typedef ::neuroml2::Annotation	annotation_type
	Element type.

typedef ::xsd::cxx::tree::optional< annotation_type >	annotation_optional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< annotation_type, char >	annotation_traits
	Element traits type.

typedef ::neuroml2::MetaId	metaid_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< metaid_type >	metaid_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< metaid_type, char >	metaid_traits
	Attribute traits type.

Public Types inherited from neuroml2::Base
typedef ::neuroml2::NmlId	id_type
	Attribute type.

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

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

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

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

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

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

virtual	~BaseCell ()
	Destructor.

Public Member Functions inherited from neuroml2::Standalone
const notes_optional &	notes () const
	Return a read-only (constant) reference to the element container. More...

notes_optional &	notes ()
	Return a read-write reference to the element container. More...

void	notes (const notes_type &x)
	Set the element value. More...

void	notes (const notes_optional &x)
	Set the element value. More...

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

const property_sequence &	property () const
	Return a read-only (constant) reference to the element sequence. More...

property_sequence &	property ()
	Return a read-write reference to the element sequence. More...

void	property (const property_sequence &s)
	Copy elements from a given sequence. More...

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

annotation_optional &	annotation ()
	Return a read-write reference to the element container. More...

void	annotation (const annotation_type &x)
	Set the element value. More...

void	annotation (const annotation_optional &x)
	Set the element value. More...

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

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

metaid_optional &	metaid ()
	Return a read-write reference to the attribute container. More...

void	metaid (const metaid_type &x)
	Set the attribute value. More...

void	metaid (const metaid_optional &x)
	Set the attribute value. More...

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

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

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

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

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

virtual	~Standalone ()
	Destructor.

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

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

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

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

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

virtual	~Base ()
	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 Cell schema type.

Cell with segment s specified in a morphology element along with details on its biophysicalProperties . NOTE: this can only be correctly simulated using jLEMS when there is a single segment in the cell, and v of this cell represents the membrane potential in that isopotential segment.

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

Constructor & Destructor Documentation

◆ Cell() [1/2]

neuroml2::Cell::Cell	(	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 33956 of file NeuroML_v2.3.cxx.

◆ Cell() [2/2]

neuroml2::Cell::Cell	(	const Cell &	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 33944 of file NeuroML_v2.3.cxx.

Member Function Documentation

◆ _clone()

Cell * neuroml2::Cell::_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::BaseCell.

Reimplemented in neuroml2::Cell2CaPools.

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

◆ biophysicalProperties() [1/5]

Cell::biophysicalProperties_optional & neuroml2::Cell::biophysicalProperties ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

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

◆ biophysicalProperties() [2/5]

const Cell::biophysicalProperties_optional & neuroml2::Cell::biophysicalProperties ( ) const

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

Returns: A constant reference to the optional container.

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

◆ biophysicalProperties() [3/5]

void neuroml2::Cell::biophysicalProperties ( ::std::unique_ptr< biophysicalProperties_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 9249 of file NeuroML_v2.3.cxx.

◆ biophysicalProperties() [4/5]

void neuroml2::Cell::biophysicalProperties ( const biophysicalProperties_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 9243 of file NeuroML_v2.3.cxx.

◆ biophysicalProperties() [5/5]

void neuroml2::Cell::biophysicalProperties ( const biophysicalProperties_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 9237 of file NeuroML_v2.3.cxx.

◆ biophysicalProperties1() [1/5]

Cell::biophysicalProperties1_optional & neuroml2::Cell::biophysicalProperties1 ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ biophysicalProperties1() [2/5]

const Cell::biophysicalProperties1_optional & neuroml2::Cell::biophysicalProperties1 ( ) const

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

Returns: A constant reference to the optional container.

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

◆ biophysicalProperties1() [3/5]

void neuroml2::Cell::biophysicalProperties1 ( ::std::unique_ptr< biophysicalProperties1_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 9309 of file NeuroML_v2.3.cxx.

◆ biophysicalProperties1() [4/5]

void neuroml2::Cell::biophysicalProperties1 ( const biophysicalProperties1_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 9303 of file NeuroML_v2.3.cxx.

◆ biophysicalProperties1() [5/5]

void neuroml2::Cell::biophysicalProperties1 ( const biophysicalProperties1_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 9297 of file NeuroML_v2.3.cxx.

◆ morphology() [1/5]

Cell::morphology_optional & neuroml2::Cell::morphology ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

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

◆ morphology() [2/5]

const Cell::morphology_optional & neuroml2::Cell::morphology ( ) const

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

Returns: A constant reference to the optional container.

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

◆ morphology() [3/5]

void neuroml2::Cell::morphology ( ::std::unique_ptr< morphology_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 9219 of file NeuroML_v2.3.cxx.

◆ morphology() [4/5]

void neuroml2::Cell::morphology ( const morphology_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 9213 of file NeuroML_v2.3.cxx.

◆ morphology() [5/5]

void neuroml2::Cell::morphology ( const morphology_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 9207 of file NeuroML_v2.3.cxx.

◆ morphology1() [1/5]

Cell::morphology1_optional & neuroml2::Cell::morphology1 ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ morphology1() [2/5]

const Cell::morphology1_optional & neuroml2::Cell::morphology1 ( ) const

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

Returns: A constant reference to the optional container.

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

◆ morphology1() [3/5]

void neuroml2::Cell::morphology1 ( ::std::unique_ptr< morphology1_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 9279 of file NeuroML_v2.3.cxx.

◆ morphology1() [4/5]

void neuroml2::Cell::morphology1 ( const morphology1_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 9273 of file NeuroML_v2.3.cxx.

◆ morphology1() [5/5]

void neuroml2::Cell::morphology1 ( const morphology1_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 9267 of file NeuroML_v2.3.cxx.

◆ operator=()

Cell & neuroml2::Cell::operator= ( const Cell & 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 34045 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

morphology

biophysicalProperties

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Cell() [1/2]

◆ Cell() [2/2]

Member Function Documentation

◆ _clone()

◆ biophysicalProperties() [1/5]

◆ biophysicalProperties() [2/5]

◆ biophysicalProperties() [3/5]

◆ biophysicalProperties() [4/5]

◆ biophysicalProperties() [5/5]

◆ biophysicalProperties1() [1/5]

◆ biophysicalProperties1() [2/5]

◆ biophysicalProperties1() [3/5]

◆ biophysicalProperties1() [4/5]

◆ biophysicalProperties1() [5/5]

◆ morphology() [1/5]

◆ morphology() [2/5]

◆ morphology() [3/5]

◆ morphology() [4/5]

◆ morphology() [5/5]

◆ morphology1() [1/5]

◆ morphology1() [2/5]

◆ morphology1() [3/5]

◆ morphology1() [4/5]

◆ morphology1() [5/5]

◆ operator=()