Class CgPolymerView

Simple class providing a view on a subset of CgPolymer data

Hierarchy

CgPolymerView

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CgPolymerView(polymer: CgPolymer, fromIncl?: undefined | number, toExcl?: undefined | number, isCyclic?: undefined | false | true): CgPolymerView

- Defined in backend/src/catana/data_model/views/cg-polymer-view.ts:11
Parameters
- polymer: CgPolymer
  
  source polymer
- Optional fromIncl: undefined | number
  
  starting index of the view subset, i.e., where the view should start (inclusive start)
- Optional toExcl: undefined | number
  
  index of the ending element which should not be included in the view (exclusive end)
- Optional isCyclic: undefined | false | true
  
  if the view should be cyclic or not
Returns CgPolymerView

Properties

Private _from

_from: number

Private _isCyclic

_isCyclic: boolean

Private _sourcePolymer

_sourcePolymer: CgPolymer

Private _to

_to: number

Accessors

from

get from(): number

- Defined in backend/src/catana/data_model/views/cg-polymer-view.ts:36
Returns number

starting index in the source polymer

length

get length(): number

- Defined in backend/src/catana/data_model/views/cg-polymer-view.ts:50
Returns number

length of the polymer view

sourcePolymer

get sourcePolymer(): CgPolymer

- Defined in backend/src/catana/data_model/views/cg-polymer-view.ts:29
Returns CgPolymer

source polymer for this view

to

get to(): number

- Defined in backend/src/catana/data_model/views/cg-polymer-view.ts:43
Returns number

ending index (excl.) in the source polymer

Methods

forEachMonomer

forEachMonomer(callback: (mp: CgMonomerProxy, o: number) => void): void

- Defined in backend/src/catana/data_model/views/cg-polymer-view.ts:60
Executes callback function on each monomer being part of this view.

Parameters
- callback: (mp: CgMonomerProxy, o: number) => void
  
  Function were first argument correspond to the currently processed monomer proxy and the second argument contains monomer offset w.r.t this view.
  - - (mp: CgMonomerProxy, o: number): void
    - Parameters
      - mp: CgMonomerProxy
      - o: number
      Returns void
Returns void

getMonomerProxyTemplate

getMonomerProxyTemplate(): CgMonomerProxy

- Defined in backend/src/catana/data_model/views/cg-polymer-view.ts:73
Returns CgMonomerProxy

Instance of monomer proxy belonging to this polymer

getProxyIndexForOffset

getProxyIndexForOffset(offset: number): number

- Defined in backend/src/catana/data_model/views/cg-polymer-view.ts:84
Returns monomer proxy index corresponding to its location in the source polymer. For example, input offset 0 means that the returned index will equal to "from" value.

Parameters
- offset: number
  
  input offset in the view
Returns number

index in the source polymer corresponding to the input offset

isCyclic

isCyclic(): boolean

- Defined in backend/src/catana/data_model/views/cg-polymer-view.ts:91
Returns boolean

true if this view is cyclic

isDna

isDna(): boolean

- Defined in backend/src/catana/data_model/views/cg-polymer-view.ts:119
Returns boolean

true if this view corresponds to DNA

isNucleic

isNucleic(): boolean

- Defined in backend/src/catana/data_model/views/cg-polymer-view.ts:105
Returns boolean

true if this view corresponds to the nucleic polymer

isProtein

isProtein(): boolean

- Defined in backend/src/catana/data_model/views/cg-polymer-view.ts:98
Returns boolean

true if this view corresponds to protein polymer

isRna

isRna(): boolean

- Defined in backend/src/catana/data_model/views/cg-polymer-view.ts:112
Returns boolean

true if this view corresponds to RNA

Generated using TypeDoc