Click here to Skip to main content
15,867,453 members
Articles / Programming Languages / C#

Using OpenTK/OpenAL to Develop Cross Platform DIS VOIP Application

Rate me:
Please Sign up or sign in to vote.
4.79/5 (8 votes)
15 Mar 2010BSD10 min read 44.6K   1.7K   24  
Application allows voice communications (VOIP) utilizing the Distributed Interactive Simulation protocol (IEEE 1278.1)
// 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.5.1. Information about a request for supplies. 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(EntityID))]
    [XmlInclude(typeof(SupplyQuantity))]
    public partial class ServiceRequestPdu : LogisticsFamilyPdu
    {
        /** Entity that is requesting service */
        protected EntityID  _requestingEntityID = new EntityID(); 

        /** Entity that is providing the service */
        protected EntityID  _servicingEntityID = new EntityID(); 

        /** type of service requested */
        protected byte  _serviceTypeRequested;

        /** How many requested */
        protected byte  _numberOfSupplyTypes;

        /** padding */
        protected short  _serviceRequestPadding = 0;

        protected List<SupplyQuantity> _supplies = new List<SupplyQuantity>(); 

        /** Constructor */
        ///<summary>
        ///Section 5.3.5.1. Information about a request for supplies. COMPLETE
        ///</summary>
        public ServiceRequestPdu()
        {
            PduType = (byte)5;
        }

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

            marshalSize = base.getMarshalledSize();
            marshalSize = marshalSize + _requestingEntityID.getMarshalledSize();  // _requestingEntityID
            marshalSize = marshalSize + _servicingEntityID.getMarshalledSize();  // _servicingEntityID
            marshalSize = marshalSize + 1;  // _serviceTypeRequested
            marshalSize = marshalSize + 1;  // _numberOfSupplyTypes
            marshalSize = marshalSize + 2;  // _serviceRequestPadding
            for(int idx=0; idx < _supplies.Count; idx++)
            {
                SupplyQuantity listElement = (SupplyQuantity)_supplies[idx];
                marshalSize = marshalSize + listElement.getMarshalledSize();
            }

            return marshalSize;
        }


        ///<summary>
        ///Entity that is requesting service
        ///</summary>
        public void setRequestingEntityID(EntityID pRequestingEntityID)
        { 
            _requestingEntityID = pRequestingEntityID;
        }

        ///<summary>
        ///Entity that is requesting service
        ///</summary>
        public EntityID getRequestingEntityID()
        {
            return _requestingEntityID;
        }

        ///<summary>
        ///Entity that is requesting service
        ///</summary>
        [XmlElement(Type= typeof(EntityID), ElementName="requestingEntityID")]
        public EntityID RequestingEntityID
        {
            get
            {
                return _requestingEntityID;
            }
            set
            {
                _requestingEntityID = value;
            }
        }

        ///<summary>
        ///Entity that is providing the service
        ///</summary>
        public void setServicingEntityID(EntityID pServicingEntityID)
        { 
            _servicingEntityID = pServicingEntityID;
        }

        ///<summary>
        ///Entity that is providing the service
        ///</summary>
        public EntityID getServicingEntityID()
        {
            return _servicingEntityID;
        }

        ///<summary>
        ///Entity that is providing the service
        ///</summary>
        [XmlElement(Type= typeof(EntityID), ElementName="servicingEntityID")]
        public EntityID ServicingEntityID
        {
            get
            {
                return _servicingEntityID;
            }
            set
            {
                _servicingEntityID = value;
            }
        }

        ///<summary>
        ///type of service requested
        ///</summary>
        public void setServiceTypeRequested(byte pServiceTypeRequested)
        { 
            _serviceTypeRequested = pServiceTypeRequested;
        }

        [XmlElement(Type= typeof(byte), ElementName="serviceTypeRequested")]
        public byte ServiceTypeRequested
        {
            get
            {
                return _serviceTypeRequested;
            }
            set
            {
                _serviceTypeRequested = 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 getnumberOfSupplyTypes 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 setNumberOfSupplyTypes(byte pNumberOfSupplyTypes)
        {
            _numberOfSupplyTypes = pNumberOfSupplyTypes;
        }

        /// <summary>
        /// Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose.
        /// The getnumberOfSupplyTypes 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(byte), ElementName="numberOfSupplyTypes")]
        public byte NumberOfSupplyTypes
        {
            get
            {
                return _numberOfSupplyTypes;
            }
            set
            {
                _numberOfSupplyTypes = value;
            }
        }

        ///<summary>
        ///padding
        ///</summary>
        public void setServiceRequestPadding(short pServiceRequestPadding)
        { 
            _serviceRequestPadding = pServiceRequestPadding;
        }

        [XmlElement(Type= typeof(short), ElementName="serviceRequestPadding")]
        public short ServiceRequestPadding
        {
            get
            {
                return _serviceRequestPadding;
            }
            set
            {
                _serviceRequestPadding = value;
            }
        }

        public void setSupplies(List<SupplyQuantity> pSupplies)
        {
            _supplies = pSupplies;
        }

        public List<SupplyQuantity> getSupplies()
        {
            return _supplies;
        }

        [XmlElement(ElementName = "suppliesList",Type = typeof(List<SupplyQuantity>))]
        public List<SupplyQuantity> Supplies
        {
            get
            {
                return _supplies;
            }
            set
            {
                _supplies = 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
            {
                _requestingEntityID.marshal(dos);
                _servicingEntityID.marshal(dos);
                dos.writeByte((byte)_serviceTypeRequested);
                dos.writeByte((byte)_supplies.Count);
                dos.writeShort((short)_serviceRequestPadding);

                for(int idx = 0; idx < _supplies.Count; idx++)
                {
                    SupplyQuantity aSupplyQuantity = (SupplyQuantity)_supplies[idx];
                    aSupplyQuantity.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
            {
                _requestingEntityID.unmarshal(dis);
                _servicingEntityID.unmarshal(dis);
                _serviceTypeRequested = dis.readByte();
                _numberOfSupplyTypes = dis.readByte();
                _serviceRequestPadding = dis.readShort();
                for(int idx = 0; idx < _numberOfSupplyTypes; idx++)
                {
                    SupplyQuantity anX = new SupplyQuantity();
                    anX.unmarshal(dis);
                    _supplies.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("<ServiceRequestPdu>"  + System.Environment.NewLine);
            base.reflection(sb);
            try
            {
                sb.Append("<requestingEntityID>"  + System.Environment.NewLine);
                _requestingEntityID.reflection(sb);
                sb.Append("</requestingEntityID>"  + System.Environment.NewLine);
                sb.Append("<servicingEntityID>"  + System.Environment.NewLine);
                _servicingEntityID.reflection(sb);
                sb.Append("</servicingEntityID>"  + System.Environment.NewLine);
                sb.Append("<serviceTypeRequested type=\"byte\">" + _serviceTypeRequested.ToString() + "</serviceTypeRequested> " + System.Environment.NewLine);
                sb.Append("<supplies type=\"byte\">" + _supplies.Count.ToString() + "</supplies> " + System.Environment.NewLine);
                sb.Append("<serviceRequestPadding type=\"short\">" + _serviceRequestPadding.ToString() + "</serviceRequestPadding> " + System.Environment.NewLine);

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

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

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

        public static bool operator ==(ServiceRequestPdu a, ServiceRequestPdu 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 ServiceRequestPdu;
        }


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

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

            ivarsEqual = base.Equals(rhs);

            if( ! (_requestingEntityID.Equals( rhs._requestingEntityID) )) ivarsEqual = false;
            if( ! (_servicingEntityID.Equals( rhs._servicingEntityID) )) ivarsEqual = false;
            if( ! (_serviceTypeRequested == rhs._serviceTypeRequested)) ivarsEqual = false;
            if( ! (_numberOfSupplyTypes == rhs._numberOfSupplyTypes)) ivarsEqual = false;
            if( ! (_serviceRequestPadding == rhs._serviceRequestPadding)) ivarsEqual = false;

            if( ! (_supplies.Count == rhs._supplies.Count)) ivarsEqual = false;
            if(ivarsEqual)
            {
                for(int idx = 0; idx < _supplies.Count; idx++)
                {
                    if( ! ( _supplies[idx].Equals(rhs._supplies[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) ^ _requestingEntityID.GetHashCode();
            result = GenerateHash(result) ^ _servicingEntityID.GetHashCode();
            result = GenerateHash(result) ^ _serviceTypeRequested.GetHashCode();
            result = GenerateHash(result) ^ _numberOfSupplyTypes.GetHashCode();
            result = GenerateHash(result) ^ _serviceRequestPadding.GetHashCode();

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


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

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The BSD License


Written By
Software Developer
United States United States
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions