Parameter.h

Go to the documentation of this file.

/*
 * openSF Integration Libraries (OSFI)
 * Deimos Space, S.L.U.
 * 
 * This file is part of OSFI. OSFI is free software; you can redistribute it
 * and/or modify it under the terms of the 'ESA Software Community Licence Permissive' as
 * published by the European Space Agency; either version 2.4 of the License,
 * or (at your option) any later version. You should have received a
 * copy of the 'ESA Software Community Licence Permissive - v2.4' along with this program
 * or one can be found at <http://eop-cfi.esa.int/index.php/docs-and-mission-data/licensing-documents>.
 */
 
#ifndef OSFI_CONFM_PARAMETER_H_
#define OSFI_CONFM_PARAMETER_H_
 
#include "ConFM/base.h"
#include "ConFM/DynamicArray.h"
#include "ConFM/ArrayNode.h"
 
using namespace std;
 
class Parameter final
{
public:
    using ElementType = osfi::confm::ElementType; // Alias kept for API compatibility
 
    Parameter(string aName, string aDescription, string aType,
        ArrayNode root, string aUnits, string aMin, string aMax, vector<int> dims);
 
    Parameter(string aName, string aDescription, string aType, string aValue);
 
    Parameter(string aName, string aDescription, string aType, string aValue,
            string aUnits, string aMin, string aMax, vector<int> dims);
 
    OSFI_DEPRECATED("Use the constructor with 8 arguments instead.")
    Parameter(string aName, string aMin, string aMax);
 
    Parameter();
 
    void print() const;
 
    OSFI_DEPRECATED("Ambiguously-named function to be removed, use getRawValue instead.")
    string getValue();
 
    string getRawValue() const;
 
    int getIntValue() const;
 
    double getDoubleValue() const;
 
    bool getBooleanValue() const;
 
    string getStringValue() const;
 
    osfi::confm::TimeValue getTimeValue() const;
 
    string getFileValue() const;
 
    vector<string> getVectorString() const;
 
    vector<string> getVectorFile() const;
 
    vector<double> getVectorDouble() const;
 
    vector<int> getVectorInt() const;
 
    vector<bool> getVectorBoolean() const;
 
    vector<osfi::confm::TimeValue> getVectorTime() const;
 
    DynamicArray<double> getMatrixDouble() const;
 
    DynamicArray<int> getMatrixInt() const;
 
    DynamicArray<string> getMatrixString() const;
 
    DynamicArray<string> getMatrixFile() const;
 
    DynamicArray<bool> getMatrixBoolean() const;
 
    DynamicArray<osfi::confm::TimeValue> getMatrixTime() const;
 
    DynamicArray<bool> fileExist() const;
 
    OSFI_DEPRECATED("Changing values is deprecated and might not work with ARRAY parameters")
    void setValue(string aValue);
 
    int getNdims() const;
 
    const vector<int>& getDims() const;
 
    OSFI_DEPRECATED("Ambiguous function, instead use getLocalName or getPath")
    string getName();
 
    string getLocalName() const;
 
    string getPath() const;
 
    string getDescription() const;
 
    string getUnits() const;
 
    string getMax() const;
 
    string getMin() const;
 
    string getType() const;
 
    OSFI_DEPRECATED("Superseded by getElementType and isArray")
    int getParamType();
 
    ElementType getElementType() const;
 
    static const string delimitier;
 
    static const string stringDelimitier;
 
    bool isArray() const;
 
    const ArrayNode& getRootNode() const;
    const ArrayNode& getNode(const vector<int>& indexs) const;
    vector<bool> getVectorBoolean(const vector<int>& indexs) const;
    vector<string> getVectorString(const vector<int>& indexs) const;
    vector<string> getVectorFile(const vector<int>& indexs) const;
    vector<double> getVectorDouble(const vector<int>& indexs) const;
    vector<int> getVectorInt(const vector<int>& indexs) const;
    vector<osfi::confm::TimeValue> getVectorTime(const vector<int>& indexs) const;
    int getDims(const vector<int>& indexs) const;
    bool isLeaf(const vector<int>& indexs) const;
 
private:
    bool FileExists(const string& strFilename) const;
 
    string name; 
    string description; 
    ElementType elType; 
    string value_; 
    string units; 
    string min; 
    string max; 
    vector<int> dims; 
    ArrayNode root_; 
    bool isArrayParam = false; 
};
 
#endif // OSFI_CONFM_PARAMETER_H_