/* Copyright 2010, Object Management Group, Inc.
 * Copyright 2010, PrismTech, Inc.
 * Copyright 2010, Real-Time Innovations, Inc.
 * All rights reserved.
 *
 * Licensed 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.
 */

package org.omg.dds.sub;

/**
 * For each sample, the Data Distribution Service internally maintains a SampleState specific to each DataReader.
 * The SampleState can either be READ or NOT_READ.
 */
public enum SampleState {
    // -----------------------------------------------------------------------
    // States
    // -----------------------------------------------------------------------
    /**
     * READ indicates that the DataReader has already accessed that sample by means of {@link org.omg.dds.sub.DataReader#read()}.
     * Had the sample been accessed by {@link org.omg.dds.sub.DataReader#take()} it would no longer be available to the DataReader.
     */
    READ(0x0001 << 0),
    /**
     * NOT_READ indicates that the DataReader has not accessed that sample before.
     */
    NOT_READ(0x0001 << 1);



    // -----------------------------------------------------------------------
    // Constants
    // -----------------------------------------------------------------------

    public final int value;



    // -----------------------------------------------------------------------
    // Object Life Cycle
    // -----------------------------------------------------------------------
    private SampleState(int value) {
        this.value = value;
    }

}
