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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::BiophysicalProperties:

Collaboration diagram for neuroml2::BiophysicalProperties:

membraneProperties
Accessor and modifier functions for the membraneProperties required element.
typedef ::neuroml2::MembraneProperties	membraneProperties_type
	Element type.

typedef ::xsd::cxx::tree::traits< membraneProperties_type, char >	membraneProperties_traits
	Element traits type.

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

membraneProperties_type &	membraneProperties ()
	Return a read-write reference to the element. More...

void	membraneProperties (const membraneProperties_type &x)
	Set the element value. More...

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

intracellularProperties
Accessor and modifier functions for the intracellularProperties optional element.
typedef ::neuroml2::IntracellularProperties	intracellularProperties_type
	Element type.

typedef ::xsd::cxx::tree::optional< intracellularProperties_type >	intracellularProperties_optional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< intracellularProperties_type, char >	intracellularProperties_traits
	Element traits type.

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

intracellularProperties_optional &	intracellularProperties ()
	Return a read-write reference to the element container. More...

void	intracellularProperties (const intracellularProperties_type &x)
	Set the element value. More...

void	intracellularProperties (const intracellularProperties_optional &x)
	Set the element value. More...

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

extracellularProperties
Accessor and modifier functions for the extracellularProperties optional element.
typedef ::neuroml2::ExtracellularProperties	extracellularProperties_type
	Element type.

typedef ::xsd::cxx::tree::optional< extracellularProperties_type >	extracellularProperties_optional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< extracellularProperties_type, char >	extracellularProperties_traits
	Element traits type.

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

extracellularProperties_optional &	extracellularProperties ()
	Return a read-write reference to the element container. More...

void	extracellularProperties (const extracellularProperties_type &x)
	Set the element value. More...

void	extracellularProperties (const extracellularProperties_optional &x)
	Set the element value. More...

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

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

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

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

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

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

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

virtual	~BiophysicalProperties ()
	Destructor.

Additional Inherited Members
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::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 BiophysicalProperties schema type.

The biophysical properties of the cell , including the membraneProperties and the intracellularProperties

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

Constructor & Destructor Documentation

◆ BiophysicalProperties() [1/3]

neuroml2::BiophysicalProperties::BiophysicalProperties	(	const id_type &	id,
		::std::unique_ptr< membraneProperties_type >	membraneProperties
	)

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 36138 of file NeuroML_v2.3.cxx.

◆ BiophysicalProperties() [2/3]

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

◆ BiophysicalProperties() [3/3]

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

Member Function Documentation

◆ _clone()

BiophysicalProperties * neuroml2::BiophysicalProperties::_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::Standalone.

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

◆ extracellularProperties() [1/5]

BiophysicalProperties::extracellularProperties_optional & neuroml2::BiophysicalProperties::extracellularProperties ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

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

◆ extracellularProperties() [2/5]

const BiophysicalProperties::extracellularProperties_optional & neuroml2::BiophysicalProperties::extracellularProperties ( ) const

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

Returns: A constant reference to the optional container.

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

◆ extracellularProperties() [3/5]

void neuroml2::BiophysicalProperties::extracellularProperties ( ::std::unique_ptr< extracellularProperties_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 10402 of file NeuroML_v2.3.cxx.

◆ extracellularProperties() [4/5]

void neuroml2::BiophysicalProperties::extracellularProperties ( const extracellularProperties_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 10396 of file NeuroML_v2.3.cxx.

◆ extracellularProperties() [5/5]

void neuroml2::BiophysicalProperties::extracellularProperties ( const extracellularProperties_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 10390 of file NeuroML_v2.3.cxx.

◆ intracellularProperties() [1/5]

BiophysicalProperties::intracellularProperties_optional & neuroml2::BiophysicalProperties::intracellularProperties ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

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

◆ intracellularProperties() [2/5]

const BiophysicalProperties::intracellularProperties_optional & neuroml2::BiophysicalProperties::intracellularProperties ( ) const

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

Returns: A constant reference to the optional container.

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

◆ intracellularProperties() [3/5]

void neuroml2::BiophysicalProperties::intracellularProperties ( ::std::unique_ptr< intracellularProperties_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 10372 of file NeuroML_v2.3.cxx.

◆ intracellularProperties() [4/5]

void neuroml2::BiophysicalProperties::intracellularProperties ( const intracellularProperties_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 10366 of file NeuroML_v2.3.cxx.

◆ intracellularProperties() [5/5]

void neuroml2::BiophysicalProperties::intracellularProperties ( const intracellularProperties_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 10360 of file NeuroML_v2.3.cxx.

◆ membraneProperties() [1/4]

BiophysicalProperties::membraneProperties_type & neuroml2::BiophysicalProperties::membraneProperties ( )

Return a read-write reference to the element.

Returns: A reference to the element.

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

◆ membraneProperties() [2/4]

const BiophysicalProperties::membraneProperties_type & neuroml2::BiophysicalProperties::membraneProperties ( ) const

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

Returns: A constant reference to the element.

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

◆ membraneProperties() [3/4]

void neuroml2::BiophysicalProperties::membraneProperties ( ::std::unique_ptr< membraneProperties_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 10342 of file NeuroML_v2.3.cxx.

◆ membraneProperties() [4/4]

void neuroml2::BiophysicalProperties::membraneProperties ( const membraneProperties_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 10336 of file NeuroML_v2.3.cxx.

◆ operator=()

BiophysicalProperties & neuroml2::BiophysicalProperties::operator= ( const BiophysicalProperties & 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 36247 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

membraneProperties

intracellularProperties

extracellularProperties

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BiophysicalProperties() [1/3]

◆ BiophysicalProperties() [2/3]

◆ BiophysicalProperties() [3/3]

Member Function Documentation

◆ _clone()

◆ extracellularProperties() [1/5]

◆ extracellularProperties() [2/5]

◆ extracellularProperties() [3/5]

◆ extracellularProperties() [4/5]

◆ extracellularProperties() [5/5]

◆ intracellularProperties() [1/5]

◆ intracellularProperties() [2/5]

◆ intracellularProperties() [3/5]

◆ intracellularProperties() [4/5]

◆ intracellularProperties() [5/5]

◆ membraneProperties() [1/4]

◆ membraneProperties() [2/4]

◆ membraneProperties() [3/4]

◆ membraneProperties() [4/4]

◆ operator=()