MFramesRange.h

/*****************************************************************************
**
**  Header file for Muster API Frames range object
**
**  Name    : MFramesRange.h
**  Author  : Leonardo Bernardini
**  Version : Alpha 9.0 Wed May 17th 2017
**
**  Copyright 2000-2017, Virtual Vertex
**  All Rights Reserved.
**
**  This file contains UNPUBLISHED PROPRIETARY SOURCE CODE.
**  The contents of this file may not be disclosed to third parties, copied
**  or duplicated in any form, in whole or in part, without the prior written
**  permission of the author.
**
*****************************************************************************/
#ifndef MFRAMESRANGE_H
#define MFRAMESRANGE_H

#ifdef WIN32

// Disable STL Export warning, member is private, we don't need direct access from the DLL client
#if defined(_WIN32)
#pragma warning(disable: 4251)
#endif // _WIN32

// Windows definitions
#ifdef MCLIENTLIB_EXPORTS
#define MCLIENTLIB_API __declspec(dllexport)
#else
#define MCLIENTLIB_API __declspec(dllimport)
#endif
#else

#ifndef MCLIENTLIB_EXPORTS
#ifdef LINUX
#define MCLIENTLIB_API
#else
#define MCLIENTLIB_API
#endif
#else
#define MCLIENTLIB_API
#endif

#endif

#include <string>
#include <set>
#include <list>
#include <map>

namespace MClientLib {

    class MCLIENTLIB_API MFramesRange {
    public:
        MFramesRange();
        MFramesRange(float _startFrame, float _endFrame, float _byFrame);
        MFramesRange(float _startFrame, float _endFrame, float _byFrame, int _numberBy, int _stepBy);
        static std::list<MFramesRange> FromString(const std::string& range);
        static bool IsOverlapping(const std::string& range);
        static std::map<std::string, std::string> TokenizeNumbers(const std::string& in);
        static std::set<long> NumberedFrames(std::list<MFramesRange> ranges, long& averageByFrame);
        static std::set<float> Frames(std::list<MFramesRange> ranges, long& averageByFrame);
        std::string ToString();
        std::set<float> Frames();
        std::set<long> NumberedFrames();
        std::list<MFramesRange> Packetize(int framesPerPacket);
        
        float GetStartFrame();
        float GetEndFrame();
        float GetByFrame();
        int GetNumberBy();
        int GetStepBy();

        void SetStartFrame(float);
        void SetEndFrame(float);
        void SetByFrame(float);
        void SetNumberBy(int);
        void SetStepBy(int);

    private:
        float startFrame;
        float endFrame;
        float byFrame;
        int numberBy;
        int stepBy;
    };

}

#endif