src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionConfiguration.cs

   1 /*
   2  * Copyright (c) 2016 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.Multimedia
  20 {
  21     /// <summary>
  22     /// Represents a configuration of <see cref="PersonRecognizer"/> instances.
  23     /// </summary>
  24     /// <since_tizen> 3</since_tizen>
  25     public class PersonRecognitionConfiguration : SurveillanceEngineConfiguration
  26     {
  27         private const string KeyFaceRecognitionModelFilePath = "MV_SURVEILLANCE_FACE_RECOGNITION_MODEL_FILE_PATH";
  28
  29         /// <summary>
  30         /// Initializes a new instance of the <see cref="PersonRecognitionConfiguration"/> class.
  31         /// </summary>
  32         /// <param name="modelPath">Path to the face recognition model.</param>
  33         /// <exception cref="ArgumentNullException"><paramref name="modelPath"/> is null.</exception>
  34         /// <exception cref="NotSupportedException">The feature is not supported.</exception>
  35         /// <since_tizen>3</since_tizen>
  36         public PersonRecognitionConfiguration(string modelPath)
  37         {
  38             FaceRecognitionModelPath = modelPath;
  39         }
  40
  41         /// <summary>
  42         /// Gets or sets face recognition model file path.
  43         /// </summary>
  44         /// <exception cref="ArgumentNullException"><paramref name="value"/> is null.</exception>
  45         /// <exception cref="ObjectDisposedException">The <see cref="PersonRecognitionConfiguration"/> already has been disposed of.</exception>
  46         /// <since_tizen>3</since_tizen>
  47         public string FaceRecognitionModelPath
  48         {
  49             get
  50             {
  51                 return GetString(KeyFaceRecognitionModelFilePath);
  52             }
  53             set
  54             {
  55                 if (value == null)
  56                 {
  57                     throw new ArgumentNullException(nameof(FaceRecognitionModelPath));
  58                 }
  59                 Set(KeyFaceRecognitionModelFilePath, value);
  60             }
  61         }
  62     }
  63 }