Group.h

Go to the documentation of this file.

#ifndef GROUP_H
#define GROUP_H

#include <Parameter.h>

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


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

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

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


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

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();


    //---- PARAMETERS ----/////
protected:
    std::vector<ezc3d::ParametersNS::GroupNS::Parameter> _parameters; 

public:
    size_t nbParameters() const;

    size_t parameterIdx(std::string parameterName) const;

    const ezc3d::ParametersNS::GroupNS::Parameter& parameter(size_t idx) const;

    ezc3d::ParametersNS::GroupNS::Parameter& parameter_nonConst(size_t idx);

    const ezc3d::ParametersNS::GroupNS::Parameter& parameter(std::string parameterName) const;

    ezc3d::ParametersNS::GroupNS::Parameter& parameter_nonConst(std::string parameterName);

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

    void parameter(const ezc3d::ParametersNS::GroupNS::Parameter& parameter);

    const std::vector<ezc3d::ParametersNS::GroupNS::Parameter>& parameters() const;

};

#endif