{"id":33694,"date":"2021-10-08T13:00:00","date_gmt":"2021-10-08T20:00:00","guid":{"rendered":"https:\/\/www.padtinc.com\/2021\/10\/08\/avoid-spiderwebs-with-direct-references-in-scripts\/"},"modified":"2022-04-19T14:20:53","modified_gmt":"2022-04-19T21:20:53","slug":"avoid-spiderwebs-with-direct-references-in-scripts","status":"publish","type":"post","link":"https:\/\/www.padtinc.com\/2021\/10\/08\/avoid-spiderwebs-with-direct-references-in-scripts\/","title":{"rendered":"Avoid Spiderwebs with Direct References in Scripts"},"content":{"rendered":"\n

Flownex Friday Tech Tips!<\/h2>\n\n\n\n

It’s officially Spooky Season! In between episodes of Squid Game and re-watching Hubie Halloween I thought I could make things a little less scary by demonstrating how to get rid of the spiderwebs in our projects (AKA Data Transfer Links). We use these often with scripts, which can be very powerful, but as our networks get more complex we may want to avoid the clutter\/attracting spiders.<\/p>\n\n\n\n

Quick Script vs Full Script<\/h2>\n\n\n\n

If we’re not scared of a little C# we may decide to start with a full script. I, personally, like to use a quick script so that I can use the table inputs to define my script inputs and results.<\/p>\n\n\n\n

\"\" <\/picture><\/figure><\/div>\n\n\n\n

Calling a Specific Component<\/h2>\n\n\n\n

We will identify the component we want to read\/write to by the unique Identifier<\/strong>. This can be found in the input properties for the component. In this example we’ll use a pipe component. By default this would typically be “Pipe – 0” or “Pipe” followed by some other integer. This field is editable so you can change it, but it must remain unique to that specific component.<\/p>\n\n\n\n

\"\" <\/picture><\/figure><\/div>\n\n\n\n

We can either specify the identifier as a string explicitly in the script:<\/p>\n\n\n\n

\/\/Referencing component \"Pipe - 0\"\nIPS.Core.Component Pipe = Project.GetComponent(\"Pipe - 0\");<\/code><\/pre>\n\n\n\n
Or we can have this as an text-type input to the script so that we can change the reference more easily. In this example we have a text variable “ComponentIdentifier”:<\/p>\n\n\n\n
\"\" <\/picture><\/figure>\n\n\n\n
\/\/Referencing component which is defined by input \"ComponentIdentifier\"\nIPS.Core.Component Pipe = Project.GetComponent(ComponentIdentifier.ToString());<\/code><\/pre>\n\n\n\n
Note that we are using the ToString <\/strong>function to convert our text variable to a string.<\/p>\n\n\n\n
Reading from Component<\/h2>\n\n\n\n
Now that we have our Pipe component referenced in the script we can read any of the results into our script via their display identifier using the following syntax:<\/p>\n\n\n\n
\/\/Reading from flow component\nIPS.Properties.Double T_1 = Pipe.GetPropertyFromFullDisplayName(\"{Flow Element Results,Generic}Total temperature\n\") as IPS.Properties.Double;\nPipe_Temp.Value = T_1;<\/code><\/pre>\n\n\n\n
Note that we must use a internal variable. in this case “T_1”, to read the temperature before we assign that to the value of our script result “Pipe_Temp”. <\/p>\n\n\n\n
A quick trick to determine the display name is to right-click on the result you’re interested in and select “Copy display identifiers to clipboard”.<\/p>\n\n\n\n
\"\" <\/picture><\/figure><\/div>\n\n\n\n
Writing to Component<\/h2>\n\n\n\n
The process of modifying a component input with values from the script is very similar. We can use the above trick on our Inputs for the component to find the display identifier for the pipe diameter in this example.<\/p>\n\n\n\n
\/\/Write to component\nIPS.Properties.Double diameter = Pipe.GetPropertyFromFullDisplayName(\"{Geometry,Inlet}Diameter\") as IPS.Properties.Double;\ndiameter.Value = Pipe_Diameter;\n<\/code><\/pre>\n\n\n\n
Summary<\/h2>\n\n\n\n
Here is how we’ve set up the quick script, as you can see it is really not that scary:<\/p>\n\n\n\n
\"\" <\/picture><\/figure>\n\n\n\n
And the snippet of code from the quick script:<\/p>\n\n\n\n
\/\/Identify Component\nIPS.Core.Component Pipe = Project.GetComponent(ComponentIdentifier.ToString()); \n\n\/\/Read from component\nIPS.Properties.Double T_1 = Pipe.GetPropertyFromFullDisplayName(\"{Flow Element Results,Generic}Total temperature\") as IPS.Properties.Double;\nPipe_Temp.Value = T_1;\n\n\/\/Write to component\nIPS.Properties.Double diameter = Pipe.GetPropertyFromFullDisplayName(\"{Geometry,Inlet}Diameter\") as IPS.Properties.Double;\ndiameter.Value = Pipe_Diameter;<\/code><\/pre>\n\n\n\n
Happy Friday and Happy Coding! <\/p>\n","protected":false},"excerpt":{"rendered":"
It’s officially Spooky Season! In between episodes of Squid Game and re-watching Hubie Halloween I thought I could make things a little less scary by demonstrating how to get rid of the spiderwebs in our projects (AKA Data Transfer Links). We use these often with scripts, which can be very powerful, but as our networks get more complex we may want to avoid the clutter\/attracting spiders.<\/p>\n","protected":false},"author":26,"featured_media":33700,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[2533],"tags":[500,2756],"post-podcast":[],"_links":{"self":[{"href":"https:\/\/www.padtinc.com\/wp-json\/wp\/v2\/posts\/33694"}],"collection":[{"href":"https:\/\/www.padtinc.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.padtinc.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.padtinc.com\/wp-json\/wp\/v2\/users\/26"}],"replies":[{"embeddable":true,"href":"https:\/\/www.padtinc.com\/wp-json\/wp\/v2\/comments?post=33694"}],"version-history":[{"count":0,"href":"https:\/\/www.padtinc.com\/wp-json\/wp\/v2\/posts\/33694\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.padtinc.com\/wp-json\/wp\/v2\/media\/33700"}],"wp:attachment":[{"href":"https:\/\/www.padtinc.com\/wp-json\/wp\/v2\/media?parent=33694"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.padtinc.com\/wp-json\/wp\/v2\/categories?post=33694"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.padtinc.com\/wp-json\/wp\/v2\/tags?post=33694"},{"taxonomy":"post-podcast","embeddable":true,"href":"https:\/\/www.padtinc.com\/wp-json\/wp\/v2\/post-podcast?post=33694"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}