Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InspectionPlanCollection

Describes a set of inspection plan items. It offers a wide range of functions to improve its accessibility. You can iterate over the collection like the following:

const inspectionPlanCollection = piweb.data.getInspectionPlanCollection();
for (let item of inspectionPlanCollection)
{
    ...
}

Hierarchy

  • InspectionPlanCollection

Implements

Index

Constructors

Private constructor

Accessors

length

  • get length(): number
  • Gets the total number of items stored in the collection.

    Returns number

Methods

Private __@iterator

findByEntity

  • Returns the inspection plan item that associated to the the specified entity or undefined if the collection contains no such inspection plan item. The following associations are assumed:

    Entity Association
    Measurement The part to which the measurement is attached
    MeasurementValue The characteristic to which the measurement value is attached
    RawDataItem The part or characteristic to which the raw data is attached

    Parameters

    Returns InspectionPlanItem

findByPath

  • Returns the inspection plan item that is identified by the specified path or undefined if the collection contains no such inspection plan item.

    Parameters

    • path: string

      An inspection plan path.

    Returns InspectionPlanItem

findChildren

  • Returns the child items of the specified inspection plan item or. Please be aware that only those children are returned, that are included in the binding of the element.

    Parameters

    Returns Iter<InspectionPlanItem>

findParent

  • Returns the parent item of the specified inspection plan item or undefined if the item has no parent, or the collection doesn't contain it.

    Parameters

    Returns InspectionPlanItem

findParentPart

  • Returns the parent part of the specified inspection plan item or undefined if the item has no parent, or the collection doesn't contain it.

    Parameters

    Returns InspectionPlanItem

Private first

getCharacteristics

  • Returns an iterator over all characteristics stored in the collection.

    Returns Iter<InspectionPlanItem>

getParts

  • Returns an iterator over all parts stored in the collection.

    Returns Iter<InspectionPlanItem>

iter

  • Returns an iter over all inspection plan items.

    Returns Iter<InspectionPlanItem>

Generated using TypeDoc