LUPI::FormatVersion Class Reference

#include <LUPI.hpp>

Public Member Functions
	FormatVersion ()
	FormatVersion (std::string const &a_formatVersion)
	FormatVersion (FormatVersion const &a_formatVersion)
FormatVersion &	operator= (FormatVersion const &a_rhs)
std::string const &	format () const
int	major () const
int	minor () const
std::string const &	patch () const
bool	setFormat (std::string const &a_formatVersion)
bool	supported () const

Detailed Description

Class to store GNDS format.

Definition at line 60 of file LUPI.hpp.

Constructor & Destructor Documentation

FormatVersion() [1/3]

LUPI::FormatVersion::FormatVersion

(

)

Definition at line 23 of file LUPI_formatVersion.cc.

                              :
        m_format( "" ),
        m_major( -1 ),
        m_minor( -1 ),
        m_patch( "" ) {
 
}

Referenced by FormatVersion(), and operator=().

FormatVersion() [2/3]

LUPI::FormatVersion::FormatVersion

(

std::string const &

a_formatVersion

)

Parameters

a_formatVersion

[in] The GNDS format.

Definition at line 35 of file LUPI_formatVersion.cc.

                                                               :
        m_format( a_formatVersion ),
        m_major( -1 ),
        m_minor( -1 ),
        m_patch( "" ) {
 
    setFormat( a_formatVersion );
}

FormatVersion() [3/3]

LUPI::FormatVersion::FormatVersion

(

FormatVersion const &

a_formatVersion

)

Parameters

a_formatVersion

[in] The GNDS format.

Definition at line 48 of file LUPI_formatVersion.cc.

                                                                   :
        m_format( a_formatVersion.format( ) ),
        m_major( a_formatVersion.major( ) ),
        m_minor( a_formatVersion.minor( ) ),
        m_patch( a_formatVersion.patch( ) ) {
 
}

Member Function Documentation

format()

std::string const & LUPI::FormatVersion::format ( ) const

inline

Definition at line 74 of file LUPI.hpp.

{ return( m_format ); }

Referenced by FormatVersion(), operator=(), GIDI::Functions::Regions1d::Regions1d(), GIDI::Functions::Regions2d::Regions2d(), PoPI::supportedFormat(), GIDI::Functions::XYs2d::XYs2d(), and GIDI::Functions::XYs3d::XYs3d().

major()

int LUPI::FormatVersion::major ( ) const

inline

Definition at line 75 of file LUPI.hpp.

{ return( m_major ); }

Referenced by FormatVersion(), and operator=().

minor()

int LUPI::FormatVersion::minor ( ) const

inline

Definition at line 76 of file LUPI.hpp.

{ return( m_minor ); }

Referenced by FormatVersion(), and operator=().

operator=()

FormatVersion & LUPI::FormatVersion::operator=

(

FormatVersion const &

a_rhs

)

The assignment operator. This method sets the members of this to those of a_rhs except for those not set by base classes.

Parameters

a_rhs

[in] Instance whose member are used to set the members of this.

Definition at line 63 of file LUPI_formatVersion.cc.

                                                                  {
 
    if( this != &a_rhs ) {
        m_format = a_rhs.format( );
        m_major = a_rhs.major( );
        m_minor = a_rhs.minor( );
        m_patch = a_rhs.patch( );
    }
 
    return( *this );
}

patch()

std::string const & LUPI::FormatVersion::patch ( ) const

inline

Definition at line 77 of file LUPI.hpp.

{ return( m_patch ); }

Referenced by FormatVersion(), and operator=().

setFormat()

bool LUPI::FormatVersion::setFormat

(

std::string const &

a_formatVersion

)

Set the format to a_formatVersion and parse its components.

Parameters

a_formatVersion

[in] The GNDS format.

Returns

true if format of the form "MAJOR.MINOR[.PATCH]" where MAJOR and MINOR are integers. Otherwise returns false.

Definition at line 83 of file LUPI_formatVersion.cc.

                                                                {
 
    m_format = a_formatVersion;
 
    std::vector<std::string> formatItems = Misc::splitString( a_formatVersion, '.' );
 
    if( ( formatItems.size( ) < 2 ) || ( formatItems.size( ) > 3 ) ) goto err;
 
    if( !Misc::stringToInt( formatItems[0], m_major ) ) goto err;
    if( !Misc::stringToInt( formatItems[1], m_minor ) ) goto err;
 
    if( formatItems.size( ) == 3 ) m_patch = formatItems[2];
 
    return( true );
 
err:
    m_major = -1;
    m_minor = -1;
    m_patch = "";
    return( false );
}

Referenced by GIDI::Fluxes::addFile(), GIDI::Groups::addFile(), and FormatVersion().

supported()

bool LUPI::FormatVersion::supported

(

)

const

Returns true if m_format is a supported format and false otherwise;

Returns

true if format is supported and false otherwise.

Definition at line 111 of file LUPI_formatVersion.cc.

                                     {
 
    if( m_format == GNDS_formatVersion_1_10Chars ) return( true );
    if( m_format == GNDS_formatVersion_2_0Chars ) return( true );
    if( m_format == GNDS_formatVersion_2_0_LLNL_4Chars ) return( true );
    if( m_format == GNDS_formatVersion_2_1Chars ) return( true );
 
    return( false );
}

Referenced by GIDI::Fluxes::addFile(), GIDI::Groups::addFile(), and PoPI::supportedFormat().

---

The documentation for this class was generated from the following files:

• LUPI.hpp
• LUPI_formatVersion.cc