Hierarchy

  • Structure

Constructors

Properties

_child: any
_proxy: any
_target: any
computeHash: any
state: any
unitIndexMap: IntMap<number>
units: readonly <internal>.Unit[]

Accessors

  • get atomicResidueCount(): number
  • Returns number

  • get bondCount(): number
  • Count of all bonds (intra- and inter-unit) in the structure

    Returns number

  • get boundary(): Boundary
  • Returns Boundary

  • get carbohydrates(): Carbohydrates
  • Returns Carbohydrates

  • get coordinateSystem(): SymmetryOperator
  • Conformation transformation that was applied to every unit of this structure.

    Coordinate system applies to the current structure only. A parent structure can have a different coordinate system and thefore it has to be composed "manualy" by the consumer.

    Returns SymmetryOperator

  • get currentPropertyData(): any
  • Property data unique to this instance of the structure.

    Returns any

  • get dynamicBonds(): boolean
  • Returns boolean

  • get elementCount(): number
  • Count of all elements in the structure, i.e. the sum of the elements in the units

    Returns number

  • get hasAtomic(): boolean
  • Contains some atomic units

    Returns boolean

  • get hasCoarse(): boolean
  • Contains some coarse units

    Returns boolean

  • get hasCustomProperties(): boolean
  • Returns boolean

  • get hashCode(): number
  • Returns number

  • get inheritedPropertyData(): any
  • Property data of the parent structure if it exists, currentPropertyData otherwise.

    Returns any

  • get interUnitBonds(): InterUnitBonds
  • Returns InterUnitBonds

  • get isAtomic(): boolean
  • Contains only atomic units

    Returns boolean

  • get isCoarse(): boolean
  • Contains only coarse units

    Returns boolean

  • get isCoarseGrained(): boolean
  • True if any model the structure is based on is coarse grained.

    See

    Model.isCoarseGrained

    Returns boolean

  • get isEmpty(): boolean
  • Returns boolean

  • get label(): string
  • Returns string

  • get masterModel(): undefined | <internal>.Model
  • The master-model, other models can have bonds to it

    Returns undefined | <internal>.Model

  • get model(): <internal>.Model
  • If the structure is based on a single model or has a master-/representative-model, return it. Otherwise throw an exception.

    Returns <internal>.Model

  • get models(): readonly <internal>.Model[]
  • Returns readonly <internal>.Model[]

  • get parent(): undefined | <internal>.Structure
  • The root/top-most parent or undefined in case this is the root

    Returns undefined | <internal>.Structure

  • get polymerGapCount(): number
  • Count of all polymer gaps in the structure

    Returns number

  • get polymerResidueCount(): number
  • Count of all polymer residues in the structure

    Returns number

  • get polymerUnitCount(): number
  • Returns number

  • get representativeModel(): undefined | <internal>.Model
  • A representative model, e.g. the first model of a trajectory

    Returns undefined | <internal>.Model

  • get root(): <internal>.Structure
  • The parent or itself in case this is the root

    Returns <internal>.Structure

  • get serialMapping(): SerialMapping
  • Provides mapping for serial element indices accross all units.

    Note that this is especially costly for structures with many units that are grouped into few symmetry groups. Use only when needed and prefer StructureElement to address elements in a structure.

    Returns SerialMapping

  • get target(): <internal>.Structure
  • Get the proxy target. Usefull for equality checks.

    Returns <internal>.Structure

  • get transformHash(): number
  • Hash based on all unit.id values in the structure, reflecting the units transformation

    Returns number

  • get uniqueElementCount(): number
  • Returns number

  • get uniqueResidueNames(): Set<string>
  • Returns Set<string>

  • get unitSymmetryGroupsIndexMap(): IntMap<number>
  • Maps unit.id to index of SymmetryGroup in unitSymmetryGroups array

    Returns IntMap<number>

Methods

  • For structure with parent this returns a proxy that targets parent and has structure attached as a child.

    Returns <internal>.Structure

  • Parameters

    Returns number

Generated using TypeDoc