neuroml2::Notes Class Reference

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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::Notes:

Collaboration diagram for neuroml2::Notes:

Constructors
	Notes ()
	Create an instance from initializers for required elements and attributes.
	Notes (const char *)
	Create an instance from a C string and initializers for required elements and attributes.
	Notes (const ::std::string &)
	Create an instance from a string andinitializers for required elements and attributes.
	Notes (const ::xml_schema::string &)
	Create an instance from the ultimate base and initializers for required elements and attributes.
	Notes (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM element. More...
	Notes (const ::xercesc::DOMAttr &a, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Create an instance from a DOM attribute. More...
	Notes (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...
	Notes (const Notes &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0)
	Copy constructor. More...
virtual Notes *	_clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const
	Copy the instance polymorphically. More...
virtual	~Notes ()
	Destructor.

Detailed Description

Class corresponding to the Notes schema type.

Textual human readable notes related to the element in question. It's useful to put these into the NeuroML files instead of XML comments, as the notes can be extracted and repeated in the files to which the NeuroML is mapped.

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

Constructor & Destructor Documentation

Notes() [1/4]

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

Notes() [2/4]

neuroml2::Notes::Notes	(	const ::xercesc::DOMAttr &	a,
		::xml_schema::flags	f = 0,
		::xml_schema::container *	c = 0
	)

Create an instance from a DOM attribute.

Parameters

a	A DOM attribute 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 19110 of file NeuroML_v2.3.cxx.

Notes() [3/4]

neuroml2::Notes::Notes	(	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.

Parameters

s	A string fragment to extract the data from.
e	A pointer to DOM element containing the string fragment.
f	Flags to create the new instance with.
c	A pointer to the object that will contain the new instance.

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

Notes() [4/4]

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

Member Function Documentation

_clone()

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

Definition at line 19127 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