ssMaterialProperties.h

Go to the documentation of this file.

// Copyright JRM Enterprises, Inc. 2006
// All rights reserved.
//
// This code is the intellectual property of JRM Enterprises, Inc.
// It may not be used or released as source or compiled binary form
// without the prior written consent of JRM Enterprises, Inc.
//
// Original Author:     Tom Rix     Date: Sep 2006

#ifndef _ssMaterialProperties_
#define _ssMaterialProperties_

#include "ssdllexport.h"
#include "ssIncAll.h"

#include <memory>

#ifndef NEIGENMATERIALS
#define NEIGENMATERIALS 6
#endif

// ssMaterialProperties
class SIGSIMRT_API ssMaterialProperties
{

public:
   using MaterialSystemTablePtrType = std::shared_ptr<MATL_PROP_TABLE>;

    //   ssMaterialProperties
    ssMaterialProperties();

    //ssMaterialProperties
    ~ssMaterialProperties();

    //setMaterialSystemFileName
    void setMaterialSystemFileName(char *name);

    //setSigSimDataDirectory
    void setSigSimDataDirectory(char *name);

    //setSigSimCacheDirectory
    void setSigSimCacheDirectory(char *name);

   //checkValidity
   void checkValidity();

    //isValid
    bool isValid();

    //getNumberMaterials
    unsigned int getNumberMaterials();
    

    //getNumberLayers
    unsigned int getNumberLayers(unsigned int materialIndex);

    //getNumberWavelengths
    unsigned int getNumberWavelengths(unsigned int materialIndex);

    //getMaterialName
    char *getMaterialName(unsigned int materialIndex);
    
    //setMaterialName
    void setMaterialName(unsigned int materialIndex, char *matName);

    //getIntensityModulationScalarParameter
   double getIntensityModulationScalarParameter(unsigned int material, bool visualBand);

    //getAltitude
    bool getAltitude (unsigned int materialIndex, double &altitude);

    //setAltitude
    void setAltitude (unsigned int materialIndex, double altitude);

    //getShadowFlag
    bool getShadowFlag (unsigned int materialIndex, double &shadow);

    //setShadowFlag
    void setShadowFlag (unsigned int materialIndex, double shadow);

    //getUpperBoundaryConditionType
    bool getUpperBoundaryConditionType (unsigned int materialIndex, unsigned int &boundaryConditionType);

    //setUpperBoundaryConditionType
    void setUpperBoundaryConditionType (unsigned int materialIndex, unsigned int boundaryConditionType);


    //getUpperBoundaryConditionType
    const char *getUpperBoundaryConditionType (unsigned int materialIndex);

    //getUpperBoundaryTemperature
    bool getUpperBoundaryTemperature (unsigned int materialIndex, double &temperature);

    //setUpperBoundaryTemperature
    bool setUpperBoundaryTemperature (unsigned int materialIndex, double temperature);

    //getUpperBoundaryWindSpeed
    bool getUpperBoundaryWindSpeed (unsigned int materialIndex, double &windSpeed);

    //setUpperBoundaryWindSpeed
    bool setUpperBoundaryWindSpeed (unsigned int materialIndex, double windSpeed);

    //getUpperBoundaryHeatLoad
    bool getUpperBoundaryHeatLoad (unsigned int materialIndex, double &heatLoad);

    //setUpperBoundaryHeatLoad
    bool setUpperBoundaryHeatLoad (unsigned int materialIndex, double heatLoad);

    //getLowerBoundaryConditionType
    bool getLowerBoundaryConditionType (unsigned int materialIndex, unsigned int &boundaryConditionType);

    //setLowerBoundaryConditionType
    void setLowerBoundaryConditionType (unsigned int materialIndex, unsigned int boundaryConditionType);

    //getLowerBoundaryConditionType
    const char *getLowerBoundaryConditionType (unsigned int materialIndex);

    //getLowerBoundaryTemperature
    bool getLowerBoundaryTemperature (unsigned int materialIndex, double &temperature);

    //setLowerBoundaryTemperature
    bool setLowerBoundaryTemperature (unsigned int materialIndex, double temperature);

    //getLowerBoundaryWindSpeed
    bool getLowerBoundaryWindSpeed (unsigned int materialIndex, double &windSpeed);

    //setLowerBoundaryWindSpeed
    bool setLowerBoundaryWindSpeed (unsigned int materialIndex, double windSpeed);


    //getLowerBoundaryHeatLoad
    bool getLowerBoundaryHeatLoad (unsigned int materialIndex, double &heatLoad);

    //setLowerBoundaryHeatLoad
    bool setLowerBoundaryHeatLoad (unsigned int materialIndex, double heatLoad);

    //getReflectType
    bool getReflectType(unsigned int materialIndex, unsigned int wavelengthIndex, enum ReflectType &reflectType);

    //getReflectType
    const char *getReflectType(unsigned int materialIndex, unsigned int wavelengthIndex);

    //setReflectType
    void setReflectType(unsigned int materialIndex, unsigned int wavelengthIndex, enum ReflectType &reflectType);

    //getDHR
    bool getDHR(unsigned int materialIndex, unsigned int wavelengthIndex, double &DHR);

    //setDHR
    void setDHR(unsigned int materialIndex, unsigned int wavelengthIndex, double DHR);

    //getPercentSpecular
    bool getPercentSpecular(unsigned int materialIndex, unsigned int wavelengthIndex, double &PercentSpecular);

    //setPercentSpecular
    void setPercentSpecular(unsigned int materialIndex, unsigned int wavelengthIndex, double PercentSpecular);


    //getLobeWidth
    bool getLobeWidth(unsigned int materialIndex, unsigned int wavelengthIndex, double &LobeWidth);

    //setLobeWidth
    void setLobeWidth(unsigned int materialIndex, unsigned int wavelengthIndex, double LobeWidth);


    //isValidMaterialIndex
    bool isValidMaterialIndex(unsigned int materialIndex);

    //isValidMaterialLayerIndex
    bool isValidMaterialLayerIndex(unsigned int materialIndex, unsigned int layerIndex);

    //isValidMaterialWavelengthIndex
    bool isValidMaterialWavelengthIndex(unsigned int materialIndex, unsigned int wavelengthIndex);

    //setUpdateTimeofDay
    void setUpdateTimeofDay (unsigned int materialIndex, JRMTIME time);
    
    //getUpdateTimeofDay
   bool getUpdateTimeofDay (unsigned int materialIndex, JRMTIME &time);


    //recomputeTwoSidedFlag
   bool recomputeTwoSidedFlag (unsigned int materialIndex);


    //*getMaterialPropertyTablePtr
   MaterialSystemTablePtrType getMaterialPropertyTablePtr();

    //getEnvironmentUpdateInterval
    double getEnvironmentUpdateInterval();


    //setEnvironmentUpdateInterval
    void setEnvironmentUpdateInterval(double interval);

    //hasChanged
    bool hasChanged();


protected:

    //validate
    bool validate ();

    //clean
    void clean ();

    MaterialSystemTablePtrType m_materialPropertyTablePtr;

    unsigned int m_numMaterials;

    unsigned int m_numTemperatures;

    char m_dataDirectory[256];
    char m_cacheDirectory[256];
    char m_materialSystemFileName[256];
    char m_timeStamp[256];
    double m_updateInterval;

   // flag to know when paths have changed and the validate step needs to be run.
   bool needToValidate;
};

#endif // _ssMaterialProperties_