{"id":5,"date":"2015-11-03T19:11:09","date_gmt":"2015-11-03T19:11:09","guid":{"rendered":"http:\/\/o-calcpro.com\/wiki\/?p=5"},"modified":"2015-11-18T16:41:26","modified_gmt":"2015-11-18T16:41:26","slug":"batch-pole-operations-in-scripts-and-plugins","status":"publish","type":"post","link":"http:\/\/o-calcpro.com\/wiki\/2015\/11\/03\/batch-pole-operations-in-scripts-and-plugins\/","title":{"rendered":"Batch Pole Operations in Scripts and Plugins"},"content":{"rendered":"

When creating O-Calc scripts and plugins it is often the case that the developer \/ user would like to be able to perform operations on a large number of poles in a batch operation, perhaps as an un-attended operation. The O-Calc scripting and plugins API provides a convenient way to allow this to be done while hiding the considerable complexity of managing the multiple calculation threads and processing various pole versions and LoadCases.<\/p>\n

In the following simple “hello world” type example is presented a script that opens all of the poles selected and displays the pole number in a message box:<\/p>\n

\n\n\t\t
\n\n\t\t
\n\t\t\t\t\t\t< View plain text<\/span> ><\/a>\n\t\t\t\t\t<\/div>\n\n\t\t
C#<\/div>\n\n\t\t\n\t\t
\n\n\t<\/div>\n\t\n\t
\n\t\t
  1. using<\/span> System<\/span>;<\/span><\/div><\/li>\n
  2. using<\/span> System.Collections.Generic<\/span>;<\/span><\/div><\/li>\n
  3. using<\/span> System.Diagnostics<\/span>;<\/span><\/div><\/li>\n
  4. using<\/span> System.Windows.Forms<\/span>;<\/span><\/div><\/li>\n
  5. using<\/span> PPL_Lib<\/span>;<\/span><\/div><\/li>\n
  6. public<\/span> class<\/span> Script<\/div><\/li>\n
  7. {<\/span><\/div><\/li>\n
  8.     PPLMain cPPLMain =<\/span> null<\/span>;<\/span><\/div><\/li>\n
  9.     public<\/span> void<\/span> Execute(<\/span>PPLMain pPPLMain)<\/span><\/div><\/li>\n
  10.     {<\/span><\/div><\/li>\n
  11.         cPPLMain =<\/span> pPPLMain;<\/span><\/div><\/li>\n
  12.         using<\/span> (<\/span>BatchPoleHelper helper =<\/span> new<\/span> BatchPoleHelper(<\/span>cPPLMain, "Batch Demo"<\/span>)<\/span>)<\/span><\/div><\/li>\n
  13.         {<\/span><\/div><\/li>\n
  14.             helper.<\/span>PoleReadyForBatchProcessing<\/span> +=<\/span> helper_PoleReadyForBatchProcessing;<\/span><\/div><\/li>\n
  15.             cPPLMain.<\/span>SetToolFormPosition<\/span>(<\/span>helper)<\/span>;<\/span><\/div><\/li>\n
  16.             helper.<\/span>ShowDialog<\/span>(<\/span>)<\/span>;<\/span><\/div><\/li>\n
  17.         }<\/span><\/div><\/li>\n
  18.     }<\/span><\/div><\/li>\n
  19.  <\/div><\/li>\n
  20.     void<\/span> helper_PoleReadyForBatchProcessing(<\/span>PPLPole pPole)<\/span><\/div><\/li>\n
  21.     {<\/span><\/div><\/li>\n
  22.         MessageBox.<\/span>Show<\/span>(<\/span>pPole.<\/span>DisplayedName<\/span>(<\/span>PPLElement.<\/span>DISPLAY_NAME_MODE<\/span>.<\/span>INVENTORY<\/span>)<\/span>)<\/span>;<\/span><\/div><\/li>\n
  23.     }<\/span><\/div><\/li>\n
  24. }<\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\n

    The important point to notice is that there are two basic steps.<\/p>\n

      \n
    1. Instantiate a BatchPoleHelper and show it<\/li>\n
    2. Catch the PoleReadyForBatchProcessing event<\/li>\n<\/ol>\n

      The PoleReadyForBatchProcessing event will be fired every time that a pole has been loaded, the correct LoadCase has been selected, and that the pole load calculation process has been successfully completed.<\/p>\n\"Facebook\"<\/a>\"twitter\"<\/a>\"linkedin\"<\/a>\"mail\"<\/a>","protected":false},"excerpt":{"rendered":"

      When creating O-Calc scripts and plugins it is often the case that the developer \/ user would like to be able to perform operations on a large number of poles in a batch operation, perhaps as an un-attended operation. The O-Calc scripting and plugins API provides a convenient way to allow this to be done ..<\/p>\n

      <\/div>\n

      Read more<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[2,3],"tags":[],"class_list":["post-5","post","type-post","status-publish","format-standard","hentry","category-plugin-development","category-scripting"],"_links":{"self":[{"href":"http:\/\/o-calcpro.com\/wiki\/wp-json\/wp\/v2\/posts\/5","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/o-calcpro.com\/wiki\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/o-calcpro.com\/wiki\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/o-calcpro.com\/wiki\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/o-calcpro.com\/wiki\/wp-json\/wp\/v2\/comments?post=5"}],"version-history":[{"count":5,"href":"http:\/\/o-calcpro.com\/wiki\/wp-json\/wp\/v2\/posts\/5\/revisions"}],"predecessor-version":[{"id":46,"href":"http:\/\/o-calcpro.com\/wiki\/wp-json\/wp\/v2\/posts\/5\/revisions\/46"}],"wp:attachment":[{"href":"http:\/\/o-calcpro.com\/wiki\/wp-json\/wp\/v2\/media?parent=5"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/o-calcpro.com\/wiki\/wp-json\/wp\/v2\/categories?post=5"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/o-calcpro.com\/wiki\/wp-json\/wp\/v2\/tags?post=5"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}