NeuroML_custom.hxx

// Copyright 2017 University College London.
// See Licence.txt for details.
 
#ifndef NEURO_ML_CUSTOM_HXX
#define NEURO_ML_CUSTOM_HXX
 
#include <iosfwd> // For streaming operators & writeToFile
 
namespace neuroml2
{
 
std::unique_ptr<NeuroMLDocument> parseFile(const std::string& filePath);
 
std::string getSchemaPath();
 
class NeuroMLDocument: public NeuroMLDocument_base
{
public:
    void writeToFile(const std::string& pathToFile, std::ios_base::openmode mode = std::ios_base::out) const;
 
 
    NeuroMLDocument (const id_type&);
 
    NeuroMLDocument (const ::xercesc::DOMElement& e,
                     ::xml_schema::flags f = 0,
                     ::xml_schema::container* c = 0);
 
    NeuroMLDocument (const NeuroMLDocument& x,
                     ::xml_schema::flags f = 0,
                     ::xml_schema::container* c = 0);
 
    virtual NeuroMLDocument*
    _clone (::xml_schema::flags f = 0,
            ::xml_schema::container* c = 0) const;
 
    NeuroMLDocument&
    operator= (const NeuroMLDocument& x);
 
 
    virtual
    ~NeuroMLDocument ();
};
 
class Morphology: public Morphology_base
{
public:
    // Our additions to the class
 
    unsigned num_segments() const;
 
    // Constructor signatures etc. copied from the auto-generated base class.
 
    Morphology(const id_type&);
 
    Morphology(const ::xercesc::DOMElement& e,
               ::xml_schema::flags f = 0,
               ::xml_schema::container* c = 0);
 
    Morphology(const Morphology& x,
               ::xml_schema::flags f = 0,
               ::xml_schema::container* c = 0);
 
    virtual Morphology*
    _clone(::xml_schema::flags f = 0,
           ::xml_schema::container* c = 0) const;
 
    Morphology&
    operator=(const Morphology& x);
 
 
    virtual
    ~Morphology();
};
 
class Segment: public Segment_base
{
public:
    // Our additions to the class
 
    double length() const;
 
    double volume() const;
 
    double surface_area() const;
 
    // Constructor signatures etc. copied from the auto-generated base class.
 
    Segment(const id_type&,
            const distal_type&);
 
    Segment(const id_type&,
            ::std::unique_ptr<distal_type>);
 
    Segment(const ::xercesc::DOMElement& e,
            ::xml_schema::flags f = 0,
            ::xml_schema::container* c = 0);
 
    Segment(const Segment& x,
            ::xml_schema::flags f = 0,
            ::xml_schema::container* c = 0);
 
    virtual Segment*
    _clone(::xml_schema::flags f = 0,
           ::xml_schema::container* c = 0) const;
 
    Segment&
    operator=(const Segment& x);
 
 
    virtual
    ~Segment();
};
 
class Connection: public Connection_base
{
    // Our additions to the class
protected:
    unsigned _get_cell_id(const std::string& id_string) const;
 
public:
    unsigned get_pre_cell_id() const;
 
    unsigned get_post_cell_id() const;
 
//    std::string TODO: equiv of __str__ - override operator<<?
 
    // Constructor signatures etc. copied from the auto-generated base class.
 
    Connection(const id_type&,
               const preCellId_type&,
               const postCellId_type&);
 
    Connection(const ::xercesc::DOMElement& e,
               ::xml_schema::flags f = 0,
               ::xml_schema::container* c = 0);
 
    Connection(const Connection& x,
               ::xml_schema::flags f = 0,
               ::xml_schema::container* c = 0);
 
    virtual Connection*
    _clone(::xml_schema::flags f = 0,
           ::xml_schema::container* c = 0) const;
 
 
    virtual
    ~Connection();
};
 
// Streaming operators
 
::std::ostream&
operator<< (::std::ostream&, const Connection&);
 
}
 
#endif // NEURO_ML_CUSTOM_HXX