GetObjectDetails Method - SmartPlant Foundation - IM Update 44 - Customization & Programming - Hexagon

SmartPlant Foundation Customization

Language
English
Product
SmartPlant Foundation
Search by Category
Customization & Programming
SmartPlant Foundation / SDx Version
10

Finds a collection of objects and returns all the properties (attributes).

Inputs

  • ClassDef

  • Name – with wildcard criteria

  • IncludeHistorical – returns terminated items

  • MaxNumber – If the user knows there are only 3 rows and wants to only return them, then this is used to instruct the RDBMS to return that many rows, making the query much faster.

Dim lobjDownloadService As New DownloadService.DownloadSoapClient

Dim lobjResponse As DownloadService.XFRDataTransfer = lobjDownloadService.GetObjectDetails(lblSessionId.Text, lstrClassDef, lstrName, CheckBox1.Checked, CInt(MaxNumber.Value))

Outputs

Transfer object with all the attributes including those defined as simple, so this shows every attribute. Below is a query for DEVTag classdef with a criteria of 20%. Two objects have been returned with all their attributes.

<XFRDataTransfer Description="Count = 2 Criteria: ClassDef DEVTag Name 20% IncludeHistorical False MaxNumber 0" Source="GetObjectDetails">

<XFRConfiguration Plant="PlantA" xmlns="http://localhost/SPF40Server/" />

<XFRItems xmlns="http://localhost/SPF40Server/">

<XFRItem N="20CB200-PLA" C="DEVTag">

<XFRA V="99W000A" N="OBID" />

<XFRA V="SPF" N="DomainUID" />

<XFRA V="c2ada62f-8394-4c76-be5d-90118cce95bb" N="UID" />

<XFRA V="PL_PlantA" N="Config" />

<XFRA V="2010/01/29-18:12:00:177" N="CreationDate" />

<XFRA V="2010/01/29-18:12:00:208" N="LastUpdatedDate" />

<XFRA V="9999/12/31-23:59:59:999" N="TerminationDate" />

<XFRA V="superuser" N="CreationUser" />

<XFRA V="TG_20CB200-PLA_PlantA" N="UniqueKey" />

<XFRA V="" N="ContainerID" />

<XFRA V="False" N="DEVProp_EngOnly" />

<XFRA V="False" N="DEVProp_EngWriteOthersRead" />

<XFRA V="{239410D8-4DDC-41B2-9116-0F9856921CBE}:Electrical equipment" N="DEVTagCategory" />

<XFRA V="11~kg" N="DEVWeight" />

<XFRA V="20CB200-PLA" N="Description" />

<XFRA V="" N="DevUnitForTag" />

<XFRA V="20CB200-PLA" N="Name" />

<XFRA V="False" N="SPFClaimedToLowerConfig" />

<XFRA V="False" N="SPFIsClaimExclusive" />

<XFRA V="0" N="SPFNoOfClaims" />

</XFRItem>

<XFRItem N="20CB201-PLA" C="DEVTag">

<XFRA V="99X000A" N="OBID" />

<XFRA V="SPF" N="DomainUID" />

<XFRA V="b5308780-a7cf-44d1-b4c3-9aa1ddef497a" N="UID" />

<XFRA V="PL_PlantA" N="Config" />

<XFRA V="2010/01/29-18:12:08:913" N="CreationDate" />

<XFRA V="2010/01/29-18:12:08:929" N="LastUpdatedDate" />

<XFRA V="9999/12/31-23:59:59:999" N="TerminationDate" />

<XFRA V="superuser" N="CreationUser" />

<XFRA V="TG_20CB201-PLA_PlantA" N="UniqueKey" />

<XFRA V="" N="ContainerID" />

<XFRA V="False" N="DEVProp_EngOnly" />

<XFRA V="False" N="DEVProp_EngWriteOthersRead" />

<XFRA V="{239410D8-4DDC-41B2-9116-0F9856921CBE}:Electrical equipment" N="DEVTagCategory" />

<XFRA V="11~kg" N="DEVWeight" />

<XFRA V="20CB201-PLA" N="Description" />

<XFRA V="" N="DevUnitForTag" />

<XFRA V="20CB201-PLA" N="Name" />

<XFRA V="False" N="SPFClaimedToLowerConfig" />

<XFRA V="False" N="SPFIsClaimExclusive" />

<XFRA V="0" N="SPFNoOfClaims" />

</XFRItem>

</XFRItems>

</XFRDataTransfer>