### Navigation

- index
- next |
- previous |
- NEURON 7.3 documentation »
- Programmatic Model Specification »
- Dynamics (Channels, etc...) »

KSChan
  add_hhstate · add_ksstate · add_transition · erev · gate · gmax · ion · iv_type · ligand · name · ngate · nligand · nstate · ntrans · pr · remove_state · remove_transition · setstructure · state · trans

KSGate
  index · nstate · power · sindex

KSState
  frac · gate · index · name

KSTrans
  ab · f · ftype · index · inftau · ligand · parm · set_f · src · target · type

# KSChan

class `KSChan`
  Syntax:
    `kschan = new KSChan()`
  Description:

    Declare and manage a new density channel type which can be instantiated in sections with the insert statement. After the type comes into existence it is always a valid type and the conductance style, ligands, name, gating functions, etc can be changed at any time. The type cannot be destroyed.

    This is an extension of the KSChan managed by the Java catacomb channel builder tool for the past several years. The primary functional extension is the ability to define HH-style gates in addition to kinetic scheme gates. The administrative extensions allowed a more convenient re-implementation of the channel builder gui in HOC --- albeit substantially similar. The KSChan `KSChan.setstructure()` method uses a slightly modified vector format so the old Java channelbuilder tool will not work without updating the Java implementation.

`KSChan.``setstructure`()
  Syntax:
    `kschan.setstructure(vec)`

  Description:

`KSChan.``remove_state`()
  Syntax:

    `kschan.remove_state(index)`

    `kschan.remove_state(ksstate)`

  Description:

`KSChan.``remove_transition`()
  Syntax:

    `kschan.remove_transition(index)`

    `kschan.remove_transition(kstrans)`

  Description:

`KSChan.``ngate`()
  Syntax:
    `n = kschan.ngate()`

  Description:

`KSChan.``nstate`()
  Syntax:
    `n = kschan.nstate()`

  Description:

`KSChan.``ntrans`()
  Syntax:
    `n = kschan.ntrans()`

  Description:

`KSChan.``nligand`()
  Syntax:
    `n = kschan.nligand()`

  Description:

`KSChan.``pr`()
  Syntax:
    `kschan.pr()`

  Description:

`KSChan.``iv_type`()
  Syntax:

    `type = kschan.iv_type()`

    `type = kschan.iv_type(type)`

  Description:

`KSChan.``gmax`()
  Syntax:

    `val = kschan.gmax()`

    `val = kschan.gmax(val)`

  Description:

`KSChan.``erev`()
  Syntax:

    `val = kschan.erev()`

    `val = kschan.erev(val)`

  Description:

`KSChan.``add_hhstate`()
  Syntax:
    `ksstate = kschan.add_hhstate(name)`

  Description:

`KSChan.``add_ksstate`()
  Syntax:
    `ksstate = kschan.add_ksstate(name)`

  Description:

`KSChan.``add_transition`()
  Syntax:

    `kstrans = kschan.add_transition(src_index, target_index)`

    `kstrans = kschan.add_transition(src_ksstate, target_ksstate)`

  Description:

`KSChan.``trans`()
  Syntax:

    `kstrans = kschan.trans(index)`

    `kstrans = kschan.trans(src_ksstate, target_ksstate)`

  Description:

`KSChan.``state`()
  Syntax:
    `ksstate = kschan.state(index)`

  Description:

`KSChan.``gate`()
  Syntax:
    `ksgate = kschan.gate(index)`

  Description:

`KSChan.``name`()
  Syntax:

    `string = kschan.name()`

    `string = kschan.name(string)`

  Description:

`KSChan.``ion`()
  Syntax:

    `string = kschan.ion()`

    `string = kschan.ion(string)`

  Description:

`KSChan.``ligand`()
  Syntax:
    `string = kschan.ligand(index)`

  Description:

class `KSState`
  Syntax:
    cannot be created directly
  Description:
    A helper class for `KSChan`. KSChan creates and destroys these objects internally. It cannot be created directly with the "new" keyword. An error message will be printed if a hoc reference is used after KSChan has destroyed the referenced KSState.

  See also

  `KSChan.add_hhstate()`, `KSChan.add_ksstate()`

`KSState.``frac`()
  Syntax:

    `val = ksstate.frac()`

    `val = ksstate.frac(val)`

  Description:

`KSState.``index`()
  Syntax:
    `index = ksstate.index()`

  Description:

`KSState.``gate`()
  Syntax:
    `ksgate = ksstate.gate()`

  Description:

`KSState.``name`()
  Syntax:

    `string = ksstate.name()`

    `string = ksstate.name(string)`

  Description:

class `KSGate`
  Syntax:
    cannot be created directly
  Description:
    A helper class for `KSChan`. KSChan creates and destroys these objects internally. It cannot be created directly with the "new" keyword. An error message will be printed if a hoc reference is used after KSChan has destroyed the referenced KSGate.

  See also

  `KSChan.gate()`

`KSGate.``nstate`()
  Syntax:
    `n = ksgate.nstate()`

  Description:

`KSGate.``power`()
  Syntax:

    `i = ksgate.power()`

    `i = ksgate.power(i)`

  Description:

`KSGate.``sindex`()
  Syntax:
    `i = ksgate.sindex()`

  Description:

`KSGate.``index`()
  Syntax:
    `i = ksgate.index()`

  Description:

class `KSTrans`
  Syntax:
    cannot be created directly
  Description:
    A helper class for `KSChan`. KSChan creates and destroys these objects internally. It cannot be created directly with the "new" keyword. An error message will be printed if a hoc reference is used after KSChan has destroyed the referenced KSTrans.

  See also

  `KSChan.add_transition()`, `KSChan.trans()`

`KSTrans.``set_f`()
  Syntax:
    `kstrans.set_f(direction, ftype, parmvec)`

  Description:

`KSTrans.``index`()
  Syntax:
    `i = kstrans.index()`

  Description:

`KSTrans.``type`()
  Syntax:

    `i = kstrans.type()`

    `i = kstrans.type(i)`

  Description:

`KSTrans.``ftype`()
  Syntax:
    `i = kstrans.ftype(direction)`

  Description:

`KSTrans.``ab`()
  Syntax:
    `kstrans.ab(vvec, avec, bvec)`

  Description:

`KSTrans.``inftau`()
  Syntax:
    `kstrans.inftau(vvec, infvec, tauvec)`

  Description:

`KSTrans.``f`()
  Syntax:
    `val = kstrans.f(direction, v)`

  Description:

`KSTrans.``src`()
  Syntax:
    `ksstate = kstrans.src()`

  Description:

`KSTrans.``target`()
  Syntax:
    `ksstate = kstrans.target()`

  Description:

`KSTrans.``parm`()
  Syntax:
    `parmvec = kstrans.parm(direction)`

  Description:

`KSTrans.``ligand`()
  Syntax:

    `string = kstrans.ligand()`

    `string = kstrans.ligand(string)`

  Description:

### Navigation

- index
- next |
- previous |
- NEURON 7.3 documentation »
- Programmatic Model Specification »
- Dynamics (Channels, etc...) »