ccmBase.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2016-2025 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

Class
    Foam::ccm::base

Description
    Base functionality common to reader and writer classes

Note
    this class is in development
    - any/all of the class names and members may change

SourceFiles
    ccmBase.C

\*---------------------------------------------------------------------------*/

#ifndef Foam_ccmBase_H
#define Foam_ccmBase_H

#include <memory>
#include <string>

// Normally mingw will export *all* symbols, but since the ADF library
// explicitly uses __declspec(dllexport) itself we must do the same otherwise
// none of our library symbols are exported and linking fails (issue #3199).

#undef FOAM_DLL_EXPORT
#ifdef __MINGW32__
    #define FOAM_DLL_EXPORT  __declspec(dllexport)
#else
    #define FOAM_DLL_EXPORT
#endif


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{
namespace ccm
{

// Forward Declarations
class ccmGlobalState;

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

/*---------------------------------------------------------------------------*\
                          Class ccm::base Declaration
\*---------------------------------------------------------------------------*/

class base
{
protected:

    // Protected Data

        //- Maintain overall global states (error, root-node)
        std::unique_ptr<ccmGlobalState> globalState_;


    // Protected Member Functions

        //- Die with msg if there is an error
        //  Return true if there is no error
        static bool assertNoError(int err, const char *msg);

        //- Die with msg if there is an error
        //  Return true if there is no error
        static bool assertNoError(int err, const std::string& msg);


        //- check global state for errors and die as required
        //  Return true if there is no error
        bool assertNoError(const char* msg) const;

        //- check global state for errors and die as required
        //  Return true if there is no error
        bool assertNoError(const std::string& msg) const;

public:

    // Generated Methods

        //- No copy construct
        base(const base&) = delete;

        //- No copy assignment
        void operator=(const base&) = delete;


    // Constructors

        //- Default construct. Initializes the global-state.
        base();


    //- Destructor: close file
    ~base();


    // Member Functions

        //- Explicitly close the file and terminate ccmio access.
        //  Return false if it was already closed.
        bool close();
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace ccm
} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //