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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::Property:

Collaboration diagram for neuroml2::Property:

tag
Accessor and modifier functions for the tag required attribute.
typedef ::xml_schema::string	tag_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< tag_type, char >	tag_traits
	Attribute traits type.

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

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

void	tag (const tag_type &x)
	Set the attribute value. More...

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

value
Accessor and modifier functions for the value required attribute.
typedef ::xml_schema::string	value_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< value_type, char >	value_traits
	Attribute traits type.

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

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

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

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

Constructors
	Property (const tag_type &, const value_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

virtual	~Property ()
	Destructor.

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

A property ( a tag and value pair ), which can be on any baseStandalone either as a direct child, or within an Annotation . Generally something which helps the visual display or facilitates simulation of a Component, but is not a core physiological property. Common examples include: numberInternalDivisions, equivalent of nseg in NEURON; radius, for a radius to use in graphical displays for abstract cells ( i. e. without defined morphologies ); color, the color to use for a Population or populationList of cells; recommended_dt_ms, the recommended timestep to use for simulating a Network , recommended_duration_ms the recommended duration to use when running a Network

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

Constructor & Destructor Documentation

◆ Property() [1/2]

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

◆ Property() [2/2]

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

Member Function Documentation

◆ _clone()

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

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

◆ operator=()

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

◆ tag() [1/4]

Property::tag_type & neuroml2::Property::tag ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ tag() [2/4]

const Property::tag_type & neuroml2::Property::tag ( ) const

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

Returns: A constant reference to the attribute.

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

◆ tag() [3/4]

void neuroml2::Property::tag ( ::std::unique_ptr< tag_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 196 of file NeuroML_v2.3.cxx.

◆ tag() [4/4]

void neuroml2::Property::tag ( const tag_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 190 of file NeuroML_v2.3.cxx.

◆ value() [1/4]

Property::value_type & neuroml2::Property::value ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ value() [2/4]

const Property::value_type & neuroml2::Property::value ( ) const

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

Returns: A constant reference to the attribute.

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

◆ value() [3/4]

void neuroml2::Property::value ( ::std::unique_ptr< value_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 220 of file NeuroML_v2.3.cxx.

◆ value() [4/4]

void neuroml2::Property::value ( const value_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 214 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

tag

value

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Property() [1/2]

◆ Property() [2/2]

Member Function Documentation

◆ _clone()

◆ operator=()

◆ tag() [1/4]

◆ tag() [2/4]

◆ tag() [3/4]

◆ tag() [4/4]

◆ value() [1/4]

◆ value() [2/4]

◆ value() [3/4]

◆ value() [4/4]