KSChan

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

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 setstructure method uses a slightly modified vector format so the old Java channelbuilder tool will not work without updating the Java implementation.

setstructure

KSChan

SYNTAX

kschan.setstructure(vec)

DESCRIPTION

remove_state

KSChan

SYNTAX

kschan.remove_state(index)
kschan.remove_state(ksstate)

DESCRIPTION

remove_transition

KSChan

SYNTAX

kschan.remove_transition(index)
kschan.remove_transition(kstrans)

DESCRIPTION

ngate

KSChan

SYNTAX

n = kschan.ngate()

DESCRIPTION

nstate

KSChan

SYNTAX

n = kschan.nstate()

DESCRIPTION

ntrans

KSChan

SYNTAX

n = kschan.ntrans()

DESCRIPTION

nligand

KSChan

SYNTAX

n = kschan.nligand()

DESCRIPTION

pr

KSChan

SYNTAX

kschan.pr()

DESCRIPTION

iv_type

KSChan

SYNTAX

type = kschan.iv_type()
type = kschan.iv_type(type)

DESCRIPTION

gmax

KSChan

SYNTAX

val = kschan.gmax()
val = kschan.gmax(val)

DESCRIPTION

erev

KSChan

SYNTAX

val = kschan.erev()
val = kschan.erev(val)

DESCRIPTION

add_hhstate

KSChan

SYNTAX

ksstate = kschan.add_hhstate(name)

DESCRIPTION

add_ksstate

KSChan

SYNTAX

ksstate = kschan.add_ksstate(name)

DESCRIPTION

add_transition

KSChan

SYNTAX

kstrans = kschan.add_transition(src_index, target_index)
kstrans = kschan.add_transition(src_ksstate, target_ksstate)

DESCRIPTION

trans

KSChan

SYNTAX

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

DESCRIPTION

state

KSChan

SYNTAX

ksstate = kschan.state(index)

DESCRIPTION

gate

KSChan

SYNTAX

ksgate = kschan.gate(index)

DESCRIPTION

name

KSChan

SYNTAX

string = kschan.name()
string = kschan.name(string)

DESCRIPTION

ion

KSChan

SYNTAX

string = kschan.ion()
string = kschan.ion(string)

DESCRIPTION

ligand

KSChan

SYNTAX

string = kschan.ligand(index)

DESCRIPTION

KSState

classes
   frac           gate           index          name

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

add_hhstate add_ksstate

frac

KSState

SYNTAX

val = ksstate.frac()
val = ksstate.frac(val)

DESCRIPTION

index

KSState

SYNTAX

index = ksstate.index()

DESCRIPTION

gate

KSState

SYNTAX

ksgate = ksstate.gate()

DESCRIPTION

name

KSState

SYNTAX

string = ksstate.name()
string = ksstate.name(string)

DESCRIPTION

KSGate

classes
   index          nstate         power          sindex

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

gate

nstate

KSGate

SYNTAX

n = ksgate.nstate()

DESCRIPTION

power

KSGate

SYNTAX

i = ksgate.power()
i = ksgate.power(i)

DESCRIPTION

sindex

KSGate

SYNTAX

i = ksgate.sindex()

DESCRIPTION

index

KSGate

SYNTAX

i = ksgate.index()

DESCRIPTION

KSTrans

classes
   ab             index          parm           target         
   f              inftau         set_f          type           
   ftype          ligand         src

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

add_transition trans

set_f

KSTrans

SYNTAX

kstrans.set_f(direction, ftype, parmvec)

DESCRIPTION

index

KSTrans

SYNTAX

i = kstrans.index()

DESCRIPTION

type

KSTrans

SYNTAX

i = kstrans.type()
i = kstrans.type(i)

DESCRIPTION

ftype

KSTrans

SYNTAX

i = kstrans.ftype(direction)

DESCRIPTION

ab

KSTrans

SYNTAX

kstrans.ab(vvec, avec, bvec)

DESCRIPTION

inftau

KSTrans

SYNTAX

kstrans.inftau(vvec, infvec, tauvec)

DESCRIPTION

f

KSTrans

SYNTAX

val = kstrans.f(direction, v)

DESCRIPTION

src

KSTrans

SYNTAX

ksstate = kstrans.src()

DESCRIPTION

target

KSTrans

SYNTAX

ksstate = kstrans.target()

DESCRIPTION

parm

KSTrans

SYNTAX

parmvec = kstrans.parm(direction)

DESCRIPTION

ligand

KSTrans

SYNTAX

string = kstrans.ligand()
string = kstrans.ligand(string)

DESCRIPTION

neuron/neuron/classes/kschan.hel : May 13 2012