seInterface.h

Go to the documentation of this file.

// Copyright JRM Enterprises, Inc. 2004
// 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:  MWO         Date: Nov 2004
//
// $Header: 
//
// $Log: 
//

#ifndef _seINTERFACE_H_
#define _seINTERFACE_H_

//common interface includes
//#include "seIncAll.h"
#include "ciOptics.h"
#include "ciDetector.h"
#include "ciElectronics.h"
#include "ciSenSim.h"

//sensim/sensoreffects includes
#include "seSenSim.h"
#include "seOptics.h"
#include "seDetector.h"
#include "seElectronics.h"
#include "ciInterface.h"

// class: seInterface
//
// description: CI to SE (sensor effecs/sensim) interface class
//
class SENSOREFFECTS_API seInterface
{
public:

    // copySensorEffects
    void copySensorEffects(seSenSim *seData, bool copyToCI = false, int index = -1);

    // copyOptics
    void copyOptics(seOptics *seOpticsData, bool copyToCI = false, int index = -1);

    // copyDetector
    void copyDetector(seDetector *seDetectorData, bool copyToCI = false, int index = -1);

    // copyElectronics
    void copyElectronics(seElectronics *seElectronicsData, bool copyToCI = false, int index = -1);

    // modifySeStringPath
    std::string modifySeStringPath(char *stringToModify, bool copyToCI = false);

    // setDataDirectoryForSenSim
    void setDataDirectoryForSenSim(char *path);


    // getDataDirectoryForSenSim
    char *getDataDirectoryForSenSim() { return m_dataDirectoryPath; }

    // seInterface
    seInterface();

    // ~seInterface
    virtual ~seInterface();

    // * \par
    // * Sets the sensor effects enable flags in the interface.
    // *
    // * \param   flag - flag data to be assigned
    // */
    //   void setSensorEffectsFlags(int flag) { m_enableFlags = flag; }
    //
    // * \par
    // * Gets the sensor effects enable flags in the interface.
    // *
    // * \return sensor effects enable flags
    // */
    //   int isSensorEffectsOn() { return m_enableFlags & 0x8; }
    //
    // * \par
    // * indicates that filtering is on.
    // *
    // * \return flag indicating whether filtering is on.
    // */
    //   int isFilterOn() { return m_enableFlags & 0x1; }
    //
    // * \par
    // * indicates that noise processing is on.
    // *
    // * \return flag indicating whether noise processing is on.
    // */
    //   int isNoiseOn() { return m_enableFlags & 0x2; }
    //
    // * \par
    // * indicates that gain and level processing is on.
    // *
    // * \return flag indicating whether gain and level processing is on.
    // */
    //   int isGainOn() { return m_enableFlags & 0x4; }

protected:

    int m_enableFlags;

    ciInterface *m_ciInterfaceSe;

    char m_dataDirectoryPath[255];
}; 

#endif // _seINTERFACE_H_