Skip to content
Snippets Groups Projects
Commit bbad6f98 authored by Alexander Rose's avatar Alexander Rose
Browse files

some docs

parent c15a1bff
No related branches found
No related tags found
No related merge requests found
...@@ -18,10 +18,13 @@ namespace IntraUnitLinks { ...@@ -18,10 +18,13 @@ namespace IntraUnitLinks {
} }
class InterUnitBonds { class InterUnitBonds {
/** Number of inter-unit bonds */
readonly bondCount: number readonly bondCount: number
/** Array of inter-unit bonds */
readonly bonds: ReadonlyArray<InterUnitBonds.Bond> readonly bonds: ReadonlyArray<InterUnitBonds.Bond>
private readonly bondKeyIndex: Map<string, number> private readonly bondKeyIndex: Map<string, number>
/** Get an array of unit-pair-bonds that are linked to the given unit */
getLinkedUnits(unit: Unit): ReadonlyArray<InterUnitBonds.UnitPairBonds> { getLinkedUnits(unit: Unit): ReadonlyArray<InterUnitBonds.UnitPairBonds> {
if (!this.map.has(unit.id)) return emptyArray; if (!this.map.has(unit.id)) return emptyArray;
return this.map.get(unit.id)!; return this.map.get(unit.id)!;
...@@ -34,11 +37,13 @@ class InterUnitBonds { ...@@ -34,11 +37,13 @@ class InterUnitBonds {
return index !== undefined ? index : -1 return index !== undefined ? index : -1
} }
/** Get inter-unit bond given a pair of indices and units */
getBond(indexA: StructureElement.UnitIndex, unitA: Unit, indexB: StructureElement.UnitIndex, unitB: Unit): InterUnitBonds.Bond | undefined { getBond(indexA: StructureElement.UnitIndex, unitA: Unit, indexB: StructureElement.UnitIndex, unitB: Unit): InterUnitBonds.Bond | undefined {
const index = this.getBondIndex(indexA, unitA, indexB, unitB) const index = this.getBondIndex(indexA, unitA, indexB, unitB)
return index !== -1 ? this.bonds[index] : undefined return index !== -1 ? this.bonds[index] : undefined
} }
/** Get inter-unit bond given a link-location */
getBondFromLocation(l: Link.Location) { getBondFromLocation(l: Link.Location) {
return this.getBond(l.aIndex, l.aUnit, l.bIndex, l.bUnit); return this.getBond(l.aIndex, l.aUnit, l.bIndex, l.bUnit);
} }
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment