lang/cs/Org.Apache.REEF.Driver/IProgressProvider.cs

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

using Org.Apache.REEF.Driver.Defaults;
using Org.Apache.REEF.Tang.Annotations;

namespace Org.Apache.REEF.Driver
{
    /// <summary>
    /// Provides the progress of the job to the Resource Manager
    /// </summary>
    [DefaultImplementation(typeof(DefaultProgressProvider))]
    public interface IProgressProvider
    {
        /// <summary>
        /// Provides the progress of the job to the Resource Manager.
        /// Value should be a float between 0 and 1. If value greater than 1, 
        /// 1 will be reported. If value less than 0, 0 will be reported.
        /// </summary>
        float Progress { get; }
    }
}