/* 
  This schema specifies model components for describing neurons.  These are
  fairly abstract and mainly meant to serve as placeholders / bases for
  extension.

  Included are:

  - neuron
  - invertebrate neuron
  - mammalian neuron
 */
targetNamespace "urn:bml/brainml.org:med.cornell.edu/Neuron/1"
namespace "urn:bml/brainml.org:med.cornell.edu/Neuron/1"
namespace bml "urn:bml/brainml.org:internal/BrainML/5"
namespace bmtl "urn:bml/brainml.org:internal/BrainMetaL/1"
import "http://brainml.org/schemas/internal/BrainMetaL/1/xml.xsd" namespace "http://www.w3.org/XML/1998/namespace"
import "http://brainml.org/schemas/internal/BrainMetaL/1/citation.xsd" namespace "urn:bml/brainml.org:internal/BrainMetaL/1"
import "http://brainml.org/schemas/internal/BrainML/5/brainml.xsd" namespace "urn:bml/brainml.org:internal/BrainML/5"
complexType neuron-type restricts xs:anyType {
    ( transmitter?, receptor* )
}

/* Neurotransmitter used by neuron. */
element transmitter restricts bmtl:vocab-type {
    attribute domain { xs:token } = "neuron.transmitter"
}

/* Synaptic receptor expressed by neuron. */
element receptor restricts bmtl:vocab-type {
    attribute domain { xs:token } = "neuron.receptor"
}

/* Superclass for neuron recording sources; do not use directly. */
abstract element neuron substitutes bml:recording_source { neuron-type }

/* Recording source, specialized to invertebrate neurons. */
element invertebrate_neuron substitutes neuron { invertebrate_neuron-type }
complexType invertebrate_neuron-type extends neuron-type {
    ( neuron_id { xs:normalizedString }, )
}

/* Recording source, specialized to mammalian neurons. */
element mammalian_neuron substitutes neuron { mammalian_neuron-type }
complexType mammalian_neuron-type extends neuron-type {
    ( spontaneous_firing_hz?, directed_firing? )
}

/* Spontaneous firing rate of the Neuron, in Hz. */
element spontaneous_firing_hz { xs:positiveInteger }

/*  Firing characteristics of Neuron when driven by stimulus or controlling
   action. */
element directed_firing restricts bmtl:vocab-type {
    attribute domain { xs:token } = "mammalian neuron.firing"
}