ciOcean.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:  Tim George
// Date:       Sep 2006
//
//
//
//

#if !defined(AFX_CIOCEAN_H__DE81EF86_CAA9_471E_AE7A_9087CD4CB282__INCLUDED_)
#define AFX_CIOCEAN_H__DE81EF86_CAA9_471E_AE7A_9087CD4CB282__INCLUDED_

#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000
#include "ciApi.h"

#include <iostream>
#include <fstream>
#include "clXML.h"
#include "clXMLNode.h"

class CI_API ciOcean  
{
public:     // contructors, destructors and assignment operators

    // ciOcean
    ciOcean();

    // ciOcean
    ciOcean(ciOcean &obj);

    // ~ciOcean
    virtual ~ciOcean();

    // operator =
    ciOcean operator =(ciOcean &obj);

public:     // methods

    // archive
    bool archive(std::ofstream &outf);

    // serialize
    bool serialize(char *filepath);

    //
    // loadXML
    //
    // \par Description:
    // Loads attributes from an XML node
    //
    // \param clXMLNode* oceanNode
    // \return bool
    //
    bool loadXML(clXMLNode* oceanNode);

    //
    // parseXML
    //
    // \par Description:
    // Parses an XML document for specific tags
    //
    // \param clXML xmlDocument
    // \return bool
    //
    bool parseXML(clXML& xmlDocument);

    //loadXMLNode
    bool loadXMLNode(std::string tag, char *nodeString);
    //loadXMLNode
    bool loadXMLNode(std::string tag, bool *nodeBool);
    //loadXMLNode
    bool loadXMLNode(std::string tag, int *nodeBool);
    //loadXMLNode
    bool loadXMLNode(std::string tag, double *nodeBool);

    //
    // saveXML
    //
    // \par Description:
    // Saves XML nodes to an XML document
    //
    // \param clXML* xmlDocument
    //
    void saveXML(clXML* xmlDocument);

    // Getters and Setters 

    // GetGeomFileName
    char *getGeomFileName();


    // SetGeomFileName
    void setGeomFileName(char *name);

    // GetMatSysFileName
    char *getMatSysFileName();

    // SetMatSysFileName
    void setMatSysFileName(char *name);

    // GetThermalSpinUpPeriod
    double getThermalSpinUpPeriod();

    // SetThermalSpinUpPeriod
    void setThermalSpinUpPeriod(double period);

    // setVisibility
    void setVisibility(bool visibility);

    // getVisibility
    bool getVisibility();

    // setGeodeticPosition
    void setGeodeticPosition(double latitude, double longitude, double altitude);

    // getGeodeticPosition
    void getGeodeticPosition(double &latitude, double &longitude, double &altitude);

    // setNEDOrientation
    void setNEDOrientation(double heading, double pitch, double roll);

    // getNEDOrientation
    void getNEDOrientation(double &heading, double &pitch, double &roll);
    //setUseOcean
    void setUseOcean(bool flag){m_useOcean = flag;}

    //getUseOcean
    bool getUseOcean(){return m_useOcean;}

    //getWindSpeed
    double getWindSpeed(){return m_windSpeed;}

    //setWindSpeed
    void setWindSpeed (double windSpeed){ m_windSpeed = windSpeed; }

    //getWindDirection
    double getWindDirection(){return m_windDirection;}

    //setWindDirection
    void setWindDirection (double windDirection){ m_windDirection = windDirection; }

    //getWaveHeight
    double getWaveHeight(){return m_waveHeight;}

    //setWaveHeight
    void setWaveHeight (double waveHeight){  m_waveHeight = waveHeight; }

protected:  // methods

private: // methods

private: // variables

    char m_geomFileName[512];
    char    m_matSysFileName[512];
    double  m_thermalSpinUp;
    bool m_visibility;           
    double  m_latitude;          
    double  m_longitude;            
    double  m_altitude;          
    double  m_heading;           
    double  m_pitch;             
    double  m_roll;              
    bool m_useOcean;
    double  m_windSpeed;
    double  m_windDirection;
    double  m_waveHeight;
    clXMLNode* m_parentNode;
};

#endif // !defined(AFX_CIOCEAN_H__DE81EF86_CAA9_471E_AE7A_9087CD4CB282__INCLUDED_)