CatanaStateData | catana-backend

Data that may be useful for the CatanaStates Upon registration of a CatanaState (with 'set state'), an object of this class will notify that state when some data changes

Hierarchy

CatanaStateData

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CatanaStateData(): CatanaStateData

- Defined in backend/src/catana/actions/catana-state-data.ts:16
Returns CatanaStateData

Properties

Private _aaName

_aaName: string

Private _chainEndToAppendAATo

_chainEndToAppendAATo: "N" | "C"

Private _changeAlsoComplementary

_changeAlsoComplementary: boolean = true

Private _count

_count: number

Private _extendDoubleStrand

_extendDoubleStrand: boolean = false

Private _ntName

_ntName: string

Private _state

_state: null | StateThatNeedsData

Private _strandEndToAppendNTTo

_strandEndToAppendNTTo: "5'" | "3'"

Private _transformOrientation

_transformOrientation: TransformOrientation

Accessors

aaName

get aaName(): string
set aaName(value: string): void

- Defined in backend/src/catana/actions/catana-state-data.ts:31
Returns string
- Defined in backend/src/catana/actions/catana-state-data.ts:35
Parameters
- value: string
Returns void

chainEndToAppendAATo

get chainEndToAppendAATo(): "N" | "C"
set chainEndToAppendAATo(value: "N" | "C"): void

- Defined in backend/src/catana/actions/catana-state-data.ts:40
Returns "N" | "C"
- Defined in backend/src/catana/actions/catana-state-data.ts:44
Parameters
- value: "N" | "C"
Returns void

changeAlsoComplementary

get changeAlsoComplementary(): boolean
set changeAlsoComplementary(value: boolean): void

- Defined in backend/src/catana/actions/catana-state-data.ts:67
Returns boolean
- Defined in backend/src/catana/actions/catana-state-data.ts:71
Parameters
- value: boolean
Returns void

count

get count(): number
set count(value: number): void

- Defined in backend/src/catana/actions/catana-state-data.ts:83
Returns number
- Defined in backend/src/catana/actions/catana-state-data.ts:87
Parameters
- value: number
Returns void

extendDoubleStrand

get extendDoubleStrand(): boolean
set extendDoubleStrand(value: boolean): void

- Defined in backend/src/catana/actions/catana-state-data.ts:75
Returns boolean
- Defined in backend/src/catana/actions/catana-state-data.ts:79
Parameters
- value: boolean
Returns void

ntName

get ntName(): string
set ntName(value: string): void

- Defined in backend/src/catana/actions/catana-state-data.ts:49
Returns string
- Defined in backend/src/catana/actions/catana-state-data.ts:53
Parameters
- value: string
Returns void

state

get state(): StateThatNeedsData | null
set state(value: StateThatNeedsData | null): void

- Defined in backend/src/catana/actions/catana-state-data.ts:106
Get/Set the CatanaState for this object. This CatanaState will then be notified (with 'CatanaState.stateDataUpdated') when a change occurs in the data Note: The CatanaState must implement the method 'stateDataUpdated' to be used here

Returns StateThatNeedsData | null
- Defined in backend/src/catana/actions/catana-state-data.ts:109
Get/Set the CatanaState for this object. This CatanaState will then be notified (with 'CatanaState.stateDataUpdated') when a change occurs in the data Note: The CatanaState must implement the method 'stateDataUpdated' to be used here

Parameters
- value: StateThatNeedsData | null
Returns void

strandEndToAppendNTTo

get strandEndToAppendNTTo(): "5'" | "3'"
set strandEndToAppendNTTo(value: "5'" | "3'"): void

- Defined in backend/src/catana/actions/catana-state-data.ts:58
Returns "5'" | "3'"
- Defined in backend/src/catana/actions/catana-state-data.ts:62
Parameters
- value: "5'" | "3'"
Returns void

transformOrientation

get transformOrientation(): TransformOrientation
set transformOrientation(value: TransformOrientation): void

- Defined in backend/src/catana/actions/catana-state-data.ts:92
Returns TransformOrientation
- Defined in backend/src/catana/actions/catana-state-data.ts:96
Parameters
- value: TransformOrientation
Returns void

Methods

setPolymerParams

setPolymerParams(aaName?: undefined | string, chainEndToAppendTo?: "N" | "C", ntName?: undefined | string, strandEndToAppendTo?: "5'" | "3'", count?: undefined | number): void

- Defined in backend/src/catana/actions/catana-state-data.ts:113
Parameters
- Optional aaName: undefined | string
- Optional chainEndToAppendTo: "N" | "C"
- Optional ntName: undefined | string
- Optional strandEndToAppendTo: "5'" | "3'"
- Optional count: undefined | number
Returns void

Private update

update(): void

- Defined in backend/src/catana/actions/catana-state-data.ts:128
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CatanaStateData

Properties

Private _aaName

Private _chainEndToAppendAATo

Private _changeAlsoComplementary

Private _count

Private _extendDoubleStrand

Private _ntName

Private _state

Private _strandEndToAppendNTTo

Private _transformOrientation

Accessors

aaName

Returns string

Parameters

value: string

Returns void

chainEndToAppendAATo

Returns "N" | "C"

Parameters

value: "N" | "C"

Returns void

changeAlsoComplementary

Returns boolean

Parameters

value: boolean

Returns void

count

Returns number

Parameters

value: number

Returns void

extendDoubleStrand

Returns boolean

Parameters

value: boolean

Returns void

ntName

Returns string

Parameters

value: string

Returns void

state

Returns StateThatNeedsData | null

Parameters

value: StateThatNeedsData | null

Returns void

strandEndToAppendNTTo

Returns "5'" | "3'"

Parameters

value: "5'" | "3'"

Returns void

transformOrientation

Returns TransformOrientation

Parameters

value: TransformOrientation

Returns void

Methods

setPolymerParams

Parameters

Optional aaName: undefined | string

Optional chainEndToAppendTo: "N" | "C"

Optional ntName: undefined | string

Optional strandEndToAppendTo: "5'" | "3'"

Optional count: undefined | number

Returns void

Private update

Returns void