{"id":51313,"date":"2010-02-13T00:01:00","date_gmt":"2010-02-13T00:01:00","guid":{"rendered":"https:\/\/blogs.technet.microsoft.com\/heyscriptingguy\/2010\/02\/13\/hey-scripting-guy-weekend-scripter-using-functions-to-convert-weight-measurements-part-1\/"},"modified":"2010-02-13T00:01:00","modified_gmt":"2010-02-13T00:01:00","slug":"hey-scripting-guy-weekend-scripter-using-functions-to-convert-weight-measurements-part-1","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/scripting\/hey-scripting-guy-weekend-scripter-using-functions-to-convert-weight-measurements-part-1\/","title":{"rendered":"Hey, Scripting Guy! Weekend Scripter: Using Functions to Convert Weight Measurements (Part 1)"},"content":{"rendered":"

<\/p>\n

\"Bookmark<\/a><\/p>\n

<\/font><\/p>\n

\n

 <\/p>\n<\/p>\n

Microsoft Scripting Guy Ed Wilson here. If you have been following us on Twitter, you know that I have been out for nearly a week due to ear surgery. While I have been recuperating, I have had a lot of time to think about the module we started last Saturday<\/a>, and that we continued last Sunday<\/a>. The Scripting wife took me to South Carolina coast to a little village called Murrells Inlet<\/a> for a long weekend to help me rest, relax, and recover. As it turned out, it was a wonderful weekend, and I was able to walk along the beach and take some pretty cool pictures such as this one.<\/p>\n

\n

\"Image<\/p>\n

As I was walking along the beach taking pictures, I was thinking of the capabilities our conversion function has, and I realized it did not have the ability to convert weights. To keep with our ConvertTo<\/b> verb, I decided to create a function named ConvertTo-Pounds<\/b>. Because you may wish to convert multiple values to pounds, I decided to add multiple input parameters. The complete ConvertTo-Pounds<\/b> function is seen here. <\/p>\n

ConvertTo-Pounds<\/p>\n

<\/strong><\/p>\n

Function ConvertTo-Pounds
{
 <\/span><#
  <\/span>.Synopsis
    <\/span>Converts tons, ounces, kilograms, or metric tons into pounds
   <\/span>.Description
    <\/span>The ConvertTo-Pounds function will accept an input in
    <\/span>tons, ounces, kilograms, or metric tons and convert the result into pounds.
   <\/span>.Example
    <\/span>ConvertTo-Pounds -ton 1
    <\/span>Converts 1 ton into pounds
   <\/span>.Example
    <\/span>ConvertTo-Pounds -ounce 1000
    <\/span>Converts 1000 ounces into pounds
   <\/span>.Example
    <\/span>ConvertTo-Pounds -kilogram 1
    <\/span>Converts 1 kilograms into pounds
   <\/span>.Example
    <\/span>ConvertTo-Pounds -metricTon 1
    <\/span>Converts 1 metric ton into pounds
   <\/span>.Parameter ton
    <\/span>The number of tons to be converted
   <\/span>.Parameter ounce
    <\/span>The number of ounces to be converted
   <\/span>.Parameter kilogram
    <\/span>The number of kilograms to be converted
   <\/span>.Parameter metricTon
    <\/span>The number of metric tons to be converted
   <\/span>.Inputs
    <\/span>[double]
   <\/span>.Outputs
    <\/span>[string]
   <\/span>.Notes
    <\/span>NAME:  <\/span>ConvertTo-Pounds
    <\/span>AUTHOR: Ed Wilson
    <\/span>AUTHOR BOOK: Windows PowerShell 2.0 Best Practices, Microsoft Press 2010
    <\/span>LASTEDIT: 1\/31\/2010
    <\/span>KEYWORDS: WeekEnd Scripter, modules, getting started
   <\/span>.Link
     <\/span>Http:\/\/www.ScriptingGuys.com
     <\/span>Http:\/\/www.bit.ly\/HSGBlog
 <\/span>#>
 <\/span>#Requires -Version 2.0
 <\/span>[CmdletBinding()]
 <\/span>param(
      <\/span>[Parameter(Mandatory = $false,valueFromPipeline=$true)]
      <\/span>[Double]
      <\/span>$Ton,
      <\/span>[Parameter(Mandatory = $false,valueFromPipeline=$true)]
      <\/span>[Double]
      <\/span>$Ounce,
      <\/span>[Parameter(Mandatory = $false,valueFromPipeline=$true)]
      <\/span>[Double]
      <\/span>$KiloGram,
      <\/span>[Parameter(Mandatory = $false,valueFromPipeline=$true)]
      <\/span>[Double]
      <\/span>$MetricTon     <\/span>
) #end param
  <\/span>If($ton)
    <\/span>{ “$ton tons equals $($ton * 2000) pounds” }
  <\/span>If($ounce)
    <\/span>{ “$ounce ounces equals $($ounce * 0.0625) pounds” }
  <\/span>If($kilogram)
    <\/span>{ “$kilogram kilograms equals $($kilogram * 2.205) pounds” }
  <\/span>If($metricTon)
    <\/span>{ “$metricTon metric tons equals $($metricTon * 2205) pounds” }} #end ConvertTo-Pounds<\/p>\n

<\/font><\/font><\/span><\/p>\n

I begin the ConvertTo-Pounds<\/b> function by adding the help section. I use the Synopsis, Description, Example, Parameter, inputs, outputs, notes, and link tags. It is a best practice to include an example of using each of the parameters for your function. In addition, you should describe each of the parameters. For this function, I decided to move the #Requires<\/b> tag outside of the help section. This keeps it from showing up inside the notes section of the help. <\/p>\n

To allow for multiple conversions, I declare a parameter for each different type of value: ton, ounce, kilogram, and metric ton. None of these parameters are mandatory, and all will accept input from the pipeline. These will be named parameters; therefore, none of them have a default position assigned. <\/p>\n

The parameter that is used determines what type of conversion will be performed. This is seen when you use the Get-Help<\/b> cmdlet to display the examples, as shown here:<\/p>\n

PS C:> get-help ConvertTo-Pounds -Examples<\/p>\n

NAME
    <\/span>ConvertTo-Pounds<\/p>\n

SYNOPSIS
    <\/span>Converts tons, ounces, or kilograms into pounds<\/p>\n

    <\/span>————————– EXAMPLE 1 ————————–<\/p>\n

    <\/span>C:PS>ConvertTo-Pounds -ton 1<\/p>\n

    <\/span>Converts 1 ton into pounds<\/p>\n

    <\/span>————————– EXAMPLE 2 ————————–<\/p>\n

    <\/span>C:PS>ConvertTo-Pounds -ounce 1000<\/p>\n

    <\/span>Converts 1000 ounces into pounds<\/p>\n

    <\/span>————————– EXAMPLE 3 ————————–<\/p>\n

    <\/span>C:PS>ConvertTo-Pounds -kilogram 1<\/p>\n

    <\/span>Converts 1 kilogram into pounds<\/p>\n

    <\/span>————————– EXAMPLE 4 ————————–<\/p>\n

    <\/span>C:PS>ConvertTo-Pounds -metricTon 1<\/p>\n

    <\/span>Converts 1 metric ton into pounds<\/p>\n

PS C:><\/p>\n

<\/font><\/span><\/p>\n

The use of the new ConvertTo-Pounds<\/b> function is seen in the following image:<\/p>\n

\n

\"Image<\/p>\n

\n

 <\/p>\n

The complete conversion module as it currently stands is seen here.<\/p>\n

ConversionModuleV3.psm1<\/p>\n

<\/strong><\/p>\n

Function ConvertTo-Pounds
{
 <\/span><#
  <\/span>.Synopsis
    <\/span>Converts tons, ounces, kilograms, or metric tons into pounds
   <\/span>.Description
    <\/span>The ConvertTo-Pounds function will accept an input in
    <\/span>tons, ounces, kilograms, or metric tons and convert the result into pounds.
   <\/span>.Example
    <\/span>ConvertTo-Pounds -ton 1
    <\/span>Converts 1 ton into pounds
   <\/span>.Example
    <\/span>ConvertTo-Pounds -ounce 1000
    <\/span>Converts 1000 ounces into pounds
   <\/span>.Example
    <\/span>ConvertTo-Pounds -kilogram 1
    <\/span>Converts 1 kilograms into pounds
   <\/span>.Example
    <\/span>ConvertTo-Pounds -metricTon 1
    <\/span>Converts 1 metricTon into pounds
   <\/span>.Parameter ton
    <\/span>The number of tons to be converted
   <\/span>.Parameter ounce
    <\/span>The number of ounces to be converted
   <\/span>.Parameter kilogram
    <\/span>The number of kilograms to be converted
   <\/span>.Parameter metricTon
    <\/span>The number of metricTons to be converted
   <\/span>.Inputs
&nbsp\n;   <\/span>[double]
   <\/span>.Outputs
    <\/span>[string]
   <\/span>.Notes
    <\/span>NAME:  <\/span>ConvertTo-Pounds
    <\/span>AUTHOR: Ed Wilson
    <\/span>AUTHOR BOOK: Windows PowerShell 2.0 Best Practices, Microsoft Press 2010
    <\/span>LASTEDIT: 1\/31\/2010
    <\/span>KEYWORDS: WeekEnd Scripter, modules, getting started
   <\/span>.Link
     <\/span>Http:\/\/www.ScriptingGuys.com
     <\/span>Http:\/\/www.bit.ly\/HSGBlog
 <\/span>#>
 <\/span>#Requires -Version 2.0
 <\/span>[CmdletBinding()]
 <\/span>param(
   <\/span>   <\/span>[Parameter(Mandatory = $false,valueFromPipeline=$true)]
      <\/span>[Double]
      <\/span>$Ton,
      <\/span>[Parameter(Mandatory = $false,valueFromPipeline=$true)]
      <\/span>[Double]
      <\/span>$Ounce,
      <\/span>[Parameter(Mandatory = $false,valueFromPipeline=$true)]
      <\/span>[Double]
  <\/span>    <\/span>$KiloGram,
      <\/span>[Parameter(Mandatory = $false,valueFromPipeline=$true)]
      <\/span>[Double]
      <\/span>$MetricTon     <\/span>
) #end param
  <\/span>If($ton)
    <\/span>{ “$ton tons equals $($ton * 2000) pounds” }
  <\/span>If($ounce)
    <\/span>{ “$ounce ounces equals $($ounce * 0.0625) pounds” }
  <\/span>If($kilogram)
    <\/span>{ “$kilogram kilograms equals $($kilogram * 2.205) pounds” }
  <\/span>If($metricTon)
    <\/span>{ “$metricTon metric tons equals $($metricTon * 2205) pounds” }
} #end ConvertTo-Pounds<\/p>\n

Function ConvertTo-Meters
{
 <\/span><#
  <\/span>.Synopsis
    <\/span>Converts feet into meters
   <\/span>.Description
    <\/span>The ConvertTo-Meters function accepts a value in feet and
    <\/span>returns a string indicating the number of meters.
   <\/span>.Example
    <\/span>ConvertTo-Meters 1
    <\/span>Converts 1 foot into meters
   <\/span>.Parameter feet
    <\/span>The number of feet to be converted
   <\/span>.Inputs
    <\/span>[double]
   <\/span>.Outputs
    <\/span>[string]
   <\/span>.Notes
    <\/span>NAME:  <\/span>ConvertTo-Meters
    <\/span>AUTHOR: Ed Wilson
    <\/span>AUTHOR BOOK: Windows PowerShell 2.0 Best Practices, Microsoft Press 2010
    <\/span>LASTEDIT: 1\/31\/2010
    <\/span>KEYWORDS: WeekEnd Scripter, modules, getting started
   <\/span>.Link
     <\/span>Http:\/\/www.ScriptingGuys.com
     <\/span>Http:\/\/www.bit.ly\/HSGBlog
 <\/span>#Requires -Version 2.0
 <\/span>#>
 <\/span>[CmdletBinding()]
 <\/span>param(
      <\/span>[Parameter(Mandatory = $true,Position = 0,valueFromPipeline=$true)]
      <\/span>[Double]
      <\/span>$feet
) #end param
  <\/span>“$feet feet equals $($feet*.31) meters”
} #end ConvertTo-Meters<\/p>\n

Function ConvertTo-Feet
{
 <\/span><#
  <\/span>.Synopsis
    <\/span>Converts meters into feet
  <\/span>.Description
    <\/span>The ConvertTo-Feet function accepts a value in meters and
    <\/span>returns a string indicating the number of feet.
   <\/span>.Example
    <\/span>ConvertTo-Feet 1
    <\/span>Converts 1 meter into feet
   <\/span>.Parameter meters
    <\/span>The number of meters to be converted into feet
   <\/span>.Inputs
    <\/span>[double]
   <\/span>.Outputs
    <\/span>[string]
   <\/span>.Notes
    <\/span>NAME:  <\/span>ConvertTo-Feet
    <\/span>AUTHOR: Ed Wilson
    <\/span>LASTEDIT: 1\/31\/2010
    <\/span>KEYWORDS: WeekEnd Scripter, modules, getting started
   <\/span>.Link
     <\/span>Http:\/\/www.ScriptingGuys.com
 <\/span>#Requires -Version 2.0
 <\/span>#>
 <\/span>[CmdletBinding()]
 <\/span>param(
   &n\nbsp;  <\/span>[Parameter(Mandatory = $true,Position = 0,valueFromPipeline=$true)]
      <\/span>[Double]
      <\/span>$meters
) #end param
 <\/span>“$meters meters equals $($meters * 3.28) feet”
} #end ConvertTo-Feet<\/p>\n

Function ConvertTo-Fahrenheit
{
 <\/span><#
  <\/span>.Synopsis
    <\/span>Converts Celsius into Fahrenheit
  <\/span>.Description
    <\/span>The ConvertTo-Fahrenheit function accepts a value in Celsius and
    <\/span>returns a string indicating the temperature in Fahrenheit.
   <\/span>.Example
    <\/span>ConvertTo-Fahrenheit 1
    <\/span>Converts 1 degree Celsius into Fahrenheit
   <\/span>.Parameter celsius
    <\/span>The  <\/span>temperature to be converted into Fahrenheit
   <\/span>.Inputs
    <\/span>[double]
   <\/span>.Outputs
    <\/span>[string]
   <\/span>.Notes
    <\/span>NAME:  <\/span>ConvertTo-Fahrenheit
    <\/span>AUTHOR: Ed Wilson
    <\/span>LASTEDIT: 1\/31\/2010
    <\/span>KEYWORDS: WeekEnd Scripter, modules, getting started
   <\/span>.Link
     <\/span>Http:\/\/www.ScriptingGuys.com
 <\/span>#Requires -Version 2.0
 <\/span>#>
 <\/span>[CmdletBinding()]
 <\/span>param(
      <\/span>[Parameter(Mandatory = $true,Position = 0,valueFromPipeline=$true)]
      <\/span>[Double]
      <\/span>$celsius
) #end param
 <\/span>“$celsius celsius equals $((1.8 * $celsius) + 32 ) fahrenheit”
} #end ConvertTo-Fahrenheit<\/p>\n

Function ConvertTo-Celsius
{
 <\/span><#
  <\/span>.Synopsis
    <\/span>Converts Fahrenheit into Celsius
  <\/span>.Description
    <\/span>The ConvertTo-Celsius function accepts a value in Fahrenheit and
    <\/span>returns a string indicating the temperature in Celsius.
   <\/span>.Example
    <\/span>ConvertTo-Celsius 1
    <\/span>Converts 1 degree Fahrenheit into Celsius
   <\/span>.Parameter fahrenheit
    <\/span>The  <\/span>temperature to be converted
   <\/span>.Inputs
    <\/span>[double]
   <\/span>.Outputs
    <\/span>[string]
   <\/span>.Notes
    <\/span>NAME:  <\/span>ConvertTo-Celsius
    <\/span>AUTHOR: Ed Wilson
    <\/span>LASTEDIT: 1\/31\/2010
    <\/span>KEYWORDS: WeekEnd Scripter, modules, getting started
   <\/span>.Link
     <\/span>Http:\/\/www.ScriptingGuys.com
 <\/span>#Requires -Version 2.0
 <\/span>#>
 <\/span>[CmdletBinding()]
 <\/span>param(
      <\/span>[Parameter(Mandatory = $true,Position = 0,valueFromPipeline=$true)]
      <\/span>[Double]
      <\/span>$fahrenheit
) #end param
 <\/span>“$fahrenheit fahrenheit equals $( (($fahrenheit – 32)\/9)*5 ) celsius”
} #end ConvertT-Celsius<\/p>\n

Function ConvertTo-Miles
{
 <\/span><#
  <\/span>.Synopsis
    <\/span>Converts kilometers into miles
  <\/span>.Description
    <\/span>The ConvertTo-Miles function accepts a value in kilometers and
    <\/span>returns a string indicating the distance in miles.
   <\/span>.Example
    <\/span>ConvertTo-Miles
    <\/span>Converts 1 kilometer into miles
   <\/span>.Parameter kilometer
    <\/span>The distance to be converted
   <\/span>.Inputs
    <\/span>[double]
   <\/span>.Outputs
    <\/span>[string]
   <\/span><\/font><\/font><\/span><\/p>\n<\/h2>\n","protected":false},"excerpt":{"rendered":"

  Microsoft Scripting Guy Ed Wilson here. If you have been following us on Twitter, you know that I have been out for nearly a week due to ear surgery. While I have been recuperating, I have had a lot of time to think about the module we started last Saturday, and that we continued […]<\/p>\n","protected":false},"author":595,"featured_media":87096,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[51,52,3,4,61,45],"class_list":["post-51313","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-scripting","tag-getting-started","tag-modules","tag-scripting-guy","tag-scripting-techniques","tag-weekend-scripter","tag-windows-powershell"],"acf":[],"blog_post_summary":"

  Microsoft Scripting Guy Ed Wilson here. If you have been following us on Twitter, you know that I have been out for nearly a week due to ear surgery. While I have been recuperating, I have had a lot of time to think about the module we started last Saturday, and that we continued […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/51313","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/users\/595"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/comments?post=51313"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/51313\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media\/87096"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media?parent=51313"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/categories?post=51313"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/tags?post=51313"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}