GridDataType1.h

Go to the documentation of this file.

/*********************************************************************
Copyright 2013 Karl Jones
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer. 
2. 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. 

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.

For Further Information Please Contact me at
Karljj1@yahoo.com
http://p.sf.net/kdis/UserGuide
*********************************************************************/

/********************************************************************
    class:      GridDataType1
    created:    20/11/2009
    author:     Karl Jones

    purpose:    The Grid Data record contains the actual environmental state variable data for
                each grid location. This record specifes the data sample type, the format by
                which the data are represented, feld scale factor and offset values,
                and the actual data values in 16-bit.

    size:       128 bits / 16 octets - Min size
*********************************************************************/

#pragma once

#include "./GridData.h"
#include <vector>

namespace KDIS {
namespace DATA_TYPE {

class KDIS_EXPORT GridDataType1 : public GridData
{
protected:

    KFLOAT32 m_f32FieldScale;

    KFLOAT32 m_f32FieldOffset;

    KUINT16 m_ui16NumValues;

    std::vector<KUINT16> m_vui16Values;

    KUINT16 m_ui16Padding;

public:

    static const KUINT16 GRID_DATA_TYPE1_SIZE = 16; // Min size

    GridDataType1();

    GridDataType1( KDataStream & stream ) throw( KException );

    // This constructor is used by the Gridded_Data_PDU. In order to know what type of grid
    // data we have we must decode the first 2 values.So this constructor is here to aid in this process.
    GridDataType1( KUINT16 SampleType, KUINT16 DataRepresentation, KDataStream & stream );

    GridDataType1( KUINT16 SampleType, KFLOAT32 FieldScale, KFLOAT32 FieldOffset,
                   const std::vector<KUINT16> & Values );

    virtual ~GridDataType1();

    //************************************
    // FullName:    KDIS::DATA_TYPE::GridDataType1::SetFieldScale
    //              KDIS::DATA_TYPE::GridDataType1::GetFieldScale
    //!Description: Specifies the constant scale factor used to scale the environmental
    //!             state variable data values contained in this record.
    // Parameter:   KFLOAT32 FS
    //************************************
    void SetFieldScale( KFLOAT32 FS );
    KFLOAT32 GetFieldScale() const;

    //************************************
    // FullName:    KDIS::DATA_TYPE::GridDataType1::SetFieldOffset
    //              KDIS::DATA_TYPE::GridDataType1::GetFieldOffset
    //!Description: Specifies the constant offset used to scale the environmental state
    //!             variable data values contained in this record.
    // Parameter:   KFLOAT32 FO
    //************************************
    void SetFieldOffset( KFLOAT32 FO );
    KFLOAT32 GetFieldOffset() const;

    //************************************
    // FullName:    KDIS::DATA_TYPE::GridDataType1::SetFieldOffset
    //              KDIS::DATA_TYPE::GridDataType1::GetFieldOffset
    //!Description: The Number of environmental state variable data values contained in this record.
    //************************************
    KUINT16 GetNumberOfValues() const;

    //************************************
    // FullName:    KDIS::DATA_TYPE::GridDataType1::AddValue
    //              KDIS::DATA_TYPE::GridDataType1::SetValues
    //              KDIS::DATA_TYPE::GridDataType1::GetValues
    //              KDIS::DATA_TYPE::GridDataType1::ClearValues
    //!Description: The environmental state variable data values.
    // Parameter:   KUINT16 V, const vector<KUINT16> & V
    //************************************
    void AddValue( KUINT16 V );
    void SetValues( const std::vector<KUINT16> & V );
    const std::vector<KUINT16> & GetValues() const;
    void ClearValues();

    //************************************
    // FullName:    KDIS::DATA_TYPE::GridDataType1::GetDataRepresentation
    //!Description: Returns the size of the whole Grid Data type object in octets.
    //!             Note: This information is not encoded into the PDU, it is here for the
    //!             internal calculation of the PDU length value.
    //************************************
    virtual KUINT16 GetSize() const;

    //************************************
    // FullName:    KDIS::DATA_TYPE::GridDataType1::GetAsString
    //!Description: Returns a string representation
    //************************************
    virtual KString GetAsString() const;

    //************************************
    // FullName:    KDIS::DATA_TYPE::GridDataType1::Decode
    //!Description: Convert From Network Data.
    // Parameter:   KDataStream & stream
    //************************************
    virtual void Decode( KDataStream & stream ) throw( KException );

    //************************************
    // FullName:    KDIS::DATA_TYPE::GridDataType1::Encode
    //!Description: Convert To Network Data.
    // Parameter:   KDataStream & stream
    //************************************
    virtual KDataStream Encode() const;
    virtual void Encode( KDataStream & stream ) const;

    KBOOL operator == ( const GridDataType1 & Value ) const;
    KBOOL operator != ( const GridDataType1 & Value ) const;
};

} // END namespace DATA_TYPES
} // END namespace KDIS