iparametervalue.h

#pragma once
 
#include "shared/interface/itensordata.h"
 
namespace fish {
    // ParameterDesc - describes how to get a single value (double, string, vector, or tensor) from a parameter.
    // Currently only works on a subset of parameter types.
    // Note: List assumes list of doubles
    enum class TreatAs { Scalar,Vector,Any,Tensor,List,String };
    enum class Component { X,Y,Z,Mag };
    using Quantity = shared::ITensorData::Quantity;
    struct IParameterValue {
        TreatAs   restrictType_ = TreatAs::Scalar; // What value you intent to ultimately pull from the parameter
        TreatAs   treatAs_ = TreatAs::Scalar;   // What value you are expecting from the parameter
        Component component_ = Component::Mag; // What scalar to pull from a vector
        Quantity  quantity_ = Quantity::XX; // What scalar to pull from a tensor
        uint64    listIndex_ = 0;   // What index to pull from a list
        bool      stress_ = false; // Does the tensor quantity represent a stress??
    };
}
// EoF