GetObjectStatiInTool
This method is similar to GetObjectStatusInTool but uses an array for greater efficiency when Schema Component needs to get the statuses of more than one object.
Each call that Schema Component makes to GetObjectStatiInTool will identify the number of objects (iNoObjs) and the UID for the class definition (sClassUID) that applies to all of the missing objects for that method call. Schema Component passes the UIDs and names of the missing objects for that class in the zero-based arrays sObjUIDs and sObjNames. The publishing tool’s SmartPlant adapter should return the object status for each of these objects in the eObjectStati array. If any of the objects have been given new UIDs, then the SmartPlant Adapter should return the new UID(s) in the appropriate position(s) in the sNewUIDs array.
Schema Component will pass all the missing objects for the same class in one call to the publishing tools’ SmartPlant adapter. Therefore, Schema Component will make as many calls to this method as there are different classes that have one or more missing objects.
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
lNoObjs |
Integer |
Input |
Quantity of missing objects for which this method requests statuses. Set by Schema Component. |
|
sClassUID |
String |
Input |
Class that applies to all of the objects for which this method requests statuses. Set by Schema Component. |
|
sObjUIDs |
String array |
Input |
Zero-based array of UIDs for each of the objects for which this method requests the status. Set by Schema Component. |
|
sObjNames |
String array |
Input |
Zero-based array of names for each of the objects for which this method requests the status. Set by Schema Component. |
|
eObjectStati |
SmartPlantInterfaces.ObjectStatusInTool array |
Input |
Zero-based array comprising each object status that corresponds to each missing object. Set by the publishing tool’s SmartPlant adapter. |
|
sNewUIDs |
String array |
Input |
Zero-based array of new UIDs for objects. Only set if missing object has a new UID. Set by the publishing tool’s SmartPlant adapter. |
Comments
If an adapter does not support the ISPAdapterArray interface, then the GetObjectStatusInTool and GetRelationshipStatusInTool methods are called for each missing object and relationship.
GetRelationshipStatiInTool
This method is similar to GetRelationshipStatusInTool but uses an array for greater efficiency when Schema Component needs to get the statuses of more than one relationship.
Each call that Schema Component makes to GetRelationshipStatiInTool will identify the number of relationships (iNoRels) and the relationship definition (sRelDef) for each of the missing relationships. For each missing relationship, Schema Component passes the UID of that relationship, the UID of the object at end 1, and the UID of the object at end 2 in the zero-based arrays sRelUIDs, sUID1s, and sUID2s. The publishing tool’s SmartPlant adapter should return the status for each of these missing relationships in the zero-based eObjectStati array.
Schema Component will pass all the missing relationships of the same type (sRelDef) in one call to the publishing tools’ SP adapter. Therefore, Schema Component will make as many calls to this method as there are different relationship definitions that have one or more missing relationships.
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
lNoRels |
Integer |
Input |
Quantity of missing relationships for which this method requests statuses. Set by Schema Component. |
|
sRelDef |
String |
Input |
Relationship definition that applies to all of the relationships for which this method requests statuses. Set by Schema Component. |
|
sRelUIDs |
String array |
Input |
Zero-based array of UIDs for each of the relationships for which this method requests the status. Set by Schema Component. |
|
sUID1s |
String array |
Input |
Zero-based array of end 1 UIDs for each of the relationships for which this method requests the status. Set by Schema Component. |
|
sUID2s |
String array |
Input |
Zero-based array of end 2 UIDs for each of the relationships for which this method requests the status. Set by Schema Component. |
|
eObjectStati |
SmartPlantInterfaces.ObjectStatusInTool array |
Input |
Zero-based array comprising each status that corresponds to each missing relationship. Set by the publishing tool’s SmartPlant adapter. |
Comments
If an adapter does not support the ISPAdapterArray interface, then the GetObjectStatusInTool and GetRelationshipStatusInTool methods are called for each missing object and relationship.