![]() |
NeuroML C++ API
2.3.0
C++ API for NeuroML 2
|
Class corresponding to the Location schema type. More...
#include <NeuroML_v2.3.hxx>
Inheritance diagram for neuroml2::Location:
Collaboration diagram for neuroml2::Location:x | |
Accessor and modifier functions for the x required attribute. | |
| typedef ::xml_schema::float_ | x_type |
| Attribute type. | |
| typedef ::xsd::cxx::tree::traits< x_type, char > | 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::float_ | y_type |
| Attribute type. | |
| typedef ::xsd::cxx::tree::traits< y_type, char > | 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::float_ | z_type |
| Attribute type. | |
| typedef ::xsd::cxx::tree::traits< z_type, char > | 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... | |
Constructors | |
| Location (const x_type &, const y_type &, const z_type &) | |
| Create an instance from the ultimate base and initializers for required elements and attributes. | |
| Location (const ::xercesc::DOMElement &e, ::xml_schema::flags f=0, ::xml_schema::container *c=0) | |
| Create an instance from a DOM element. More... | |
| Location (const Location &x, ::xml_schema::flags f=0, ::xml_schema::container *c=0) | |
| Copy constructor. More... | |
| virtual Location * | _clone (::xml_schema::flags f=0, ::xml_schema::container *c=0) const |
| Copy the instance polymorphically. More... | |
| Location & | operator= (const Location &x) |
| Copy assignment operator. More... | |
| virtual | ~Location () |
| 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. | |
Class corresponding to the Location schema type.
Specifies the ( x, y, z ) location of a single instance of a component in a population
:param x: :type x: none :param y: :type y: none :param z: :type z: none
Definition at line 60853 of file NeuroML_v2.3.hxx.
| neuroml2::Location::Location | ( | const ::xercesc::DOMElement & | e, |
| ::xml_schema::flags | f = 0, |
||
| ::xml_schema::container * | c = 0 |
||
| ) |
Create an instance from a DOM element.
| 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 44744 of file NeuroML_v2.3.cxx.
| neuroml2::Location::Location | ( | const Location & | x, |
| ::xml_schema::flags | f = 0, |
||
| ::xml_schema::container * | c = 0 |
||
| ) |
Copy constructor.
| 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 44733 of file NeuroML_v2.3.cxx.
|
virtual |
Copy the instance polymorphically.
| f | Flags to create the copy with. |
| c | A pointer to the object that will contain the 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 44811 of file NeuroML_v2.3.cxx.
Copy assignment operator.
| x | An instance to make a copy of. |
For polymorphic object models use the _clone function instead.
Definition at line 44818 of file NeuroML_v2.3.cxx.
| Location::x_type & neuroml2::Location::x | ( | ) |
Return a read-write reference to the attribute.
Definition at line 15243 of file NeuroML_v2.3.cxx.
| const Location::x_type & neuroml2::Location::x | ( | ) | const |
Return a read-only (constant) reference to the attribute.
Definition at line 15237 of file NeuroML_v2.3.cxx.
| void neuroml2::Location::x | ( | const x_type & | x | ) |
Set the attribute value.
| 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 15249 of file NeuroML_v2.3.cxx.
| Location::y_type & neuroml2::Location::y | ( | ) |
Return a read-write reference to the attribute.
Definition at line 15261 of file NeuroML_v2.3.cxx.
| const Location::y_type & neuroml2::Location::y | ( | ) | const |
Return a read-only (constant) reference to the attribute.
Definition at line 15255 of file NeuroML_v2.3.cxx.
| void neuroml2::Location::y | ( | const y_type & | x | ) |
Set the attribute value.
| 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 15267 of file NeuroML_v2.3.cxx.
| Location::z_type & neuroml2::Location::z | ( | ) |
Return a read-write reference to the attribute.
Definition at line 15279 of file NeuroML_v2.3.cxx.
| const Location::z_type & neuroml2::Location::z | ( | ) | const |
Return a read-only (constant) reference to the attribute.
Definition at line 15273 of file NeuroML_v2.3.cxx.
| void neuroml2::Location::z | ( | const z_type & | x | ) |
Set the attribute value.
| 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 15285 of file NeuroML_v2.3.cxx.