Methods (ISPAdapter3) - Integration - Update 46 - Help - Hexagon

SmartPlant Integration .NET Help

Language
English
Product
Integration
Search by Category
Help
SmartPlant Foundation / SDx Version
10
Smart P&ID Version
9 (2019)
Smart Engineering Manager Version
10 (2019)

GetObjectStatusInTool

Description

This method checks the status of an object in the design tool. This call is made to the design tool when an object is found to be missing from the published data, but was previously published or claimed. Such an object was either deleted, moved, unclaimed, or given a new ID (UID updated). The return value should be one of the following enumerations.

Public Enum ObjectStatusInTool As Integer

Deleted = 1,

Moved = 2,

Unclaimed = 3,

UIDUpdated = 4

End Enum

If the return value is Deleted, a tombstone will be generated. If the return value is Moved, the object will be added to a moved object collection. If the return value is Unclaimed, an unclaim instruction is generated, and the object will be added to the unclaimed object collection in SmartPlant Foundation.

If the return value is UIDUpdated, sObjNewUID must be returned with the new UID value of the object. For UIDUpdated status, an UpdateUIDInstruction is generated.

This method is also called when the existence of a moved object is checked.

Arguments

Name

Data type

Input/output

Description

sObjUID

String (maximum 128 characters)

Input

UID of the object.

sObjName

String (maximum 256 characters)

Input

Name of the object.

sClassUID

String (maximum 128 characters)

Input

UID of the class definition of the object.

sObjNewUID

String (maximum 128 characters)

Input

The new UID of the object. This value is returned only when the method return status is UIDUpdated.

Return Value

ObjectStatusInTool.

Comments

If the method fails, the tool will raise an error.

GetRelationshipStatusInTool As ObjectStatusInTool

Description

This method checks the status of a relationship object in the design tool. This call is made to the design tool when a relationship object is found to be missing from the published data, but was previously published or claimed. Such a relationship object is either deleted, moved, or unclaimed. The return value should be one of the first three of the following enumerations.

Public Enum ObjectStatusInTool As Integer

Deleted = 1,

Moved = 2,

Unclaimed = 3,

UIDUpdated = 4

End Enum

If the return value is Deleted, a tombstone will be generated. If the return value is Moved, the relationship object will be added to a moved object collection. If the return value is Unclaimed, an UnclaimedInstruction is generated and the relationship object will be added to an unclaimed object collection in SmartPlant Foundation.

If the return value is UIDUpdated, sObjNewUID must be returned with the new UID value of the object. For UIDUpdated status, an UpdateUIDInstruction is generated.

Arguments

Name

Data type

Input/output

Description

sRelUID

String (maximum 128 characters)

Input

UID of the relationship object.

sRelName

String (maximum 70 characters)

Input

Name of the relationship.

sRelDef

String (maximum 128 characters)

Input

UID of the class definition of the relationship object.

sUID1

String (maximum 128 characters)

Input

UID of the end1 object

sUID2

String (maximum 128 characters)

Input

UID of the end2 object

sObjNewUID

String (maximum 128 characters)

Output

The new UID of the relationship. This value is returned only when the method return status is UIDUpdated.

Return Value

ObjectStatusInTool.

Comments

If the method fails, the tool will raise an error.