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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::Population:

Collaboration diagram for neuroml2::Population:

layout
Accessor and modifier functions for the layout optional element.
typedef ::neuroml2::Layout	layout_type
	Element type.

typedef ::xsd::cxx::tree::optional< layout_type >	layout_optional
	Element optional container type.

typedef ::xsd::cxx::tree::traits< layout_type, char >	layout_traits
	Element traits type.

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

layout_optional &	layout ()
	Return a read-write reference to the element container. More...

void	layout (const layout_type &x)
	Set the element value. More...

void	layout (const layout_optional &x)
	Set the element value. More...

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

instance
Accessor and modifier functions for the instance sequence element.
typedef ::neuroml2::Instance	instance_type
	Element type.

typedef ::xsd::cxx::tree::sequence< instance_type >	instance_sequence
	Element sequence container type.

typedef instance_sequence::iterator	instance_iterator
	Element iterator type.

typedef instance_sequence::const_iterator	instance_const_iterator
	Element constant iterator type.

typedef ::xsd::cxx::tree::traits< instance_type, char >	instance_traits
	Element traits type.

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

instance_sequence &	instance ()
	Return a read-write reference to the element sequence. More...

void	instance (const instance_sequence &s)
	Copy elements from a given sequence. More...

component
Accessor and modifier functions for the component required attribute.
typedef ::neuroml2::NmlId	component_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< component_type, char >	component_traits
	Attribute traits type.

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

component_type &	component ()
	Return a read-write reference to the attribute. More...

void	component (const component_type &x)
	Set the attribute value. More...

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

size
Accessor and modifier functions for the size optional attribute.
typedef ::neuroml2::NonNegativeInteger	size_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< size_type >	size_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< size_type, char >	size_traits
	Attribute traits type.

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

size_optional &	size ()
	Return a read-write reference to the attribute container. More...

void	size (const size_type &x)
	Set the attribute value. More...

void	size (const size_optional &x)
	Set the attribute value. More...

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

type
Accessor and modifier functions for the type optional attribute.
typedef ::neuroml2::populationTypes	type_type
	Attribute type.

typedef ::xsd::cxx::tree::optional< type_type >	type_optional
	Attribute optional container type.

typedef ::xsd::cxx::tree::traits< type_type, char >	type_traits
	Attribute traits type.

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

type_optional &	type ()
	Return a read-write reference to the attribute container. More...

void	type (const type_type &x)
	Set the attribute value. More...

void	type (const type_optional &x)
	Set the attribute value. More...

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

extracellularProperties
Accessor and modifier functions for the extracellularProperties optional attribute.
typedef ::neuroml2::NmlId	extracellularProperties_type
	Attribute type.

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

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

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

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

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

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

void	extracellularProperties (::std::unique_ptr< extracellularProperties_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
	Population (const id_type &, const component_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

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

A population of components, with just one parameter for the size, i. e. number of components to create. Note: quite often this is used with type= populationList which means the size is determined by the number of instance s ( with location s ) in the list. The size attribute is still set, and there will be a validation error if this does not match the number in the list.
:param size: Number of instances of this Component to create when the population is instantiated :type size: none

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

Constructor & Destructor Documentation

◆ Population() [1/2]

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

◆ Population() [2/2]

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

Member Function Documentation

◆ _clone()

Population * neuroml2::Population::_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 43934 of file NeuroML_v2.3.cxx.

◆ component() [1/4]

Population::component_type & neuroml2::Population::component ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ component() [2/4]

const Population::component_type & neuroml2::Population::component ( ) const

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

Returns: A constant reference to the attribute.

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

◆ component() [3/4]

void neuroml2::Population::component ( ::std::unique_ptr< component_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 14652 of file NeuroML_v2.3.cxx.

◆ component() [4/4]

void neuroml2::Population::component ( const component_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 14646 of file NeuroML_v2.3.cxx.

◆ extracellularProperties() [1/5]

Population::extracellularProperties_optional & neuroml2::Population::extracellularProperties ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ extracellularProperties() [2/5]

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

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

Returns: A constant reference to the optional container.

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

◆ extracellularProperties() [3/5]

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

◆ extracellularProperties() [4/5]

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

◆ extracellularProperties() [5/5]

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

◆ instance() [1/3]

Population::instance_sequence & neuroml2::Population::instance ( )

Return a read-write reference to the element sequence.

Returns: A reference to the sequence container.

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

◆ instance() [2/3]

const Population::instance_sequence & neuroml2::Population::instance ( ) const

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

Returns: A constant reference to the sequence container.

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

◆ instance() [3/3]

void neuroml2::Population::instance ( const instance_sequence & s )

Copy elements from a given sequence.

Parameters

s	A sequence to copy elements from.

For each element in s this function makes a copy and adds it to the sequence. Note that this operation completely changes the sequence and all old elements will be lost.

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

◆ layout() [1/5]

Population::layout_optional & neuroml2::Population::layout ( )

Return a read-write reference to the element container.

Returns: A reference to the optional container.

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

◆ layout() [2/5]

const Population::layout_optional & neuroml2::Population::layout ( ) const

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

Returns: A constant reference to the optional container.

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

◆ layout() [3/5]

void neuroml2::Population::layout ( ::std::unique_ptr< layout_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 14610 of file NeuroML_v2.3.cxx.

◆ layout() [4/5]

void neuroml2::Population::layout ( const layout_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 14604 of file NeuroML_v2.3.cxx.

◆ layout() [5/5]

void neuroml2::Population::layout ( const layout_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 14598 of file NeuroML_v2.3.cxx.

◆ neuroLexId() [1/5]

Population::neuroLexId_optional & neuroml2::Population::neuroLexId ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ neuroLexId() [2/5]

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

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

Returns: A constant reference to the optional container.

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

◆ neuroLexId() [3/5]

void neuroml2::Population::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 14772 of file NeuroML_v2.3.cxx.

◆ neuroLexId() [4/5]

void neuroml2::Population::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 14766 of file NeuroML_v2.3.cxx.

◆ neuroLexId() [5/5]

void neuroml2::Population::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 14760 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ size() [1/5]

Population::size_optional & neuroml2::Population::size ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ size() [2/5]

const Population::size_optional & neuroml2::Population::size ( ) const

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

Returns: A constant reference to the optional container.

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

◆ size() [3/5]

void neuroml2::Population::size ( ::std::unique_ptr< size_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 14682 of file NeuroML_v2.3.cxx.

◆ size() [4/5]

void neuroml2::Population::size ( const size_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 14676 of file NeuroML_v2.3.cxx.

◆ size() [5/5]

void neuroml2::Population::size ( const size_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 14670 of file NeuroML_v2.3.cxx.

◆ type() [1/5]

Population::type_optional & neuroml2::Population::type ( )

Return a read-write reference to the attribute container.

Returns: A reference to the optional container.

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

◆ type() [2/5]

const Population::type_optional & neuroml2::Population::type ( ) const

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

Returns: A constant reference to the optional container.

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

◆ type() [3/5]

void neuroml2::Population::type ( ::std::unique_ptr< type_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 14712 of file NeuroML_v2.3.cxx.

◆ type() [4/5]

void neuroml2::Population::type ( const type_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 14706 of file NeuroML_v2.3.cxx.

◆ type() [5/5]

void neuroml2::Population::type ( const type_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 14700 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

layout

instance

component

size

type

extracellularProperties

neuroLexId

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Population() [1/2]

◆ Population() [2/2]

Member Function Documentation

◆ _clone()

◆ component() [1/4]

◆ component() [2/4]

◆ component() [3/4]

◆ component() [4/4]

◆ extracellularProperties() [1/5]

◆ extracellularProperties() [2/5]

◆ extracellularProperties() [3/5]

◆ extracellularProperties() [4/5]

◆ extracellularProperties() [5/5]

◆ instance() [1/3]

◆ instance() [2/3]

◆ instance() [3/3]

◆ layout() [1/5]

◆ layout() [2/5]

◆ layout() [3/5]

◆ layout() [4/5]

◆ layout() [5/5]

◆ neuroLexId() [1/5]

◆ neuroLexId() [2/5]

◆ neuroLexId() [3/5]

◆ neuroLexId() [4/5]

◆ neuroLexId() [5/5]

◆ operator=()

◆ size() [1/5]

◆ size() [2/5]

◆ size() [3/5]

◆ size() [4/5]

◆ size() [5/5]

◆ type() [1/5]

◆ type() [2/5]

◆ type() [3/5]

◆ type() [4/5]

◆ type() [5/5]