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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::ForwardTransition:

Collaboration diagram for neuroml2::ForwardTransition:

from
Accessor and modifier functions for the from required attribute.
typedef ::neuroml2::NmlId	from_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< from_type, char >	from_traits
	Attribute traits type.

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

from_type &	from ()
	Return a read-write reference to the attribute. More...

void	from (const from_type &x)
	Set the attribute value. More...

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

to
Accessor and modifier functions for the to required attribute.
typedef ::neuroml2::NmlId	to_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< to_type, char >	to_traits
	Attribute traits type.

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

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

void	to (const to_type &x)
	Set the attribute value. More...

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

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

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

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

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

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

virtual	~ForwardTransition ()
	Destructor.

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

A forward only KSTransition for a gateKS which specifies a rate ( type baseHHRate ) which follows one of the standard Hodgkin Huxley forms ( e. g. HHExpRate , HHSigmoidRate , HHExpLinearRate

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

Constructor & Destructor Documentation

◆ ForwardTransition() [1/2]

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

◆ ForwardTransition() [2/2]

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

Member Function Documentation

◆ _clone()

ForwardTransition * neuroml2::ForwardTransition::_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::Base.

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

◆ from() [1/4]

ForwardTransition::from_type & neuroml2::ForwardTransition::from ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ from() [2/4]

const ForwardTransition::from_type & neuroml2::ForwardTransition::from ( ) const

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

Returns: A constant reference to the attribute.

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

◆ from() [3/4]

void neuroml2::ForwardTransition::from ( ::std::unique_ptr< from_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 3805 of file NeuroML_v2.3.cxx.

◆ from() [4/4]

void neuroml2::ForwardTransition::from ( const from_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 3799 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ to() [1/4]

ForwardTransition::to_type & neuroml2::ForwardTransition::to ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ to() [2/4]

const ForwardTransition::to_type & neuroml2::ForwardTransition::to ( ) const

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

Returns: A constant reference to the attribute.

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

◆ to() [3/4]

void neuroml2::ForwardTransition::to ( ::std::unique_ptr< to_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 3829 of file NeuroML_v2.3.cxx.

◆ to() [4/4]

void neuroml2::ForwardTransition::to ( const to_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 3823 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

from

to

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ForwardTransition() [1/2]

◆ ForwardTransition() [2/2]

Member Function Documentation

◆ _clone()

◆ from() [1/4]

◆ from() [2/4]

◆ from() [3/4]

◆ from() [4/4]

◆ operator=()

◆ to() [1/4]

◆ to() [2/4]

◆ to() [3/4]

◆ to() [4/4]