Typed.cs

Go to the documentation of this file.

/*
 *                         Vortex OpenSplice
 *
 *   This software and documentation are Copyright 2006 to 2021 ADLINK
 *   Technology Limited, its affiliated companies and licensors. 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.
 */


#if DOXYGEN_FOR_CS
//
// The above compile switch is never (and must never) be defined in normal compilation.
//
// This file is just used to add an example of a generated data type, its typesupport and
// the relating entities DataReader and DataWriter to the documentation.
//


namespace Space
{
    public sealed class Foo
    {
        public int Bar;
    };



    public class FooDataReader : DDS.IDataReader
    {
        public DDS.ReturnCode Read(
            ref Foo[] dataValues,
            ref DDS.SampleInfo[] sampleInfos)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode Read(
            ref Foo[] dataValues,
            ref DDS.SampleInfo[] sampleInfos,
            int maxSamples)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode Read(
            ref Foo[] dataValues,
            ref DDS.SampleInfo[] sampleInfos,
            DDS.SampleStateKind sampleStates,
            DDS.ViewStateKind viewStates,
            DDS.InstanceStateKind instanceStates)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode Read(
                ref Foo[] dataValues,
                ref DDS.SampleInfo[] sampleInfos,
                int maxSamples,
                DDS.SampleStateKind sampleStates,
                DDS.ViewStateKind viewStates,
                DDS.InstanceStateKind instanceStates)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode Take(
            ref Foo[] dataValues,
            ref DDS.SampleInfo[] sampleInfos)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode Take(
            ref Foo[] dataValues,
            ref DDS.SampleInfo[] sampleInfos,
            int maxSamples)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode Take(
            ref Foo[] dataValues,
            ref DDS.SampleInfo[] sampleInfos,
            DDS.SampleStateKind sampleStates,
            DDS.ViewStateKind viewStates,
            DDS.InstanceStateKind instanceStates)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode Take(
                ref Foo[] dataValues,
                ref DDS.SampleInfo[] sampleInfos,
                int maxSamples,
                DDS.SampleStateKind sampleStates,
                DDS.ViewStateKind viewStates,
                DDS.InstanceStateKind instanceStates)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode ReadWithCondition(
            ref Foo[] dataValues,
            ref DDS.SampleInfo[] sampleInfos,
            DDS.IReadCondition readCondition)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode ReadWithCondition(
                ref Foo[] dataValues,
                ref DDS.SampleInfo[] sampleInfos,
                int maxSamples,
                DDS.IReadCondition readCondition)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode TakeWithCondition(
            ref Foo[] dataValues,
            ref DDS.SampleInfo[] sampleInfos,
            DDS.IReadCondition readCondition)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode TakeWithCondition(
                ref Foo[] dataValues,
                ref DDS.SampleInfo[] sampleInfos,
                int maxSamples,
                DDS.IReadCondition readCondition)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode ReadNextSample(
                ref Foo dataValue,
                ref DDS.SampleInfo sampleInfo)
        {
            return DDS.ReturnCode.Unsupported;
        }

        public DDS.ReturnCode TakeNextSample(
                ref Foo dataValue,
                ref DDS.SampleInfo sampleInfo)
        {
            return DDS.ReturnCode.Unsupported;
        }

        public DDS.ReturnCode ReadInstance(
            ref Foo[] dataValues,
            ref DDS.SampleInfo[] sampleInfos,
            DDS.InstanceHandle instanceHandle)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode ReadInstance(
            ref Foo[] dataValues,
            ref DDS.SampleInfo[] sampleInfos,
            int maxSamples,
            DDS.InstanceHandle instanceHandle)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode ReadInstance(
                ref Foo[] dataValues,
                ref DDS.SampleInfo[] sampleInfos,
                int maxSamples,
                DDS.InstanceHandle instanceHandle,
                DDS.SampleStateKind sampleStates,
                DDS.ViewStateKind viewStates,
                DDS.InstanceStateKind instanceStates)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode TakeInstance(
            ref Foo[] dataValues,
            ref DDS.SampleInfo[] sampleInfos,
            DDS.InstanceHandle instanceHandle)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode TakeInstance(
            ref Foo[] dataValues,
            ref DDS.SampleInfo[] sampleInfos,
            int maxSamples,
            DDS.InstanceHandle instanceHandle)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode TakeInstance(
                ref Foo[] dataValues,
                ref DDS.SampleInfo[] sampleInfos,
                int maxSamples,
                DDS.InstanceHandle instanceHandle,
                DDS.SampleStateKind sampleStates,
                DDS.ViewStateKind viewStates,
                DDS.InstanceStateKind instanceStates)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode ReadNextInstance(
            ref Foo[] dataValues,
            ref DDS.SampleInfo[] sampleInfos,
            DDS.InstanceHandle instanceHandle)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode ReadNextInstance(
            ref Foo[] dataValues,
            ref DDS.SampleInfo[] sampleInfos,
            int maxSamples,
            DDS.InstanceHandle instanceHandle)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode ReadNextInstance(
                ref Foo[] dataValues,
                ref DDS.SampleInfo[] sampleInfos,
                int maxSamples,
                DDS.InstanceHandle instanceHandle,
                DDS.SampleStateKind sampleStates,
                DDS.ViewStateKind viewStates,
                DDS.InstanceStateKind instanceStates)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode TakeNextInstance(
            ref Foo[] dataValues,
            ref DDS.SampleInfo[] sampleInfos,
            DDS.InstanceHandle instanceHandle)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode TakeNextInstance(
            ref Foo[] dataValues,
            ref DDS.SampleInfo[] sampleInfos,
            int maxSamples,
            DDS.InstanceHandle instanceHandle)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode TakeNextInstance(
                ref Foo[] dataValues,
                ref DDS.SampleInfo[] sampleInfos,
                int maxSamples,
                DDS.InstanceHandle instanceHandle,
                DDS.SampleStateKind sampleStates,
                DDS.ViewStateKind viewStates,
                DDS.InstanceStateKind instanceStates)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode ReadNextInstanceWithCondition(
                ref Foo[] dataValues,
                ref DDS.SampleInfo[] sampleInfos,
                DDS.InstanceHandle instanceHandle,
                DDS.IReadCondition readCondition)
        {
            return DDS.ReturnCode.Unsupported;
        }

        public DDS.ReturnCode ReadNextInstanceWithCondition(
                ref Foo[] dataValues,
                ref DDS.SampleInfo[] sampleInfos,
                int maxSamples,
                DDS.InstanceHandle instanceHandle,
                DDS.IReadCondition readCondition)
        {
            return DDS.ReturnCode.Unsupported;
        }

        public DDS.ReturnCode TakeNextInstanceWithCondition(
                ref Foo[] dataValues,
                ref DDS.SampleInfo[] sampleInfos,
                DDS.InstanceHandle instanceHandle,
                DDS.IReadCondition readCondition)
        {
            return DDS.ReturnCode.Unsupported;
        }

        public DDS.ReturnCode TakeNextInstanceWithCondition(
                ref Foo[] dataValues,
                ref DDS.SampleInfo[] sampleInfos,
                int maxSamples,
                DDS.InstanceHandle instanceHandle,
                DDS.IReadCondition readCondition)
        {
            return DDS.ReturnCode.Unsupported;
        }

        public DDS.ReturnCode ReturnLoan(
                ref Foo[] dataValues,
                ref DDS.SampleInfo[] sampleInfos)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode GetKeyValue(
                ref Foo key,
                DDS.InstanceHandle instanceHandle)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.InstanceHandle LookupInstance(
                Foo instance)
        {
            return DDS.InstanceHandle.Nil;
        }

    }




    public class FooDataWriter : DDS.IDataWriter
    {
        public DDS.InstanceHandle RegisterInstance(
                Foo instanceData)
        {
            return DDS.InstanceHandle.Nil;
        }

        public DDS.InstanceHandle RegisterInstanceWithTimestamp(
                Foo instanceData,
                DDS.Time sourceTimestamp)
        {
            return DDS.InstanceHandle.Nil;
        }

        public DDS.ReturnCode UnregisterInstance(
                Foo instanceData,
                DDS.InstanceHandle instanceHandle)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode UnregisterInstanceWithTimestamp(
                Foo instanceData,
                DDS.InstanceHandle instanceHandle,
                DDS.Time sourceTimestamp)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode Write(Foo instanceData)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode Write(
                Foo instanceData,
                DDS.InstanceHandle instanceHandle)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode WriteWithTimestamp(
                Foo instanceData,
                DDS.Time sourceTimestamp)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode WriteWithTimestamp(
                Foo instanceData,
                DDS.InstanceHandle instanceHandle,
                DDS.Time sourceTimestamp)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode Dispose(
                Foo instanceData,
                DDS.InstanceHandle instanceHandle)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode DisposeWithTimestamp(
                Foo instanceData,
                DDS.InstanceHandle instanceHandle,
                DDS.Time sourceTimestamp)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode WriteDispose(
                Foo instanceData)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode WriteDispose(
                Foo instanceData,
                DDS.InstanceHandle instanceHandle)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode WriteDisposeWithTimestamp(
                Foo instanceData,
                DDS.Time sourceTimestamp)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode WriteDisposeWithTimestamp(
                Foo instanceData,
                DDS.InstanceHandle instanceHandle,
                DDS.Time sourceTimestamp)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.ReturnCode GetKeyValue(
                ref Foo key,
                DDS.InstanceHandle instanceHandle)
        {
            return DDS.ReturnCode.Ok;
        }

        public DDS.InstanceHandle LookupInstance(
            Foo instanceData)
        {
            return DDS.InstanceHandle.Nil;
        }
    }



    public class FooTypeSupport : DDS.ITypeSupport
    {
        public FooTypeSupport()
        { }
    }

} // end namespace Space

#endif // DOXYGEN_FOR_CS