{"id":51,"date":"2015-11-18T21:48:54","date_gmt":"2015-11-18T21:48:54","guid":{"rendered":"http:\/\/o-calcpro.com\/wiki\/?p=51"},"modified":"2015-11-30T16:51:46","modified_gmt":"2015-11-30T16:51:46","slug":"o-calc-pro-report-my-first-report","status":"publish","type":"post","link":"http:\/\/o-calcpro.com\/wiki\/2015\/11\/18\/o-calc-pro-report-my-first-report\/","title":{"rendered":"O-Calc Pro Report – “My First Report”"},"content":{"rendered":"

The default O-Calc Pro Report <\/em><\/strong>template will create a simple report with default header and a single table of pole capacity utilization values.\u00a0 Below are some explanations of the various code components of this simple report example.<\/p>\n

Defining the Report Format, Fonts, and Colors:<\/h3>\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. public<\/span> static<\/span> class<\/span> ReportFont<\/div><\/li>\n
  2. {<\/span><\/div><\/li>\n
  3. public<\/span> static<\/span> double<\/span> cPageWidth =<\/span> 6.25<\/span>;<\/span><\/div><\/li>\n
  4. public<\/span> static<\/span> string<\/span> cFontName =<\/span> "Arial"<\/span>;<\/span><\/div><\/li>\n
  5. public<\/span> static<\/span> MD.<\/span>Unit<\/span> cFontSizeLarge =<\/span> MD.<\/span>Unit<\/span>.<\/span>FromPoint<\/span>(<\/span>9.75<\/span>)<\/span>;<\/span><\/div><\/li>\n
  6. public<\/span> static<\/span> MD.<\/span>Unit<\/span> cFontSizeSmall =<\/span> MD.<\/span>Unit<\/span>.<\/span>FromPoint<\/span>(<\/span>7.85<\/span>)<\/span>;<\/span><\/div><\/li>\n
  7. }<\/span><\/div><\/li>\n
  8.  <\/div><\/li>\n
  9. public<\/span> partial<\/span> class<\/span> Report :<\/span> PPL_Lib.<\/span>ReportTemplate<\/span><\/div><\/li>\n
  10. {<\/span><\/div><\/li>\n
  11.  <\/div><\/li>\n
  12. \/\/globally defined colors and fonts<\/span><\/div><\/li>\n
  13. MD.<\/span>Color<\/span> Yellow =<\/span> MD.<\/span>Colors<\/span>.<\/span>LightYellow<\/span>;<\/span><\/div><\/li>\n
  14. MD.<\/span>Color<\/span> White =<\/span> MD.<\/span>Colors<\/span>.<\/span>White<\/span>;<\/span><\/div><\/li>\n
  15. MD.<\/span>ParagraphAlignment<\/span> JustifyRight =<\/span> MD.<\/span>ParagraphAlignment<\/span>.<\/span>Right<\/span>;<\/span><\/div><\/li>\n
  16. MD.<\/span>ParagraphAlignment<\/span> JustifyLeft =<\/span> MD.<\/span>ParagraphAlignment<\/span>.<\/span>Left<\/span>;<\/span><\/div><\/li>\n
  17. MD.<\/span>ParagraphAlignment<\/span> JustifyCenter =<\/span> MD.<\/span>ParagraphAlignment<\/span>.<\/span>Center<\/span>;<\/span><\/div><\/li>\n
  18. MD.<\/span>Font<\/span> SmallFont =<\/span> new<\/span> MD.<\/span>Font<\/span>(<\/span>ReportFont.<\/span>cFontName<\/span>, ReportFont.<\/span>cFontSizeSmall<\/span>)<\/span>;<\/span><\/div><\/li>\n
  19. MD.<\/span>Font<\/span> StandardFont =<\/span> new<\/span> MD.<\/span>Font<\/span>(<\/span>ReportFont.<\/span>cFontName<\/span>, ReportFont.<\/span>cFontSizeLarge<\/span>)<\/span>;<\/span><\/div><\/li>\n
  20. FontModifier Bold =<\/span> new<\/span> FontModifier(<\/span>true<\/span>, false<\/span>, false<\/span>)<\/span>;<\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\n

    This font, color, and paragraph parameters will be used in the main body of the report. These parameters do not define the header section of the report.<\/p>\n

    Define the Name (or Names) of the Report(s):<\/h3>\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. \/\/implement more than one additional report subtype (total will be this number plus the master)<\/span><\/div><\/li>\n
    2. public<\/span> override<\/span> int<\/span> SubtypesCount {<\/span> get<\/span> {<\/span> return<\/span> 0<\/span>;<\/span> }<\/span> }<\/span><\/div><\/li>\n
    3.  <\/div><\/li>\n
    4. public<\/span> override<\/span> REPORT_TYPE Type {<\/span> get<\/span> {<\/span> return<\/span> REPORT_TYPE.<\/span>INTEGRATED<\/span>;<\/span> }<\/span> }<\/span><\/div><\/li>\n
    5. public<\/span> override<\/span> String<\/span> Name {<\/span> get<\/span> {<\/span> return<\/span> "My First Report"<\/span>;<\/span> }<\/span> }<\/span><\/div><\/li>\n
    6. public<\/span> override<\/span> String<\/span> Description {<\/span> get<\/span> {<\/span> return<\/span> Name;<\/span> }<\/span> }<\/span><\/div><\/li>\n
    7.  <\/div><\/li>\n
    8. \/\/make sure to implement ToString to show report name<\/span><\/div><\/li>\n
    9. public<\/span> override<\/span> String<\/span> ToString(<\/span>)<\/span> {<\/span> return<\/span> Name;<\/span> }<\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\n

      If you are defining more than one report time, change the SubtypesCount and create a separate name for each subtype.\u00a0 In this example, a single report with the name \u201cMy First Report\u201d is being created.<\/p>\n

      Define the structure type that is applicable for the report:<\/h3>\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. \/\/determine if this report is applicable for a structure<\/span><\/div><\/li>\n
      2. public<\/span> override<\/span> bool<\/span> IsApplicable(<\/span>PPLMain pPPLMain, PPLPole pPole)<\/span><\/div><\/li>\n
      3. {<\/span><\/div><\/li>\n
      4. if<\/span> (<\/span>Filtered)<\/span> return<\/span> false<\/span>;<\/span><\/div><\/li>\n
      5. if<\/span> (<\/span>pPole is<\/span> PPLWoodPole)<\/span><\/div><\/li>\n
      6. {<\/span><\/div><\/li>\n
      7. return<\/span> true<\/span>;<\/span><\/div><\/li>\n
      8. }<\/span><\/div><\/li>\n
      9. return<\/span> false<\/span>;<\/span><\/div><\/li>\n
      10. }<\/span><\/div><\/li>\n
      11. public<\/span> override<\/span> bool<\/span> IsApplicableForType(<\/span>PPLMain.<\/span>POLE_TYPE<\/span> pType)<\/span><\/div><\/li>\n
      12. {<\/span><\/div><\/li>\n
      13. if<\/span> (<\/span>Filtered)<\/span> return<\/span> false<\/span>;<\/span><\/div><\/li>\n
      14. return<\/span> (<\/span>pType ==<\/span> PPLMain.<\/span>POLE_TYPE<\/span>.<\/span>WOOD<\/span>)<\/span>;<\/span><\/div><\/li>\n
      15. }<\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\n

        This section of the report will enable the user to determine what structure type this report will run on.\u00a0 Structure types include WOOD, STEEL, COMPOSITE, CONCRETE, SEGMENTED, MULTI-POLE, and\/or LATTICE.\u00a0 In the example code above, this report will show up in the O-Calc Pro interface as an applicable report only for pole type of WOOD.<\/p>\n

        Add the Pole and format the Report as Desired<\/h3>\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. public<\/span> override<\/span> void<\/span> AddPole(<\/span>PPLPole pPole, String<\/span> pPoleName)<\/span><\/div><\/li>\n
        2. {<\/span><\/div><\/li>\n
        3. String<\/span> pplx =<\/span> cPPLMain.<\/span>ReportingLoadedPolePath<\/span>;<\/span><\/div><\/li>\n
        4. try<\/span><\/div><\/li>\n
        5. {<\/span><\/div><\/li>\n
        6. pplx =<\/span> System.IO<\/span><\/span>.<\/span>Path<\/span>.<\/span>GetFileName<\/span>(<\/span>pplx)<\/span>;<\/span><\/div><\/li>\n
        7. }<\/span><\/div><\/li>\n
        8. catch<\/span> {<\/span> }<\/span><\/div><\/li>\n
        9.  <\/div><\/li>\n
        10. PoleLoadInfo poleInfoMaster =<\/span> cPPLMain.<\/span>CurrentPoleLoadInfo<\/span>;<\/span><\/div><\/li>\n
        11. ReportItems reportItems =<\/span> new<\/span> ReportItems(<\/span>poleInfoMaster, cPPLMain, pplx)<\/span>;<\/span><\/div><\/li>\n
        12. ReportItems.<\/span>ReportParameters<\/span> RP =<\/span> reportItems.<\/span>cReportParameters<\/span>;<\/span><\/div><\/li>\n
        13.  <\/div><\/li>\n
        14. CreateTable(<\/span>ReportFont.<\/span>cPageWidth<\/span>, 4<\/span>)<\/span>;<\/span><\/div><\/li>\n
        15. cCurrentTable.<\/span>Format<\/span>.<\/span>Font<\/span> =<\/span> SmallFont.<\/span>Clone<\/span>(<\/span>)<\/span>;<\/span><\/div><\/li>\n
        16. cCurrentTable.<\/span>Borders<\/span>.<\/span>Visible<\/span> =<\/span> false<\/span>;<\/span><\/div><\/li>\n
        17. \/\/Header Row<\/span><\/div><\/li>\n
        18. AddRow(<\/span>Cell(<\/span>"Pole Capacity Utilization (%)"<\/span>, 2<\/span>, MD.<\/span>Colors<\/span>.<\/span>White<\/span>, JustifyLeft, StandardFont, Bold)<\/span>,<\/div><\/li>\n
        19. Cell(<\/span>"Height"<\/span> +<\/span> "\\n<\/span>("<\/span> +<\/span> RP.<\/span>Units_Len_Large_Abrev<\/span> +<\/span> ")"<\/span>, MD.<\/span>Colors<\/span>.<\/span>White<\/span>, JustifyRight, StandardFont, Bold)<\/span>,<\/div><\/li>\n
        20. Cell(<\/span>"Wind Angle"<\/span> +<\/span> "\\n<\/span>(deg)"<\/span>, MD.<\/span>Colors<\/span>.<\/span>White<\/span>, JustifyRight, StandardFont, Bold)<\/span>)<\/span>;<\/span><\/div><\/li>\n
        21. cCurrentTable.<\/span>RightPadding<\/span> =<\/span> MD.<\/span>Unit<\/span>.<\/span>FromInch<\/span>(<\/span>0.125<\/span>)<\/span>;<\/span><\/div><\/li>\n
        22.  <\/div><\/li>\n
        23. \/\/First Row<\/span><\/div><\/li>\n
        24. AddRow(<\/span>Cell(<\/span>"Maximum"<\/span>, JustifyLeft)<\/span>,<\/div><\/li>\n
        25. Cell(<\/span>Math.<\/span>Round<\/span>(<\/span>RP.<\/span>Sum_MCU<\/span>, 1<\/span>)<\/span>.<\/span>ToString<\/span>(<\/span>"0.0"<\/span>)<\/span>, Yellow, JustifyRight, StandardFont, Bold,<\/div><\/li>\n
        26. GetColorFromValueAndTolerance(<\/span>RP.<\/span>Sum_MCU<\/span>, 80<\/span>, 90<\/span>, 99.5<\/span>)<\/span>)<\/span>,<\/div><\/li>\n
        27. Cell(<\/span>Math.<\/span>Round<\/span>(<\/span>RP.<\/span>Sum_MCU_Height<\/span>, 1<\/span>)<\/span>.<\/span>ToString<\/span>(<\/span>"0.0"<\/span>)<\/span>, JustifyRight)<\/span>,<\/div><\/li>\n
        28. Cell(<\/span>Math.<\/span>Round<\/span>(<\/span>RP.<\/span>Sum_MCU_Wind_Angle<\/span>, 1<\/span>)<\/span>.<\/span>ToString<\/span>(<\/span>"0.0"<\/span>)<\/span>, JustifyRight)<\/span>)<\/span>;<\/span><\/div><\/li>\n
        29.  <\/div><\/li>\n
        30. \/\/Second Row<\/span><\/div><\/li>\n
        31. AddRow(<\/span>Cell(<\/span>"Groundline"<\/span>, JustifyLeft)<\/span>,<\/div><\/li>\n
        32. Cell(<\/span>Math.<\/span>Round<\/span>(<\/span>RP.<\/span>Sum_GLCU<\/span>, 1<\/span>)<\/span>.<\/span>ToString<\/span>(<\/span>"0.0"<\/span>)<\/span>, Yellow, JustifyRight, StandardFont, Bold,<\/div><\/li>\n
        33. GetColorFromValueAndTolerance(<\/span>RP.<\/span>Sum_GLCU<\/span>, 80<\/span>, 90<\/span>, 99.5<\/span>)<\/span>)<\/span>,<\/div><\/li>\n
        34. Cell(<\/span>Math.<\/span>Round<\/span>(<\/span>RP.<\/span>Sum_GLCU_Height<\/span>, 1<\/span>)<\/span>.<\/span>ToString<\/span>(<\/span>"0.0"<\/span>)<\/span>, JustifyRight)<\/span>,<\/div><\/li>\n
        35. Cell(<\/span>Math.<\/span>Round<\/span>(<\/span>RP.<\/span>Sum_GLCU_Wind_Angle<\/span>, 1<\/span>)<\/span>.<\/span>ToString<\/span>(<\/span>"0.0"<\/span>)<\/span>, JustifyRight)<\/span>)<\/span>;<\/span><\/div><\/li>\n
        36.  <\/div><\/li>\n
        37. \/\/Third Row<\/span><\/div><\/li>\n
        38. AddRow(<\/span>Cell(<\/span>"Vertical"<\/span>, JustifyLeft)<\/span>,<\/div><\/li>\n
        39. Cell(<\/span>Math.<\/span>Round<\/span>(<\/span>RP.<\/span>Sum_Vertical_Buckling_CU<\/span>, 1<\/span>)<\/span>.<\/span>ToString<\/span>(<\/span>"0.0"<\/span>)<\/span>, Yellow, JustifyRight, StandardFont, Bold,<\/div><\/li>\n
        40. GetColorFromValueAndTolerance(<\/span>RP.<\/span>Sum_Vertical_Buckling_CU<\/span>, 80<\/span>, 90<\/span>, 99.5<\/span>)<\/span>)<\/span>,<\/div><\/li>\n
        41. Cell(<\/span>Math.<\/span>Round<\/span>(<\/span>RP.<\/span>Sum_Vertical_Buckling_Column_Height<\/span>, 1<\/span>)<\/span>.<\/span>ToString<\/span>(<\/span>"0.0"<\/span>)<\/span>, JustifyRight)<\/span>,<\/div><\/li>\n
        42. Cell(<\/span>Math.<\/span>Round<\/span>(<\/span>RP.<\/span>Sum_Vertical_Buckling_Wind_Angle<\/span>, 1<\/span>)<\/span>.<\/span>ToString<\/span>(<\/span>"0.0"<\/span>)<\/span>, JustifyRight)<\/span>)<\/span>;<\/span><\/div><\/li>\n
        43.  <\/div><\/li>\n
        44. cCurrentTable.<\/span>BottomPadding<\/span> =<\/span> MD.<\/span>Unit<\/span>.<\/span>FromInch<\/span>(<\/span>0.03<\/span>)<\/span>;<\/span><\/div><\/li>\n
        45. cCurrentTable.<\/span>TopPadding<\/span> =<\/span> MD.<\/span>Unit<\/span>.<\/span>FromInch<\/span>(<\/span>0.03<\/span>)<\/span>;<\/span><\/div><\/li>\n
        46.  <\/div><\/li>\n
        47. cCurrentTable.<\/span>SetEdge<\/span>(<\/span>0<\/span>, 0<\/span>, cCurrentTable.<\/span>Columns<\/span>.<\/span>Count<\/span>, cCurrentTable.<\/span>Rows<\/span>.<\/span>Count<\/span>, MDT.<\/span>Edge<\/span>.<\/span>Box<\/span>, MD.<\/span>BorderStyle<\/span>.<\/span>Single<\/span>, 1<\/span>, MD.<\/span>Colors<\/span>.<\/span>Black<\/span>)<\/span>;<\/span><\/div><\/li>\n
        48. cCurrentTable.<\/span>SetEdge<\/span>(<\/span>0<\/span>, 0<\/span>, cCurrentTable.<\/span>Columns<\/span>.<\/span>Count<\/span>, 1<\/span>, MDT.<\/span>Edge<\/span>.<\/span>Box<\/span>, MD.<\/span>BorderStyle<\/span>.<\/span>Single<\/span>, 1<\/span>, MD.<\/span>Colors<\/span>.<\/span>Black<\/span>)<\/span>;<\/span><\/div><\/li>\n
        49.  <\/div><\/li>\n
        50. FinalizeTable(<\/span>)<\/span>;<\/span><\/div><\/li>\n
        51. cDocument.<\/span>LastSection<\/span>.<\/span>AddParagraph<\/span>(<\/span>"\\n<\/span>"<\/span>)<\/span>;<\/span><\/div><\/li>\n
        52. }<\/span><\/div><\/li>\n<\/ol>\t<\/div>\n\n<\/div>\n\n

           <\/p>\n\"Facebook\"<\/a>\"twitter\"<\/a>\"linkedin\"<\/a>\"mail\"<\/a>","protected":false},"excerpt":{"rendered":"

          The default O-Calc Pro Report template will create a simple report with default header and a single table of pole capacity utilization values.\u00a0 Below are some explanations of the various code components of this simple report example. Defining the Report Format, Fonts, and Colors: < View plain text > C# public static class ReportFont { ..<\/p>\n

          <\/div>\n

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