Sample.java

Go to the documentation of this file.

/* 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;

import java.io.Serializable;
import java.util.ListIterator;

import org.omg.dds.core.DDSObject;
import org.omg.dds.core.InstanceHandle;
import org.omg.dds.core.Time;


public interface Sample<TYPE> extends Cloneable, Serializable, DDSObject
{
    // -----------------------------------------------------------------------
    // Methods
    // -----------------------------------------------------------------------

    // --- Sample data: ------------------------------------------------------

    public TYPE getData();


    // --- Sample meta-data: -------------------------------------------------

    public SampleState getSampleState();

    public ViewState getViewState();

    public InstanceState getInstanceState();
    public Time getSourceTimestamp();
    public InstanceHandle getInstanceHandle();
    public InstanceHandle getPublicationHandle();

    public int getDisposedGenerationCount();

    public int getNoWritersGenerationCount();

    public int getSampleRank();

    public int getGenerationRank();

    public int getAbsoluteGenerationRank();


    // --- From Object: ------------------------------------------------------

    public Sample<TYPE> clone();



    // -----------------------------------------------------------------------
    // Types
    // -----------------------------------------------------------------------

    public static interface Iterator<IT_DATA>
    extends java.io.Closeable, ListIterator<Sample<IT_DATA>> {
        @Override
        public abstract void close() throws java.io.IOException;

        // --- From ListIterator: --------------------------------------------
        @Override
        public void remove();

        @Override
        public void set(Sample<IT_DATA> o);

        @Override
        public void add(Sample<IT_DATA> o);
    }

}