Add Tizen.Peripheral API (#1939)
[platform/core/csapi/tizenfx.git] / internals / src / Tizen.Peripheral / Tizen.Peripheral / PinUpdatedEventArgs.cs
1 /*
2 * Copyright (c) 2020 Samsung Electronics Co., Ltd All Rights Reserved
3 *
4 * Licensed under the Apache License, Version 2.0 (the License);
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an AS IS BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 using System;
18
19 namespace Tizen.Peripheral.Gpio
20 {
21     /// <summary>
22     /// This custom class extend from EventArgs to obtain Gpio object Input Pin update.
23     /// </summary>
24     public class PinUpdatedEventArgs : EventArgs
25     {
26         internal PinUpdatedEventArgs(int pinNumber, GpioPinValue pinValue)
27         {
28             PinNumber = pinNumber;
29             PinValue = pinValue;
30         }
31
32         /// <summary>
33         /// Gets the Input Pin number which state has changed.
34         /// </summary>
35         public int PinNumber { get; }
36
37         /// <summary>
38         /// Gets the current state of the Input Pin.
39         /// </summary>
40         public GpioPinValue PinValue { get; }
41
42         /// <inheritdoc/>
43         public override string ToString()
44         {
45             return $"Pin number {PinNumber} has changed its value to {PinValue}";
46         }
47     }
48 }