DELMPPositionKWFunctionPackage Functions

This section describes the functions of the DELMPPositionKWFunctionPackage.

Note: The "manufactured item" objects described in this document were known as "process" objects in previous releases. The term "process" is still used in the names of functions, types, methods, attributes, and so on. In this case, "process" now means "manufactured item".

This page discusses:

AddRelativeResourcePosition

Adds a relative resource position.

Signature

 MyOperationOrSystem.AddRelativeResourcePosition(MyResourceOcc,lAbsolutePosition,MyReferentialOcc,eReferentialType,eApplicability,sPosture) : Integer

Arguments

Name Input or Output Required Type Comment
MyOperationOrSystem In ProdSystemOccurrence System or operation occurrence.
MyResourceOcc In ResourceOccurrence The resource that has to be positioned. This resource must implement the operation or the system (directly or indirectly).
lAbsolutePosition In List Relative position of the resource to be positioned.

This list should contain twelve reals: the first nine reals represent a 3x3 rotation matrix, the last three reals represent translation coordinates.
MyReferentialOcc In ObjectType Referential to be used for this resource.

It can be either:

  • the implemented item (in this case, ObjectType is MfgProcessOccurrence)
  • an assigned resource (in this case, ObjectType is ResourceOccurrence)
  • NULL.
eReferentialType In ResourcePositionReferential Referential type to be used for this resource.

The following values are valid:

  • BuildUp
  • ImplementedManufacturedItem
  • Layout
  • UserDefined
  • FromPrevious.
eApplicability In ResourcePositionApplicability Applicability to apply to the resource.

The following values are valid:

  • Operation
  • System.
sPosture In String Posture or home position to apply to the positioned resource. The value must exit on the positioned resource.

ReturnType

Integer

Return values:

  • 0: the position for the resource occurrence is successfully defined on the operation/system.
  • 1: unexpected failure.
  • 2: an inconsistency is detected and the position is rejected.

Example

let MyOperationOrSystem(ProdSystemOccurrence)
let MyResourceOcc(ResourceOccurrence)
let lRelativePosition(List)
let MyReferentialOcc(ResourceOccurrence)
let eReferentialType(ResourcePositionReferential)
let eApplicability(ResourcePositionApplicability)
let sPosture(String)
let iResult(Integer)
eReferentialType = "UserDefined"
eApplicability = "Operation"
sPosture = "Stand Relax"
lRelativePosition = List(1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 1000.0)
// MyOperationOrSystem, MyResourceOcc, and MyReferentialOcc are needed to be valuated before using this API
iResult = MyOperationOrSystem.AddRelativeResourcePosition(MyResourceOcc,lRelativePosition,MyReferentialOcc,eReferentialType,eApplicability,sPosture)
eReferentialType = "BuildUp"
eApplicability = "System"
// sPosture is optional
iResult = MyOperationOrSystem.AddRelativeResourcePosition(MyResourceOcc,lRelativePosition,NULL,eReferentialType,eApplicability)

AddResourcePosition

Adds an absolute resource position.

Signature

MyOperationOrSystem.AddResourcePosition(MyResourceOcc,lAbsolutePosition,MyReferentialOcc,eReferentialType,eApplicability,sPosture)

Arguments

Name Input or Output Required Type Comment
MyOperationOrSystem In ProdSystemOccurrence System or operation occurrence.
MyResourceOcc In ResourceOccurrence The resource that has to be positioned. This resource must implement the operation or the system (directly or indirectly).
lAbsolutePosition In List Absolute position of the resource to be positioned.

This list should contain twelve reals: the first nine reals represent a 3x3 rotation matrix, the last three reals represent translation coordinates.
MyReferentialOcc In ObjectType Referential to be used for this resource.

It can be either:

  • the implemented item (in this case, ObjectType is MfgProcessOccurrence)
  • an assigned resource (in this case, ObjectType is ResourceOccurrence)
  • NULL.
eReferentialType In ResourcePositionReferential Referential type to be used for this resource.

The following values are valid:

  • BuildUp
  • ImplementedManufacturedItem
  • Layout
  • UserDefined
  • FromPrevious.
eApplicability In ResourcePositionApplicability Applicability to apply to the resource.

The following values are valid:

  • Operation
  • System.
sPosture In String Posture or home position to apply to the positioned resource. The value must exit on the positioned resource.

ReturnType

Integer

Return values:

  • 0: the position for the resource occurrence is successfully set on the operation/system.
  • 1: unexpected failure.
  • 2: an inconsistency is detected and the position is rejected.

Example

let MyOperationOrSystem(ProdSystemOccurrence)
let MyResourceOcc(ResourceOccurrence)
let lAbsolutePosition(List)
let MyReferentialOcc(ResourceOccurrence)
let eReferentialType(ResourcePositionReferential)
let eApplicability(ResourcePositionApplicability)
let sPosture(String)
let iResult(Integer)
eReferentialType = "UserDefined"
eApplicability = "Operation"
sPosture = "Stand Relax"
lAbsolutePosition = List(1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 1000.0)
// MyOperationOrSystem, MyResourceOcc, and MyReferentialOcc are needed to be valuated before using this API
iResult = MyOperationOrSystem.AddResourcePosition(MyResourceOcc,lAbsolutePosition,MyReferentialOcc,eReferentialType,eApplicability,sPosture)
eReferentialType = "BuildUp"
eApplicability = "System"
// sPosture is optional
iResult = MyOperationOrSystem.AddResourcePosition(MyResourceOcc,lAbsolutePosition,NULL,eReferentialType,eApplicability)

GetAllPositionedResources

Retrieves the list of resources that are positioned on an operation/system, and their corresponding values. The positions are absolute.

Signature

 MyOperationOrSystem.GetAllPositionedResources(ListResourceOccs,ListAbsolutePositions,ListReferentialOccs,ListReferentialTypes,ListApplicabilites,PostureNameList) : Integer

Arguments

Name Input or Output Required Type Comment
MyOperationOrSystem In ProdSystemOccurrence System or operation occurrence.
ListResourceOccs Out ResourceOccurrence List of positioned resource occurrences.
Warning: The output lists are cleaned before treatment.
ListAbsolutePositions Out List List of absolute positions.

Each item in this list is also a list containing twelve reals: the first nine reals represent a 3x3 rotation matrix, the last three reals represent translation coordinates.
ListReferentialOccs Out List List of user defined referential occurrences (resource, item, or null).
ListReferentialTypes Out List List of referential types.

Each item is a ResourcePositionReferential.
ListApplicabilites Out List List of applicabilty types. Each item is a ResourcePositionApplicability.
PostureNameList Out List List of posture or home position names applied to each positioned resource.

ReturnType

Integer

Return values:

  • 0: the resource position lists (empty or filled) are successfully returned.
  • 1: the operation/system is not valid.
  • 2: there is an unexpected failure.

Example

let MyOperationOrSystem(ProdSystemOccurrence)
let ListResourceOccs(List)
let ListAbsolutePositions(List)
let ListReferentialOccs(List)
let ListReferentialTypes(List)
let ListApplicabilites(List)
let ListPostures(List)
let iResult(Integer)
// MyOperationOrSystem is needed to be valuated before using this API
// ListPostures is optional
iResult = MyOperationOrSystem.GetAllPositionedResources(ListResourceOccs,ListAbsolutePositions,ListReferentialOccs,ListReferentialTypes,ListApplicabilites,ListPostures)

GetAllRelativeResourcePositions

Retrieves the list of resources that are positioned on an operation/system and their corresponding values. Positions are relative.

Signature

MyOperationOrSystem. GetAllRelativeResourcePositions(ListResourceOccs,ListRelativePositions,ListReferentialOccs,ListReferentialTypes,ListApplicabilites,PostureNameList) : Integer

Arguments

Name Input or Output Required Type Comment
MyOperationOrSystem In ProdSystemOccurrence System or operation occurrence.
ListResourceOccs Out ResourceOccurrence List of positioned resource occurrences.
Warning: The output lists are cleaned before treatment.
ListRelativePositions Out List List of relative positions.

Each item in this list is also a list containing twelve reals: the first nine reals represent a 3x3 rotation matrix, the last three reals represent translation coordinates.
ListReferentialOccs In List List of user defined referential occurrences (resource, item, or null).
ListReferentialTypes Out List List of referential types. Each item is a ResourcePositionReferential.
ListApplicabilites Out List List of applicability types. Each item is a ResourcePositionApplicability.
PostureNameList Out List List of posture or home position names applied to each positioned resource.

ReturnType

Integer

Return values:

  • 0: the resource position lists (empty or filled) are successfully returned.
  • 1: the operation/system is not valid.
  • 2: there is an unexpected failure.

Example

let MyOperationOrSystem(ProdSystemOccurrence)
let ListResourceOccs(List)
let ListRelativePositions(List)
let ListReferentialOccs(List)
let ListReferentialTypes(List)
let ListApplicabilites(List)
let ListPostures(List)
let iResult(Integer)
// MyOperationOrSystem is needed to be valuated before using this API
// ListPostures is optional
iResult = MyOperationOrSystem.GetAllRelativeResourcePositions(ListResourceOccs,ListRelativePositions,ListReferentialOccs,ListReferentialTypes,ListApplicabilites,ListPostures)

GetBuildupRelativePosition

Retrieves a system or operation's position for the buildup and the referential assigned resource.

Signature

MySysOperation.GetBuildupRelativePosition(ReferentialResourecOcc,RelativeTransformation) : Integer

Arguments

Name Input or Output Required Type Comment
MySysOperation In ProdSystemOccurrence System or operation occurrence.
ReferentialResourecOcc Out ResourceOccurrence Resource occurrence assigned to the system or operation the position is relative to.
RelativeTransformation Out List Position of root product relative to the resource occurrence.

This list contains twelve reals: the first nine reals represent a 3x3 rotation matrix, the last three reals represent translation coordinates.

Warning: The output lists are cleaned before treatment.

ReturnType

Integer

Return values:

  • 0: the position is successfully set.
  • 1: unexpected failure.
  • 4: no position is defined for this system or operation.

Example

let MySystemOperation(ProdSystemOccurrence)
let ReferentialOcc (ResourceOccurrence)
let lRelativePosition(List)
let iResult(Integer)

// MySystemOperation
iResult = MySystemOperation.GetBuildupRelativePosition(ReferentialOcc,lRelativePosition)

GetPositionedManufacturedItems

Retrieves manufactured items for which position is set on the specified operation.

Signature

MyOperation.GetPositionedManufacturedItems(lManufacturedItems)

Arguments

Name Input or Output Required Type Comment
MyOperation In ProdSystemOccurrence -
lManufacturedItems In List -

Example

let MyOperation(ProdSystemOccurrence)
let lManufacturedItems(List)
// MyOperation is needed to be valuated before using this API
iResult = MyOperation.GetPositionedManufacturedItems(lManufacturedItems)

GetRelativePositionForManufacturedItems

Retrieves manufactured items for which relative position is set on the specified operation.

Signature

MyOperation.GetRelativePositionForManufacturedItems(lManufacturedItemOcc,lRelativePosition)

Arguments

Name Input or Output Required Type Comment
MyOperation In ProdSystemOccurrence -
lManufacturedItems In List -
lRelativePosition In List -

Example

let MyOperation(ProdSystemOccurrence)
let lManufacturedItemOcc(List)
let lRelativePosition(List)
// MyOperation is needed to be valuated before using this API
iResult = MyOperation.GetRelativePositionForManufacturedItems(lManufacturedItemOcc,lRelativePosition)

RemoveAllPartPositions

Removes all manufactured items and corresponding positions set on this operation occurrence.

Signature

MyOperation.RemoveAllPartPositions()

Arguments

Name Input or Output Required Type Comment
MyOperation In ProdSystemOccurrence -

Example

let MyOperation(ProdSystemOccurrence)
// MyOperation is needed to be valuated before using this API
iResult = MyOperation.RemoveAllPartPositions()

RemoveAllResourcePositions

Removes all resource positions defined on the specified operation/system.

Signature

 MyOperationOrSystem.RemoveAllResourcePositions() : Integer

Arguments

Name Input or Output Required Type Comment
MyOperationOrSystem In ProdSystemOccurrence -

ReturnType

Integer

Return values:

  • 0: the resource positions defined on the operation/system are successfully removed.
  • 1: unexpected failure.
  • 4: false. There is no position to remove.

Example

let MyOperationOrSystem(ProdSystemOccurrence)
let iResult(Integer)
// MyOperationOrSystem is needed to be valuated before using this API
iResult = MyOperationOrSystem.RemoveAllResourcePositions()

RemoveBuildupRelativePosition

Removes the buildup position defined on this operation/system.

Signature

MySysOperation.RemoveBuildupRelativePosition() : Integer

Arguments

Name Input or Output Required Type Comment
MySysOperation In ProdSystemOccurrence System or operation occurrence.

ReturnType

Integer

Return values:

  • 0: the buildup position defined on the operation/system is successfully removed.
  • 1: unexpected failure.
  • 4: false. There is no position to remove.

Example

let MySystemOperation(ProdSystemOccurrence)
let iResult(Integer)

// MySystemOperation
iResult = MySystemOperation. RemoveBuildupRelativePosition ()

RemovePositionForManufacturedItems

Removes positions for the specified manufactured items

Signature

MyOperation.RemovePositionedForManufacturedItems(lManufacturedItems)

Arguments

Name Input or Output Required Type Comment
MyOperation In ProdSystemOccurrence -
lManufacturedItems In List -

Example

let MyOperation(ProdSystemOccurrence)
let lManufacturedItems(List)
// MyOperation and lManufacturedItems are needed to be valuated before using this API
iResult = MyOperation.RemovePositionForManufacturedItems(lManufacturedItems)

RemoveResourcePosition

Removes a single resource position.

Signature

MyOperationOrSystem.RemoveResourcePosition(MyResourceOcc)

Arguments

Name Input or Output Required Type Comment
MyOperationOrSystem In ProdSystemOccurrence -
MyResourceOcc In ResourceOccurrence -

Example

let MyOperationOrSystem(ProdSystemOccurrence)
let MyResourceOcc(ResourceOccurrence)
let iResult(Integer)
// MyOperationOrSystem and MyResourceOcc are needed to be valuated before using this API
iResult = MyOperationOrSystem.RemoveResourcePosition(MyResourceOcc)

SetBuildupRelativePosition

For a system or an operation, set or replace the position for the buildup relative to an assigned resource.

Signature

MySysOperation.SetBuildupRelativePosition(ReferentialResourecOcc,RelativeTransformation) : Integer

Arguments

Name Input or Output Required Type Comment
MySysOperation In ProdSystemOccurrence System or operation occurrence.
ReferentialResourecOcc In ResourceOccurrence Resource occurrence assigned to the system or operation the position is relative to.
RelativeTransformation In List Position of root product relative to the resource occurrence.

This list contains twelve reals: the first nine reals represent a 3x3 rotation matrix, the last three reals represent translation coordinates.

ReturnType

Integer

Return values:

  • 0: the position is successfully set or replaced.
  • 1: wrong argument, the resource is not assigned to the system or operation. The position is not set or replaced.

Example

let MySystemOperation(ProdSystemOccurrence)
let MyReferentialOcc(ResourceOccurrence)
let lRelativePosition(List)
let iResult(Integer)

lRelativePosition = List(1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 1000.0)

// MySystemOperation and  MyReferentialOcc needed to be valuated before using this API
iResult = MySystemOperation.SetBuildupRelativePosition(MyReferentialOcc,lRelativePosition)

SetRelativePositionForManufacturedItems

Sets position for the specified manufactured item.

Signature

MyOperation.SetRelativePositionForManufacturedItems(lManufacturedItemOcc,lRelativePosition)

Arguments

Name Input or Output Required Type Comment
MyOperation In ProdSystemOccurrence -
lManufacturedItemOcc In List -
lRelativePosition In List -

Example

let MyOperation(ProdSystemOccurrence)
let lManufacturedItemOcc(List)
let lRelativePosition(List)
let iResult(Integer)
lRelativePosition = List(1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 1000.0)
// MyOperation and lManufacturedItemOcc are needed to be valuated before using this API
iResult = MyOperation.SetRelativePositionForManufacturedItems(lManufacturedItemOcc,lRelativePosition)