TAPsSimulationFlags.hpp

Go to the documentation of this file.

/******************************************************************************
TAPsSimulationFlags.hpp
******************************************************************************/
/******************************************************************************
SUKITTI PUNAK   (09/25/2008)
UPDATE          (09/23/2010)
******************************************************************************/
#ifndef TAPs_SIMULATION_FLAGS_HPP
#define TAPs_SIMULATION_FLAGS_HPP

#include "TAPsFlag.hpp"
#include "../Core/TAPsEnumList.hpp"

BEGIN_NAMESPACE_TAPs__DS
//=============================================================================
class SimulationFlags {
public:
    // Member Functions -------------------------------------------------------

    static const int FLAG_SIZE = 8;

    friend std::ostream & operator<< ( std::ostream &output, SimulationFlags const &obj )
    {
        output << obj.StrInfo();
        return output;
    }

    //-------------------------------------------------------------------------
    SimulationFlags ()
    {}

    SimulationFlags ( SimulationFlags const & orig )
    {
        m_SimFlags = orig.m_SimFlags;
    }

    ~SimulationFlags ()
    {}

    //-------------------------------------------------------------------------
    virtual std::string StrInfo () const
    {
        std::stringstream ss;
        ss << "Simulation Constraint Flags (int value " << m_SimFlags << " ):";
        if ( CheckSimulationConstraints( Enum::AddOn::FIXED ) )     ss << "[FIXED: on ]";
        else                                                        ss << "[FIXED: off]";
        if ( CheckSimulationConstraints( Enum::AddOn::ATTACHED ) )  ss << "[ATTACHED: on ]";
        else                                                        ss << "[ATTACHED: off]";
        if ( CheckSimulationConstraints( Enum::AddOn::PUNCTURED ) ) ss << "[PUNCTURED: on ]";
        else                                                        ss << "[PUNCTURED: off]";
        if ( CheckSimulationConstraints( Enum::AddOn::SLIDABLE ) )  ss << "[SLIDABLE: on ]";
        else                                                        ss << "[SLIDABLE: off]";
        if ( CheckSimulationConstraints( Enum::AddOn::CLUSTERED ) ) ss << "[CLUSTERED: on ]";
        else                                                        ss << "[CLUSTERED: off]";
        if ( CheckSimulationConstraints( Enum::AddOn::COLLIDED ) )  ss << "[COLLIDED: on ]";
        else                                                        ss << "[COLLIDED: off]";
        return ss.str();
    }

    //-------------------------------------------------------------------------
    inline SimulationFlags & operator= ( SimulationFlags const & flags )
    {
        m_SimFlags = flags.m_SimFlags;
        return *this;
    }

    //-------------------------------------------------------------------------
    //-------------------------------------------------------------------------
    TAPs::DS::Flag< enum TAPs::Enum::AddOn::SimConstraints, FLAG_SIZE > &   GetSimulationConstraints ()
    { return m_SimFlags; }

    void SetSimulationConstraints ( enum TAPs::Enum::AddOn::SimConstraints flag )
    { m_SimFlags.SetFlag( flag ); }

    void ClearSimulationConstraints ( enum TAPs::Enum::AddOn::SimConstraints flag )
    { m_SimFlags.ClearFlag( flag ); }

    bool CheckSimulationConstraints ( enum TAPs::Enum::AddOn::SimConstraints flag ) const
    { return m_SimFlags.CheckFlag( flag ); }

    bool AreSimulationFlagsCleared () const
    { return m_SimFlags.IsCleared(); }

    void ClearAllSimulationConstraints ()
    { m_SimFlags.ClearAll(); }

    void ClearAllFlags ()
    { m_SimFlags.ClearAll(); }


    //-------------------------------------------------------------------------
    // Data Members -----------------------------------------------------------
//=============================================================================
protected:
    // Member Functions -------------------------------------------------------
    // Data Members -----------------------------------------------------------
    TAPs::DS::Flag< enum TAPs::Enum::AddOn::SimConstraints, FLAG_SIZE > m_SimFlags; 
//=============================================================================
private:
    // Member Functions -------------------------------------------------------
    // Data Members -----------------------------------------------------------
//=============================================================================
}; // END CLASS Flag
//=============================================================================
//-----------------------------------------------------------------------------
//=============================================================================
END_NAMESPACE_TAPs__DS
//-----------------------------------------------------------------------------
//#if !defined( TAPs_USE_EXPORT )
//  #include "TAPsSimulationFlags.cpp"
//#endif
//-----------------------------------------------------------------------------
#endif
//34567890123456789012345678901234567890123456789012345678901234567890123456789
//--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----