Using OpenTK/OpenAL to Develop Cross Platform DIS VOIP Application

// Copyright (c) 1995-2009 held by the author(s).  All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
//  are met:
// 
//  * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the names of the Naval Postgraduate School (NPS)
//  Modeling Virtual Environments and Simulation (MOVES) Institute
// (http://www.nps.edu and http://www.MovesInstitute.org)
// nor the names of its contributors may be used to endorse or
//  promote products derived from this software without specific
// prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
// ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

using System;
using System.Collections.Generic;
using System.Text;
using System.Diagnostics;
using System.Xml.Serialization;
using DISnet.DataStreamUtilities;

namespace DIS1998net
{

    /**
     * Section 5.3.12.8: request for data from an entity. COMPLETE
     *
     * Copyright (c) 2008, MOVES Institute, Naval Postgraduate School. All rights reserved.
     * This work is licensed under the BSD open source license, available at https://www.movesinstitute.org/licenses/bsd.html
     *
     * @author DMcG
     * Modified for use with C#:
     * Peter Smith (Naval Air Warfare Center - Training Systems Division)
     */
    [Serializable]
    [XmlRoot]
    [XmlInclude(typeof(FixedDatum))]
    [XmlInclude(typeof(VariableDatum))]
    public partial class DataQueryReliablePdu : SimulationManagementWithReliabilityFamilyPdu
    {
        /** level of reliability service used for this transaction */
        protected byte  _requiredReliabilityService;

        /** padding */
        protected ushort  _pad1;

        /** padding */
        protected byte  _pad2;

        /** request ID */
        protected uint  _requestID;

        /** time interval between issuing data query PDUs */
        protected uint  _timeInterval;

        /** Fixed datum record count */
        protected uint  _numberOfFixedDatumRecords;

        /** variable datum record count */
        protected uint  _numberOfVariableDatumRecords;

        /** Fixed datum records */
        protected List<FixedDatum> _fixedDatumRecords = new List<FixedDatum>(); 
        /** Variable datum records */
        protected List<VariableDatum> _variableDatumRecords = new List<VariableDatum>(); 

        /** Constructor */
        ///<summary>
        ///Section 5.3.12.8: request for data from an entity. COMPLETE
        ///</summary>
        public DataQueryReliablePdu()
        {
            PduType = (byte)58;
        }

        new public int getMarshalledSize()
        {
            int marshalSize = 0; 

            marshalSize = base.getMarshalledSize();
            marshalSize = marshalSize + 1;  // _requiredReliabilityService
            marshalSize = marshalSize + 2;  // _pad1
            marshalSize = marshalSize + 1;  // _pad2
            marshalSize = marshalSize + 4;  // _requestID
            marshalSize = marshalSize + 4;  // _timeInterval
            marshalSize = marshalSize + 4;  // _numberOfFixedDatumRecords
            marshalSize = marshalSize + 4;  // _numberOfVariableDatumRecords
            for(int idx=0; idx < _fixedDatumRecords.Count; idx++)
            {
                FixedDatum listElement = (FixedDatum)_fixedDatumRecords[idx];
                marshalSize = marshalSize + listElement.getMarshalledSize();
            }
            for(int idx=0; idx < _variableDatumRecords.Count; idx++)
            {
                VariableDatum listElement = (VariableDatum)_variableDatumRecords[idx];
                marshalSize = marshalSize + listElement.getMarshalledSize();
            }

            return marshalSize;
        }


        ///<summary>
        ///level of reliability service used for this transaction
        ///</summary>
        public void setRequiredReliabilityService(byte pRequiredReliabilityService)
        { 
            _requiredReliabilityService = pRequiredReliabilityService;
        }

        [XmlElement(Type= typeof(byte), ElementName="requiredReliabilityService")]
        public byte RequiredReliabilityService
        {
            get
            {
                return _requiredReliabilityService;
            }
            set
            {
                _requiredReliabilityService = value;
            }
        }

        ///<summary>
        ///padding
        ///</summary>
        public void setPad1(ushort pPad1)
        { 
            _pad1 = pPad1;
        }

        [XmlElement(Type= typeof(ushort), ElementName="pad1")]
        public ushort Pad1
        {
            get
            {
                return _pad1;
            }
            set
            {
                _pad1 = value;
            }
        }

        ///<summary>
        ///padding
        ///</summary>
        public void setPad2(byte pPad2)
        { 
            _pad2 = pPad2;
        }

        [XmlElement(Type= typeof(byte), ElementName="pad2")]
        public byte Pad2
        {
            get
            {
                return _pad2;
            }
            set
            {
                _pad2 = value;
            }
        }

        ///<summary>
        ///request ID
        ///</summary>
        public void setRequestID(uint pRequestID)
        { 
            _requestID = pRequestID;
        }

        [XmlElement(Type= typeof(uint), ElementName="requestID")]
        public uint RequestID
        {
            get
            {
                return _requestID;
            }
            set
            {
                _requestID = value;
            }
        }

        ///<summary>
        ///time interval between issuing data query PDUs
        ///</summary>
        public void setTimeInterval(uint pTimeInterval)
        { 
            _timeInterval = pTimeInterval;
        }

        [XmlElement(Type= typeof(uint), ElementName="timeInterval")]
        public uint TimeInterval
        {
            get
            {
                return _timeInterval;
            }
            set
            {
                _timeInterval = value;
            }
        }

        /// <summary>
        /// Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose.
        /// The getnumberOfFixedDatumRecords method will also be based on the actual list length rather than this value. 
        /// The method is simply here for completeness and should not be used for any computations.
        /// </summary>
        public void setNumberOfFixedDatumRecords(uint pNumberOfFixedDatumRecords)
        {
            _numberOfFixedDatumRecords = pNumberOfFixedDatumRecords;
        }

        /// <summary>
        /// Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose.
        /// The getnumberOfFixedDatumRecords method will also be based on the actual list length rather than this value. 
        /// The method is simply here for completeness and should not be used for any computations.
        /// </summary>
        [XmlElement(Type= typeof(uint), ElementName="numberOfFixedDatumRecords")]
        public uint NumberOfFixedDatumRecords
        {
            get
            {
                return _numberOfFixedDatumRecords;
            }
            set
            {
                _numberOfFixedDatumRecords = value;
            }
        }

        /// <summary>
        /// Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose.
        /// The getnumberOfVariableDatumRecords method will also be based on the actual list length rather than this value. 
        /// The method is simply here for completeness and should not be used for any computations.
        /// </summary>
        public void setNumberOfVariableDatumRecords(uint pNumberOfVariableDatumRecords)
        {
            _numberOfVariableDatumRecords = pNumberOfVariableDatumRecords;
        }

        /// <summary>
        /// Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose.
        /// The getnumberOfVariableDatumRecords method will also be based on the actual list length rather than this value. 
        /// The method is simply here for completeness and should not be used for any computations.
        /// </summary>
        [XmlElement(Type= typeof(uint), ElementName="numberOfVariableDatumRecords")]
        public uint NumberOfVariableDatumRecords
        {
            get
            {
                return _numberOfVariableDatumRecords;
            }
            set
            {
                _numberOfVariableDatumRecords = value;
            }
        }

        ///<summary>
        ///Fixed datum records
        ///</summary>
        public void setFixedDatumRecords(List<FixedDatum> pFixedDatumRecords)
        {
            _fixedDatumRecords = pFixedDatumRecords;
        }

        ///<summary>
        ///Fixed datum records
        ///</summary>
        public List<FixedDatum> getFixedDatumRecords()
        {
            return _fixedDatumRecords;
        }

        ///<summary>
        ///Fixed datum records
        ///</summary>
        [XmlElement(ElementName = "fixedDatumRecordsList",Type = typeof(List<FixedDatum>))]
        public List<FixedDatum> FixedDatumRecords
        {
            get
            {
                return _fixedDatumRecords;
            }
            set
            {
                _fixedDatumRecords = value;
            }
        }

        ///<summary>
        ///Variable datum records
        ///</summary>
        public void setVariableDatumRecords(List<VariableDatum> pVariableDatumRecords)
        {
            _variableDatumRecords = pVariableDatumRecords;
        }

        ///<summary>
        ///Variable datum records
        ///</summary>
        public List<VariableDatum> getVariableDatumRecords()
        {
            return _variableDatumRecords;
        }

        ///<summary>
        ///Variable datum records
        ///</summary>
        [XmlElement(ElementName = "variableDatumRecordsList",Type = typeof(List<VariableDatum>))]
        public List<VariableDatum> VariableDatumRecords
        {
            get
            {
                return _variableDatumRecords;
            }
            set
            {
                _variableDatumRecords = value;
            }
        }

        ///<summary>
        ///Automatically sets the length of the marshalled data, then calls the marshal method.
        ///</summary>
        new public void marshalAutoLengthSet(DataOutputStream dos)
        {
            //Set the length prior to marshalling data
            this.setLength((ushort)this.getMarshalledSize());
            this.marshal(dos);
        }

        ///<summary>
        ///Marshal the data to the DataOutputStream.  Note: Length needs to be set before calling this method
        ///</summary>
        new public void marshal(DataOutputStream dos)
        {
            base.marshal(dos);
            try
            {
                dos.writeByte((byte)_requiredReliabilityService);
                dos.writeUshort((ushort)_pad1);
                dos.writeByte((byte)_pad2);
                dos.writeUint((uint)_requestID);
                dos.writeUint((uint)_timeInterval);
                dos.writeUint((uint)_fixedDatumRecords.Count);
                dos.writeUint((uint)_variableDatumRecords.Count);

                for(int idx = 0; idx < _fixedDatumRecords.Count; idx++)
                {
                    FixedDatum aFixedDatum = (FixedDatum)_fixedDatumRecords[idx];
                    aFixedDatum.marshal(dos);
                } // end of list marshalling


                for(int idx = 0; idx < _variableDatumRecords.Count; idx++)
                {
                    VariableDatum aVariableDatum = (VariableDatum)_variableDatumRecords[idx];
                    aVariableDatum.marshal(dos);
                } // end of list marshalling

            } // end try
            catch(Exception e)
            {
                Trace.WriteLine(e);
                Trace.Flush();
            }
        } // end of marshal method

        new public void unmarshal(DataInputStream dis)
        {
            base.unmarshal(dis);

            try
            {
                _requiredReliabilityService = dis.readByte();
                _pad1 = dis.readUshort();
                _pad2 = dis.readByte();
                _requestID = dis.readUint();
                _timeInterval = dis.readUint();
                _numberOfFixedDatumRecords = dis.readUint();
                _numberOfVariableDatumRecords = dis.readUint();
                for(int idx = 0; idx < _numberOfFixedDatumRecords; idx++)
                {
                    FixedDatum anX = new FixedDatum();
                    anX.unmarshal(dis);
                    _fixedDatumRecords.Add(anX);
                };

                for(int idx = 0; idx < _numberOfVariableDatumRecords; idx++)
                {
                    VariableDatum anX = new VariableDatum();
                    anX.unmarshal(dis);
                    _variableDatumRecords.Add(anX);
                };

            } // end try
            catch(Exception e)
            {
                Trace.WriteLine(e);
                Trace.Flush();
            }
        } // end of unmarshal method

        ///<summary>
        ///This allows for a quick display of PDU data.  The current format is unacceptable and only used for debugging.
        ///This will be modified in the future to provide a better display.  Usage: 
        ///pdu.GetType().InvokeMember("reflection", System.Reflection.BindingFlags.InvokeMethod, null, pdu, new object[] { sb });
        ///where pdu is an object representing a single pdu and sb is a StringBuilder.
        ///Note: The supplied Utilities folder contains a method called 'DecodePDU' in the PDUProcessor Class that provides this functionality
        ///</summary>
        new public void reflection(StringBuilder sb)
        {
            sb.Append("<DataQueryReliablePdu>"  + System.Environment.NewLine);
            base.reflection(sb);
            try
            {
                sb.Append("<requiredReliabilityService type=\"byte\">" + _requiredReliabilityService.ToString() + "</requiredReliabilityService> " + System.Environment.NewLine);
                sb.Append("<pad1 type=\"ushort\">" + _pad1.ToString() + "</pad1> " + System.Environment.NewLine);
                sb.Append("<pad2 type=\"byte\">" + _pad2.ToString() + "</pad2> " + System.Environment.NewLine);
                sb.Append("<requestID type=\"uint\">" + _requestID.ToString() + "</requestID> " + System.Environment.NewLine);
                sb.Append("<timeInterval type=\"uint\">" + _timeInterval.ToString() + "</timeInterval> " + System.Environment.NewLine);
                sb.Append("<fixedDatumRecords type=\"uint\">" + _fixedDatumRecords.Count.ToString() + "</fixedDatumRecords> " + System.Environment.NewLine);
                sb.Append("<variableDatumRecords type=\"uint\">" + _variableDatumRecords.Count.ToString() + "</variableDatumRecords> " + System.Environment.NewLine);

            for(int idx = 0; idx < _fixedDatumRecords.Count; idx++)
            {
                sb.Append("<fixedDatumRecords"+ idx.ToString() + " type=\"FixedDatum\">" + System.Environment.NewLine);
                FixedDatum aFixedDatum = (FixedDatum)_fixedDatumRecords[idx];
                aFixedDatum.reflection(sb);
                sb.Append("</fixedDatumRecords"+ idx.ToString() + ">" + System.Environment.NewLine);
            } // end of list marshalling


            for(int idx = 0; idx < _variableDatumRecords.Count; idx++)
            {
                sb.Append("<variableDatumRecords"+ idx.ToString() + " type=\"VariableDatum\">" + System.Environment.NewLine);
                VariableDatum aVariableDatum = (VariableDatum)_variableDatumRecords[idx];
                aVariableDatum.reflection(sb);
                sb.Append("</variableDatumRecords"+ idx.ToString() + ">" + System.Environment.NewLine);
            } // end of list marshalling

                sb.Append("</DataQueryReliablePdu>"  + System.Environment.NewLine);
            } // end try
            catch(Exception e)
            {
                Trace.WriteLine(e);
                Trace.Flush();
            }
        } // end of reflection method

        public static bool operator !=(DataQueryReliablePdu a, DataQueryReliablePdu b)
        {
            return !(a == b);
        }

        public static bool operator ==(DataQueryReliablePdu a, DataQueryReliablePdu b)
        {
            if (System.Object.ReferenceEquals(a, b))
            {
                return true;
            }

            if (((object)a == null) || ((object)b == null))
            {
                return false;
            }

            return a.equals(b);
        }


        public override bool Equals(object obj)
        {
            return this == obj as DataQueryReliablePdu;
        }


        /**
         * Compares for reference equality and value equality.
         */
        public bool equals(DataQueryReliablePdu rhs)
        {
            bool ivarsEqual = true;

            if(rhs.GetType() != this.GetType())
                return false;

            ivarsEqual = base.Equals(rhs);

            if( ! (_requiredReliabilityService == rhs._requiredReliabilityService)) ivarsEqual = false;
            if( ! (_pad1 == rhs._pad1)) ivarsEqual = false;
            if( ! (_pad2 == rhs._pad2)) ivarsEqual = false;
            if( ! (_requestID == rhs._requestID)) ivarsEqual = false;
            if( ! (_timeInterval == rhs._timeInterval)) ivarsEqual = false;
            if( ! (_numberOfFixedDatumRecords == rhs._numberOfFixedDatumRecords)) ivarsEqual = false;
            if( ! (_numberOfVariableDatumRecords == rhs._numberOfVariableDatumRecords)) ivarsEqual = false;

            if( ! (_fixedDatumRecords.Count == rhs._fixedDatumRecords.Count)) ivarsEqual = false;
            if(ivarsEqual)
            {
                for(int idx = 0; idx < _fixedDatumRecords.Count; idx++)
                {
                    if( ! ( _fixedDatumRecords[idx].Equals(rhs._fixedDatumRecords[idx]))) ivarsEqual = false;
                }
            }


            if( ! (_variableDatumRecords.Count == rhs._variableDatumRecords.Count)) ivarsEqual = false;
            if(ivarsEqual)
            {
                for(int idx = 0; idx < _variableDatumRecords.Count; idx++)
                {
                    if( ! ( _variableDatumRecords[idx].Equals(rhs._variableDatumRecords[idx]))) ivarsEqual = false;
                }
            }


            return ivarsEqual;
        }

        /**
         * HashCode Helper
         */
        private int GenerateHash(int hash)
        {
            hash = hash << 5 + hash;
            return(hash);
        }


        /**
         * Return Hash
         */
        public override int GetHashCode()
        {
            int result = 0;

            result = GenerateHash(result) ^ base.GetHashCode();

            result = GenerateHash(result) ^ _requiredReliabilityService.GetHashCode();
            result = GenerateHash(result) ^ _pad1.GetHashCode();
            result = GenerateHash(result) ^ _pad2.GetHashCode();
            result = GenerateHash(result) ^ _requestID.GetHashCode();
            result = GenerateHash(result) ^ _timeInterval.GetHashCode();
            result = GenerateHash(result) ^ _numberOfFixedDatumRecords.GetHashCode();
            result = GenerateHash(result) ^ _numberOfVariableDatumRecords.GetHashCode();

            if(_fixedDatumRecords.Count > 0)
            {
                for(int idx = 0; idx < _fixedDatumRecords.Count; idx++)
                {
                    result = GenerateHash(result) ^ _fixedDatumRecords[idx].GetHashCode();
                }
            }


            if(_variableDatumRecords.Count > 0)
            {
                for(int idx = 0; idx < _variableDatumRecords.Count; idx++)
                {
                    result = GenerateHash(result) ^ _variableDatumRecords[idx].GetHashCode();
                }
            }


            return result;
        }
    } // end of class
} // end of namespace