Home

Libraries

Author

Links

---

binmsg.hpp

Go to the documentation of this file.

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is the SysToMath C++ Libraries package (LibStmCpp).
 *
 * The Initial Developer of the Original Code is
 * Tom Michaelis, SysToMath.
 * Portions created by the Initial Developer are Copyright (C) 2003-2006
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

/******************************************************************************
 *                            First Release 2003-03-15
 ******************************************************************************/


#ifndef STM_TOOLAIDS_BINMSG_HPP
#define STM_TOOLAIDS_BINMSG_HPP


// Include header files for implementation.
#include <stm/toolaids/impl/xbinmsg.hpp>


// Include BaseMessage base class template implementation.
#include <stm/toolaids/impl/xbinmsg.hpp>


namespace stm
{


namespace tools
{









template <class DataT, class InputRangeT, class ContextT>
class BaseMessageContext :
    private local::xBaseMessageContext<DataT, InputRangeT, ContextT>
{
    typedef local::xBaseMessageContext
    <
        DataT,
        InputRangeT,
        ContextT
    > BaseMessageContextImpl;

public:
    typedef DataT data_type;

    typedef InputRangeT inputrange_type;

    typedef ContextT context_type;
    
    typedef MsgTimestamp Timestamp;

    BaseMessageContext (data_type &data, inputrange_type &input);

    const std::string &type () const;

    void setType (const std::string &type);

    const Timestamp &timestamp () const;

    void setTimestamp (const Timestamp &timestamp);

    data_type &data ();

    inputrange_type &input ();
};


template <class ContextT>
class BaseMessage :
    public byte_iterator_range,
    private local::xBaseMessage<ContextT>
{
    typedef local::xBaseMessage<ContextT> BaseMessageImpl;

public:
    typedef ContextT context_type;

    typedef BaseMessage<ContextT> basemessage_type;

    typedef typename context_type::Timestamp Timestamp;

    enum
    {
        WordSize         = 4
    };

    enum
    {
        NoFlags          = 0x00000000,
        ThrowOnError     = 0x00000001
    };

    enum
    {
        NoError          = 0x00000000,
        OutOfSync        = 0x00000001,
        ConsistencyError = 0x00000002
    };

    virtual ~BaseMessage ();

    virtual const std::string &type () const = 0;

    dword flags () const;

    dword status () const;

    const Timestamp &timestamp () const;

    context_type &context ();

    const byte_iterator_range &body () const;

protected:
    BaseMessage
    (
        const byte *first,
        const byte *last,
        context_type &context,
        dword flags = NoFlags,
        dword status = NoError
    );

    void setStatus (dword val);

    void setBody (const byte_iterator_range &body);

    void setUdpTimestamp
    (
        word bfn,
        dword bordTimeSec,
        word boardTimeMs,
        dword seqNo
    );

    void setFpgaTimestamp
    (
        word bfn,
        byte slot,
        word chip
    );
};


}  // namespace tools.


}  // namespace stm.


// Include BinMessageContext base class template implementation.
#include <stm/toolaids/impl/xbinmsg.hpp>


namespace stm
{


namespace tools
{










template <class DataT, class InputRangeT, class ContextT>
class BinMessageContext :
    public BaseMessageContext <DataT, InputRangeT, ContextT>,
    private local::xBinMessageContext<ContextT>
{
    typedef local::xBinMessageContext<ContextT> BinMessageContextImpl;

    friend class local::xBinMessage<ContextT>;

public:
    typedef DataT data_type;

    typedef InputRangeT inputrange_type;

    typedef ContextT context_type;

    typedef BaseMessage<ContextT> basemessage_type;

    class Gap : private local::xBinMessageGap
    {
        friend class BinMessageContext<DataT, InputRangeT, ContextT>;

    public:
        Gap ();

        operator bool () const;

        long long offset () const;

        long long length () const;
    };

    BinMessageContext (data_type &data, inputrange_type &input);

    const Gap &gap () const;

    template <template <class> class Message> bool registerMessageType ();
};


template <class ContextT>
class BinMessage :
    public byte_iterator_range,
    private local::xBinMessage<ContextT>
{
    typedef local::xBinMessage<ContextT> BinMessageImpl;

public:
    typedef ContextT context_type;

    typedef BaseMessage<ContextT> basemessage_type;

    typedef typename basemessage_type::Timestamp Timestamp;

    enum
    {
        NoFlags          = 0x00000000,
        ThrowOnError     = basemessage_type::ThrowOnError
    };

    enum
    {
        NoError          = 0x00000000,
        OutOfSync        = basemessage_type::OutOfSync,
        ConsistencyError = basemessage_type::ConsistencyError
    };

    BinMessage
    (
        const byte *first,
        const byte *last,
        context_type &context,
        dword flags = NoFlags
    ) throw (std::exception);

    virtual ~BinMessage ();

    const std::string &type () const;

    dword flags () const;

    dword status () const;

    const Timestamp &timestamp () const;

    const byte_iterator_range &body () const;

    context_type &context ();
};


}  // namespace tools.


}  // namespace stm.


// Include inline and template implementation.
#include <stm/toolaids/impl/xbinmsg.hpp>


#endif  // STM_TOOLAIDS_BINMSG_HPP

---

© Copyright Tom Michaelis 2002-2007

Distributed under the SysToMath Software License (See the accompanying file license.txt or a copy at www.SysToMath.com).