prmImageFrame.h

Go to the documentation of this file.

// file automatically generated, do not modify
// cisst version: 1.5.0
// source file: /Users/anton/devel/cisst-saw-doxygen/tmp/cisst-saw/cisst/cisstParameterTypes/code/../prmImageFrame.cdg
 
#pragma once
#ifndef _cisstParameterTypes_prmImageFrame_h
#define _cisstParameterTypes_prmImageFrame_h
 
#include <cisstCommon/cmnDataFunctions.h>
#include <cisstCommon/cmnDataFunctionsEnumMacros.h>
#if CISST_HAS_JSON
#include <cisstCommon/cmnDataFunctionsJSON.h>
#endif // CISST_HAS_JSON
 
/* source line: 1 */
 
 
 
 
// for mts-proxy 
#include <cisstCommon/cmnClassServices.h>
#include <cisstCommon/cmnClassRegisterMacros.h>
#include <cisstMultiTask/mtsGenericObjectProxy.h>
 
/* source line: 1 */
/* source line: 4 */
 
#include <cisstVector/vctDynamicVectorTypes.h>
#include <cisstVector/vctDynamicNArray.h>
#include <cisstMultiTask/mtsGenericObject.h>
// Always include last
#include <cisstParameterTypes/prmExport.h>
 
/* source line: 12 */
class CISST_EXPORT prmImageFrame: public mtsGenericObject
{
 /* default constructors and destructors. */
 public:
    prmImageFrame(void);
    prmImageFrame(const prmImageFrame & other);
    prmImageFrame & operator = (const prmImageFrame & other);
    ~prmImageFrame();
 
/* source line: 22 */
 protected:
    size_t mWidth; // Width
 public:
    /* accessors is set to: all */
#ifndef SWIG
     void GetWidth(size_t & placeHolder) const;
#endif
    inline  size_t GetWidth(void) const {
        return mWidth;
    }
     void SetWidth(const size_t & newValue);
    /* accessors is set to: all */
     const size_t & Width(void) const;
     size_t & Width(void);
/* source line: 28 */
 protected:
    size_t mHeight; // Height
 public:
    /* accessors is set to: all */
#ifndef SWIG
     void GetHeight(size_t & placeHolder) const;
#endif
    inline  size_t GetHeight(void) const {
        return mHeight;
    }
     void SetHeight(const size_t & newValue);
    /* accessors is set to: all */
     const size_t & Height(void) const;
     size_t & Height(void);
/* source line: 34 */
 protected:
    size_t mChannels; // Channels
 public:
    /* accessors is set to: all */
#ifndef SWIG
     void GetChannels(size_t & placeHolder) const;
#endif
    inline  size_t GetChannels(void) const {
        return mChannels;
    }
     void SetChannels(const size_t & newValue);
    /* accessors is set to: all */
     const size_t & Channels(void) const;
     size_t & Channels(void);
/* source line: 40 */
 protected:
    vctDynamicVector<char> mData; // Data
 public:
    /* accessors is set to: all */
#ifndef SWIG
     void GetData(vctDynamicVector<char> & placeHolder) const;
#endif
    inline  vctDynamicVector<char> GetData(void) const {
        return mData;
    }
     void SetData(const vctDynamicVector<char> & newValue);
    /* accessors is set to: all */
     const vctDynamicVector<char> & Data(void) const;
     vctDynamicVector<char> & Data(void);
/* source line: 45 */
 
    public:
 
    private:
        CMN_DECLARE_SERVICES(CMN_DYNAMIC_CREATION, CMN_LOG_ALLOW_DEFAULT);
        /* default methods */
 public:
    void SerializeRaw(std::ostream & outputStream) const override;
    void DeSerializeRaw(std::istream & inputStream) override;
    void ToStream(std::ostream & outputStream) const override;
    void ToStreamRaw(std::ostream & outputStream, const char delimiter = ' ',
                     bool headerOnly = false, const std::string & headerPrefix = "") const override;
    /* default data methods */
 public:
    void Copy(const prmImageFrame & source);
    void SerializeBinary(std::ostream & outputStream) const CISST_THROW(std::runtime_error);
    void DeSerializeBinary(std::istream & inputStream, const cmnDataFormat & localFormat, const cmnDataFormat & remoteFormat) CISST_THROW(std::runtime_error);
    void SerializeText(std::ostream & outputStream, const char delimiter = ',') const CISST_THROW(std::runtime_error);
    std::string SerializeDescription(const char delimiter = ',', const std::string & userDescription = "") const;
    void DeSerializeText(std::istream & inputStream, const char delimiter = ',') CISST_THROW(std::runtime_error);
    std::string HumanReadable(void) const;
    bool ScalarNumberIsFixed(void) const override;
    size_t ScalarNumber(void) const override;
    double Scalar(const size_t index) const CISST_THROW(std::out_of_range) override;
    std::string ScalarDescription(const size_t index, const std::string & userDescription = "") const CISST_THROW(std::out_of_range) override;
#if CISST_HAS_JSON
    void SerializeTextJSON(Json::Value & jsonValue) const override;
    void DeSerializeTextJSON(const Json::Value & jsonValue) CISST_THROW(std::runtime_error) override;
#endif // CISST_HAS_JSON
 
}; // prmImageFrame
 
// mts-proxy set to true
typedef mtsGenericObjectProxy<prmImageFrame> prmImageFrameProxy;
CMN_DECLARE_SERVICES_INSTANTIATION(prmImageFrameProxy);
 
/* default functions */
void CISST_EXPORT cmnSerializeRaw(std::ostream & outputStream, const prmImageFrame & object);
void CISST_EXPORT cmnDeSerializeRaw(std::istream & inputStream, prmImageFrame & placeHolder);
/* data functions */
template <> class cmnData<prmImageFrame > {
public: 
    enum {IS_SPECIALIZED = 1};
    typedef prmImageFrame DataType;
    static void Copy(DataType & data, const DataType & source) {
        data.Copy(source);
    }
    static std::string SerializeDescription(const DataType & data, const char delimiter, const std::string & userDescription) {
        return data.SerializeDescription(delimiter, userDescription);
    }
    static void SerializeBinary(const DataType & data, std::ostream & outputStream) CISST_THROW(std::runtime_error) {
        data.SerializeBinary(outputStream);
    }
    static void DeSerializeBinary(DataType & data, std::istream & inputStream, const cmnDataFormat & localFormat, const cmnDataFormat & remoteFormat) CISST_THROW(std::runtime_error) {
        data.DeSerializeBinary(inputStream, localFormat, remoteFormat);
    }
    static void SerializeText(const DataType & data, std::ostream & outputStream, const char delimiter = ',') CISST_THROW(std::runtime_error) {
        data.SerializeText(outputStream, delimiter);
    }
    static void DeSerializeText(DataType & data, std::istream & inputStream, const char delimiter = ',') CISST_THROW(std::runtime_error) {
        data.DeSerializeText(inputStream, delimiter);
    }
    static std::string HumanReadable(const DataType & data) {
        return data.HumanReadable();
    }
    static bool ScalarNumberIsFixed(const DataType & data) {
        return data.ScalarNumberIsFixed();
    }
    static size_t ScalarNumber(const DataType & data) {
        return data.ScalarNumber();
    }
    static std::string ScalarDescription(const DataType & data, const size_t index, const std::string & userDescription = "") CISST_THROW(std::out_of_range) {
        return data.ScalarDescription(index, userDescription);
    }
    static double Scalar(const DataType & data, const size_t index) CISST_THROW(std::out_of_range) {
        return data.Scalar(index);
    }
};
inline std::ostream & operator << (std::ostream & outputStream, const prmImageFrame & data) {
    outputStream << cmnData<prmImageFrame >::HumanReadable(data);
    return outputStream;
}
#if CISST_HAS_JSON
template <> void CISST_EXPORT cmnDataJSON<prmImageFrame >::SerializeText(const prmImageFrame & data, Json::Value & jsonValue);
template <> void CISST_EXPORT cmnDataJSON<prmImageFrame >::DeSerializeText(prmImageFrame & data, const Json::Value & jsonValue) CISST_THROW(std::runtime_error);
#endif // CISST_HAS_JSON
 
/* source line: 54 */
 
CMN_DECLARE_SERVICES_INSTANTIATION(prmImageFrame);
 
 
#endif // _cisstParameterTypes_prmImageFrame_h