Class Operation

Index

Constructors

Properties

getAffectedIds getById getSite getUnaffected toReferenceToOperation

Constructors

constructor

new Operation(): Operation
Returns Operation

Properties

`Static` getAffectedIds

getAffectedIds: ((arState) => string[]) = getAffectedIds

Type declaration

- (arState): string[]
- get affected operations ids
  Parameters
  - arState: ARBaseState
  Returns string[]
  affected operations ids

`Static` getById

getById: ((operationId, arState) => AROperation) = getById

Type declaration

- (operationId, arState): AROperation
- get AROperation from operationId
  Parameters
  - operationId: string
  - arState: ARBaseState
  Returns AROperation

`Static` getSite

getSite: ((arState, operation) => ARSite) = getSite

Type declaration

- (arState, operation): ARSite
- get Site from given Operation (only for Collection/Delivery activities)
  Parameters
  - arState: ARBaseState
  - operation: AROperation
  Returns ARSite
  Origin Site for Collection Operation / destination Site for Delivery Operation

`Static` getUnaffected

getUnaffected: ((arState) => AROperation[]) = getUnaffected

Type declaration

- (arState): AROperation[]
- get unaffected operations
  Parameters
  - arState: ARBaseState
  Returns AROperation[]
  unaffected operations

`Static` toReferenceToOperation

toReferenceToOperation: ((operation) => ReferenceToOperation) = toReferenceToOperation

Type declaration

- (operation): ReferenceToOperation
- convert AROperation to ReferenceToOperation
  Parameters
  - operation: AROperation
  Returns ReferenceToOperation

Generated using TypeDoc