MHistoryChunk.h

/*****************************************************************************
 **
 **  Header file for Muster API History chunk object
 **
 **  Name    : MRepository.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 MHISTORYCHUNK_H
#define MHISTORYCHUNK_H

#ifdef 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


// 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

#include <string>
#include <list>
#include <vector>

#include "MTextFileMarker.h"
#include "MChunkUsage.h"

namespace MClientLib {

    class MCLIENTLIB_API MHistoryChunk {
    public:

        enum kHistoryChunksStatus {
            kHistoryChunkStatusCompleted = 0x01, 
            kHistoryChunkStatusWarning = 0x02, 
            kHistoryChunkStatusAborted = 0x04, 
            kHistoryChunkStatusError = 0x08,  
            kHistoryChunkStatusTimeout = 0x10 
        };

    private:
        long id;
        long jobId;
        int status;
        float startFrame;
        float endFrame;
        float byFrame;
        long long int startTime;
        long long int endTime;
        std::string renderingHost;
        std::string result;
        long chunkId;
        int startingNumber;
        int packetType;
        bool isAssembler;
        std::string jobName;
        std::string jobGroup;
        std::string jobDepartment;
        std::string jobFile;
        std::string jobProject;
        std::string task;
        int stepBy;
        int packetSize;
        int platform;
        int exitCode;
        std::vector<MClientLib::MTextFileMarker> warningMarkers;
        std::vector<MClientLib::MTextFileMarker> errorMarkers;
        std::vector<MClientLib::MTextFileMarker> silencedWarningMarkers;
        std::vector<MClientLib::MTextFileMarker> silencedErrorMarkers;
        std::string jobOwner;

    public:
        MHistoryChunk();
        virtual ~MHistoryChunk();

        long getId();
        long getJobId();
        int getStatus();
        int getPacketType();
        float getStartFrame();
        float getEndFrame();
        float getByFrame();
        long long int getStartTime();
        long long int getEndTime();
        std::string getRenderingHost();
        std::string getResult();
        long getChunkId();
        int getStartingNumber();
        bool getIsAssembler();
        int getPlatform();
        int getExitCode();
        std::string getJobName();
        std::string getJobGroup();
        std::string getJobDepartment();
        std::string getJobFile();
        std::string getJobProject();
        std::string getTask();
        int getStepBy();
        int getPacketSize();
        virtual std::vector<MClientLib::MTextFileMarker> getWarningMarkers();
        virtual std::vector<MClientLib::MTextFileMarker> getErrorMarkers();
        virtual std::vector<MClientLib::MTextFileMarker> getSilencedWarningMarkers();
        virtual std::vector<MClientLib::MTextFileMarker> getSilencedErrorMarkers();
        virtual std::string getJobOwner();

        void setId(long);
        void setJobId(long);
        void setStatus(int);
        void setStartFrame(float);
        void setEndFrame(float);
        void setByFrame(float);
        void setStartTime(long long int);
        void setEndTime(long long int);
        void setRenderingHost(const std::string&);
        void setResult(const std::string&);
        void setChunkId(long);
        void setStartingNumber(int);
        void setIsAssembler(bool);
        void setPlatform(int);
        void setExitCode(int);
        void setJobName(const std::string&);
        void setJobGroup(const std::string&);
        void setJobDepartment(const std::string&);
        void setJobFile(const std::string&);
        void setJobProject(const std::string&);
        void setTask(const std::string&);
        void setStepBy(int);
        void setPacketSize(int);
        void setPacketType(int);
        void setJobOwner(const std::string&);
        virtual void setWarningMarkers(const std::vector<MClientLib::MTextFileMarker>& _warningMarkers); 
        virtual void setErrorMarkers(const std::vector<MClientLib::MTextFileMarker>& _errorMarkers); 
        virtual void setSilencedWarningMarkers(const std::vector<MClientLib::MTextFileMarker>& _warningMarkers); 
        virtual void setSilencedErrorMarkers(const std::vector<MClientLib::MTextFileMarker>& _errorMarkers); 
        bool Unmarshall(const std::vector<std::string>& items); 
        bool Unmarshall(const char* data); 
        std::string Marshall(); 
        void castedRelease();
    };

}

#endif