DIS_Producer.h

Go to the documentation of this file.

/*! \file DIS_Producer.h
  \brief  The DIS_Producer class.  Produces attributes from DIS Data PDUs.

  \par Copyright Information

  Copyright (c) 2012 The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBLITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/

#ifndef _DIS_PRODUCER_H
#define _DIS_PRODUCER_H

#include "ChunkProducer.h"
#include "DDD_AttributeUInt.h"
#include <map>

namespace disti
{

typedef unsigned char UINT_8;      /**< Unsigned int, 8 bits */
typedef unsigned short UINT_16;    /**< Unsigned int, 16 bits */
typedef unsigned int UINT_32;      /**< Unsigned int, 32 bits */

/** DIS Entity ID */
typedef struct
{
   UINT_16 site;  
   UINT_16 host;  
   UINT_16 entity;  
} ENTITY_ID;

/** DIS Protocol typedefs */
typedef UINT_8  DIS_EXERCISE_ID;
typedef UINT_8  DIS_VERSION;
typedef UINT_8  PROTOCOL_FAMILY;
typedef UINT_8  DIS_PDU_KIND;
typedef UINT_32 TIME_STAMP;

/** DIS Protocol defines */
#define SIMULATION_MANAGEMENT_FAMILY 5
#define SET_DATA_PDU_KIND 19

/** DIS Protocol header */
typedef struct
{
    DIS_VERSION      version;
    DIS_EXERCISE_ID  exercise;
    UINT_8           kind;
    PROTOCOL_FAMILY  family;
    TIME_STAMP       time_stamp;
    UINT_16          length;
    UINT_16          unused_16_2;
} DIS_PDU_HEADER;

/** DIS Set Data PDU structure */
typedef struct
{
    DIS_PDU_HEADER      header;
    ENTITY_ID           originating_entity_id;
    ENTITY_ID           receiving_entity_id;
    UINT_32             request_id;
    UINT_32             padding;
    UINT_32             number_fixed_datums;
    UINT_32             number_variable_datums;
} DIS_SET_DATA_VARIANT;

/** DIS Fixed Datum structure */
typedef struct
{
    UINT_32 datum_id;
    UINT_32 datum_value;
}  DIS_FIXED_DATA;

/** DIS Variable Datum structure */
typedef struct
{
    UINT_32 datum_id;
    UINT_32 datum_length;
}  DIS_VARIABLE_DATA;

/** DIS Producer class */
class DDD_EXPORT DIS_Producer : public ChunkProducer
{
    /** Processes an individual fixed or variable datum chunk
      * \param datumID  The DIS Datum ID of the chunk
      * \param chunk    Pointer to the chunk containing the datum minus the datum ID
      * \param length   Length of the datum chunk
      */
    void ProcessDatumChunk(unsigned long datumID,unsigned char *chunk,unsigned long length);

    /** Iterates through and processes the fixed datums of the Set Data PDU
      * \param pdu  Pointer to a SetDataPDU to process
      */
    void ProcessFixedDatums(DIS_SET_DATA_VARIANT *pdu);

    /** Iterates through and processes the variable datums of the Set Data PDU
      * \param pdu  Pointer to a SetDataPDU to process
      */
    void ProcessVariableDatums(DIS_SET_DATA_VARIANT *pdu);

    /** \return Returns true if any of the attributes of the chunk have been updated
      * param chunk  The chunk to check
      */
    bool NeedToUpdateChunk(ChunkDescription *chunk);

public:

    /** Constructor */
    DIS_Producer();

    /** Processes an inbound message, classifying it into chunks and then updating their associated
      * attributes. 
      * \param msgBuf  A buffer containing a message
      * \param receivedLength The length of the received message
      */
    virtual void ProcessMessage(unsigned char *msgBuf,unsigned int receivedLength);

    /** Builds an outbound message buffer.  Only implemented by ChunkProducers that send data.
      * \param msgBuf  A buffer to contain the message
      * \param maxMessageLength The max length of the message to build
      * \return The length of the message built or -1 if no message built
      */
    virtual int BuildMessage(unsigned char *msgBuf,unsigned int maxMessageLength, unsigned int chunkNumber);

    /* Function that implements the  DDD_AttributeObserver interface
     * \param attribute  Pointer to the attribute whose value just 
     * changed
     */
    virtual void OnAttributeChanged(DDD_AttributeBase *attribute);

    /** Perform any producer specific initialization
      */
    virtual void Start();

protected:
    DDD_AttributeUInt *_exerciseID;   /**< DIS Exercise ID.*/
    DDD_AttributeUInt *_DISVersion;   /**< DIS Version. */
    DDD_AttributeUInt *_sourceSite;   /**< Source DIS Site */
    DDD_AttributeUInt *_sourceHost;   /**< Source DIS Host */
    DDD_AttributeUInt *_sourceEntity; /**< Source DIS Entity */
    DDD_AttributeUInt *_destSite;     /**< Destination DIS Site */
    DDD_AttributeUInt *_destHost;     /**< Destination DIS Host */
    DDD_AttributeUInt *_destEntity;   /**< Destination DIS Entity */

    std::map<unsigned int,ChunkDescription*> _datumIDMap;  /**< Map of datum IDs to ChunkProducers */
};

/** Creator function for DIS_Producer used by ChunkProducerFactory */
DDD_EXPORT extern ChunkProducer *CreateDISProducer();

} // end of namespace disti

#endif