Parameter.h

Go to the documentation of this file.

#ifndef PARAMETER_H
#define PARAMETER_H

#include <ezc3d.h>

class EZC3D_API ezc3d::ParametersNS::GroupNS::Parameter{
    //---- CONSTRUCTOR ----//
public:
    Parameter(const std::string &name = "", const std::string &description = "");


    //---- STREAM ----//
public:
    void print() const;

    void write(std::fstream &f, int groupIdx, std::streampos &dataStartPosition) const;

protected:
    size_t writeImbricatedParameter(std::fstream &f, const std::vector<size_t> &dim, size_t currentIdx=0, size_t cmp=0) const;

public:
    int read(c3d &c3d,
             const Parameters &params,
             std::fstream &file,
             int nbCharInName);


    //---- METADATA ----//
protected:
    std::string _name; 
    std::string _description; 
    bool _isLocked; 
    ezc3d::DATA_TYPE _data_type; 

public:
    const std::string& name() const;

    void name(const std::string name);

    const std::string& description() const;

    void description(const std::string description);

    bool isLocked() const;

    void lock();

    void unlock();


    //---- DATA DIMENSIONS ----//
protected:
    std::vector<size_t> _dimension; 

public:
    const std::vector<size_t> dimension() const;

    bool isDimensionConsistent(size_t dataSize, const std::vector<size_t>& dimension) const;


    //---- DATA ----//
protected:
    std::vector<int> _param_data_int; 
    std::vector<float> _param_data_float; 
    std::vector<std::string> _param_data_string; 

public:
    ezc3d::DATA_TYPE type() const;

    const std::vector<int>& valuesAsByte() const;

    const std::vector<int>& valuesAsInt() const;

    const std::vector<float>& valuesAsFloat() const;

    const std::vector<std::string>& valuesAsString() const;

    void set(int data);

    void set(size_t data);

    void set(const std::vector<int>& data, const std::vector<size_t>& dimension = {});

    void set(float data);

    void set(double data);

    void set(const std::vector<float>& data, const std::vector<size_t>& dimension = {});

    void set(const std::string& data);

    void set(const std::vector<std::string>& data, const std::vector<size_t>& dimension = {});

};


#endif