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

#include <NeuroML_v2.3.hxx>

Inheritance diagram for neuroml2::Point3DWithDiam:

Collaboration diagram for neuroml2::Point3DWithDiam:

x
Accessor and modifier functions for the x required attribute.
typedef ::xml_schema::double_	x_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< x_type, char, ::xsd::cxx::tree::schema_type::double_ >	x_traits
	Attribute traits type.

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

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

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

y
Accessor and modifier functions for the y required attribute.
typedef ::xml_schema::double_	y_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< y_type, char, ::xsd::cxx::tree::schema_type::double_ >	y_traits
	Attribute traits type.

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

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

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

z
Accessor and modifier functions for the z required attribute.
typedef ::xml_schema::double_	z_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< z_type, char, ::xsd::cxx::tree::schema_type::double_ >	z_traits
	Attribute traits type.

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

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

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

diameter
Accessor and modifier functions for the diameter required attribute.
typedef ::neuroml2::DoubleGreaterThanZero	diameter_type
	Attribute type.

typedef ::xsd::cxx::tree::traits< diameter_type, char >	diameter_traits
	Attribute traits type.

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

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

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

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

Constructors
	Point3DWithDiam (const x_type &, const y_type &, const z_type &, const diameter_type &)
	Create an instance from the ultimate base and initializers for required elements and attributes.

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

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

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

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

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

Base type for ComponentTypes which specify an ( x, y, z ) coordinate along with a diameter. Note: no dimension used in the attributes for these coordinates! These are assumed to have dimension micrometer ( 10^-6 m ). This is due to micrometers being the default option for the majority of neuronal morphology formats, and dimensions are omitted here to facilitate reading and writing of morphologies in NeuroML.
:param x: x coordinate of the point. Note: no dimension used, see description of point3DWithDiam for details. :type x: none :param y: y coordinate of the ppoint. Note: no dimension used, see description of point3DWithDiam for details. :type y: none :param z: z coordinate of the ppoint. Note: no dimension used, see description of point3DWithDiam for details. :type z: none :param diameter: Diameter of the ppoint. Note: no dimension used, see description of point3DWithDiam for details. :type diameter: none

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

Constructor & Destructor Documentation

◆ Point3DWithDiam() [1/2]

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

◆ Point3DWithDiam() [2/2]

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

Member Function Documentation

◆ _clone()

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

◆ diameter() [1/4]

Point3DWithDiam::diameter_type & neuroml2::Point3DWithDiam::diameter ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ diameter() [2/4]

const Point3DWithDiam::diameter_type & neuroml2::Point3DWithDiam::diameter ( ) const

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

Returns: A constant reference to the attribute.

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

◆ diameter() [3/4]

void neuroml2::Point3DWithDiam::diameter ( ::std::unique_ptr< diameter_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 9699 of file NeuroML_v2.3.cxx.

◆ diameter() [4/4]

void neuroml2::Point3DWithDiam::diameter ( const diameter_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 9693 of file NeuroML_v2.3.cxx.

◆ operator=()

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

◆ x() [1/3]

Point3DWithDiam::x_type & neuroml2::Point3DWithDiam::x ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ x() [2/3]

const Point3DWithDiam::x_type & neuroml2::Point3DWithDiam::x ( ) const

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

Returns: A constant reference to the attribute.

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

◆ x() [3/3]

void neuroml2::Point3DWithDiam::x ( const x_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 9639 of file NeuroML_v2.3.cxx.

◆ y() [1/3]

Point3DWithDiam::y_type & neuroml2::Point3DWithDiam::y ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ y() [2/3]

const Point3DWithDiam::y_type & neuroml2::Point3DWithDiam::y ( ) const

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

Returns: A constant reference to the attribute.

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

◆ y() [3/3]

void neuroml2::Point3DWithDiam::y ( const y_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 9657 of file NeuroML_v2.3.cxx.

◆ z() [1/3]

Point3DWithDiam::z_type & neuroml2::Point3DWithDiam::z ( )

Return a read-write reference to the attribute.

Returns: A reference to the attribute.

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

◆ z() [2/3]

const Point3DWithDiam::z_type & neuroml2::Point3DWithDiam::z ( ) const

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

Returns: A constant reference to the attribute.

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

◆ z() [3/3]

void neuroml2::Point3DWithDiam::z ( const z_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 9675 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

x

y

z

diameter

Constructors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Point3DWithDiam() [1/2]

◆ Point3DWithDiam() [2/2]

Member Function Documentation

◆ _clone()

◆ diameter() [1/4]

◆ diameter() [2/4]

◆ diameter() [3/4]

◆ diameter() [4/4]

◆ operator=()

◆ x() [1/3]

◆ x() [2/3]

◆ x() [3/3]

◆ y() [1/3]

◆ y() [2/3]

◆ y() [3/3]

◆ z() [1/3]

◆ z() [2/3]

◆ z() [3/3]