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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::ElectricalConnection:

Collaboration diagram for neuroml2::ElectricalConnection:

synapse
Accessor and modifier functions for the synapse required attribute.
typedef ::neuroml2::NmlId	synapse_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< synapse_type, char >	synapse_traits
	Attribute traits type.

const synapse_type &	synapse () const
	Return a read-only (constant) reference to the attribute. More...

synapse_type &	synapse ()
	Return a read-write reference to the attribute. More...

void	synapse (const synapse_type &x)
	Set the attribute value. More...

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

Constructors
	ElectricalConnection (const id_type &, const preCell_type &, const postCell_type &, const synapse_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

virtual	~ElectricalConnection ()
	Destructor.

Additional Inherited Members
Public Types inherited from neuroml2::BaseConnectionNewFormat
typedef ::xml_schema::string	preCell_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< preCell_type, char >	preCell_traits
	Attribute traits type.

typedef ::neuroml2::NonNegativeInteger	preSegment_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< preSegment_type, char >	preSegment_traits
	Attribute traits type.

typedef ::neuroml2::ZeroToOne	preFractionAlong_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< preFractionAlong_type, char >	preFractionAlong_traits
	Attribute traits type.

typedef ::xml_schema::string	postCell_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< postCell_type, char >	postCell_traits
	Attribute traits type.

typedef ::neuroml2::NonNegativeInteger	postSegment_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< postSegment_type, char >	postSegment_traits
	Attribute traits type.

typedef ::neuroml2::ZeroToOne	postFractionAlong_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< postFractionAlong_type, char >	postFractionAlong_traits
	Attribute traits type.

Public Types inherited from neuroml2::BaseConnection
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.

Public Member Functions inherited from neuroml2::BaseConnectionNewFormat
const preCell_type &	preCell () const
	Return a read-only (constant) reference to the attribute. More...

preCell_type &	preCell ()
	Return a read-write reference to the attribute. More...

void	preCell (const preCell_type &x)
	Set the attribute value. More...

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

const preSegment_type &	preSegment () const
	Return a read-only (constant) reference to the attribute. More...

preSegment_type &	preSegment ()
	Return a read-write reference to the attribute. More...

void	preSegment (const preSegment_type &x)
	Set the attribute value. More...

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

const preFractionAlong_type &	preFractionAlong () const
	Return a read-only (constant) reference to the attribute. More...

preFractionAlong_type &	preFractionAlong ()
	Return a read-write reference to the attribute. More...

void	preFractionAlong (const preFractionAlong_type &x)
	Set the attribute value. More...

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

const postCell_type &	postCell () const
	Return a read-only (constant) reference to the attribute. More...

postCell_type &	postCell ()
	Return a read-write reference to the attribute. More...

void	postCell (const postCell_type &x)
	Set the attribute value. More...

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

const postSegment_type &	postSegment () const
	Return a read-only (constant) reference to the attribute. More...

postSegment_type &	postSegment ()
	Return a read-write reference to the attribute. More...

void	postSegment (const postSegment_type &x)
	Set the attribute value. More...

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

const postFractionAlong_type &	postFractionAlong () const
	Return a read-only (constant) reference to the attribute. More...

postFractionAlong_type &	postFractionAlong ()
	Return a read-write reference to the attribute. More...

void	postFractionAlong (const postFractionAlong_type &x)
	Set the attribute value. More...

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

	BaseConnectionNewFormat (const id_type &, const preCell_type &, const postCell_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

virtual	~BaseConnectionNewFormat ()
	Destructor.

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

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

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

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

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

virtual	~BaseConnection ()
	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.

Static Public Member Functions inherited from neuroml2::BaseConnectionNewFormat
static preSegment_type	preSegment_default_value ()
	Return the default value for the attribute. More...

static preFractionAlong_type	preFractionAlong_default_value ()
	Return the default value for the attribute. More...

static postSegment_type	postSegment_default_value ()
	Return the default value for the attribute. More...

static postFractionAlong_type	postFractionAlong_default_value ()
	Return the default value for the attribute. More...

Detailed Description

Class corresponding to the ElectricalConnection schema type.

To enable connections between populations through gap junctions.

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

Constructor & Destructor Documentation

◆ ElectricalConnection() [1/2]

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

◆ ElectricalConnection() [2/2]

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

Member Function Documentation

◆ _clone()

ElectricalConnection * neuroml2::ElectricalConnection::_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::BaseConnectionNewFormat.

Reimplemented in neuroml2::ElectricalConnectionInstanceW, and neuroml2::ElectricalConnectionInstance.

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

◆ operator=()

ElectricalConnection & neuroml2::ElectricalConnection::operator= ( const ElectricalConnection & 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 46305 of file NeuroML_v2.3.cxx.

◆ synapse() [1/4]

ElectricalConnection::synapse_type & neuroml2::ElectricalConnection::synapse ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ synapse() [2/4]

const ElectricalConnection::synapse_type & neuroml2::ElectricalConnection::synapse ( ) const

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

Returns: A constant reference to the attribute.

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

◆ synapse() [3/4]

void neuroml2::ElectricalConnection::synapse ( ::std::unique_ptr< synapse_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 16079 of file NeuroML_v2.3.cxx.

◆ synapse() [4/4]

void neuroml2::ElectricalConnection::synapse ( const synapse_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 16073 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

synapse

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ElectricalConnection() [1/2]

◆ ElectricalConnection() [2/2]

Member Function Documentation

◆ _clone()

◆ operator=()

◆ synapse() [1/4]

◆ synapse() [2/4]

◆ synapse() [3/4]

◆ synapse() [4/4]