binid.h

Go to the documentation of this file.

#pragma once
 
/*+
________________________________________________________________________
 
 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H.Bril
 Date:          21-6-1996
 Contents:      Positions: Inline/crossline and Coordinate
 RCS:           $Id$
________________________________________________________________________
 
-*/
 
#include "basicmod.h"
#include "bufstring.h"
#include "posidxpair.h"
 
// The following should become separate classes with their own specific
// functions at some point in time ...
typedef BinID BinIDStep;
typedef BinID BinIDDelta; // is base class for:
typedef BinID BinIDAbsDelta;
typedef BinID BinIDRelDelta;
 
 
mExpClass(Basic) BinID : public Pos::IdxPair
{
public:
 
    inline                      BinID()                         {}
    inline                      BinID(IdxType i,IdxType x);
    inline                      BinID(const Pos::IdxPair&);
 
    inline const BinID&         operator+=(const BinIDAbsDelta&);
    inline const BinID&         operator-=(const BinIDAbsDelta&);
    inline BinID                operator+(const BinIDAbsDelta&) const;
    inline BinID                operator-(const BinIDAbsDelta&) const;
 
                                // BinIDRelDelta operator:
    inline BinIDAbsDelta        operator*(const Pos::Index_Type_Pair&) const;
                                // BinIDAbsDelta operator:
    inline BinIDRelDelta        operator/(const Pos::Index_Type_Pair&) const;
 
                                // BinID[Abs|Rel]Delta operators:
    // 'BinID' below should be either BinIDRelDelta or BinIDAbsDelta
    inline BinID                operator*(int) const;
    inline BinID                operator/(int) const;
    inline BinID                operator-() const;
 
    inline static BinID         fromInt64(od_int64);
 
    inline const char*          toString(bool is2d=false) const;
    inline bool                 fromString(const char*);
 
    inline BufferString         usrDispStr() const;
};
 
 
inline BinID::BinID( BinID::IdxType i, BinID::IdxType c )
    : Pos::IdxPair(i,c)
{
}
 
 
inline BinID::BinID( const Pos::IdxPair& p )
    : Pos::IdxPair(p)
{
}
 
 
inline const BinID& BinID::operator+=( const BinIDAbsDelta& bid )
        { inl() += bid.inl(); crl() += bid.crl(); return *this; }
inline const BinID& BinID::operator-=( const BinIDAbsDelta& bid )
        { inl() -= bid.inl(); crl() -= bid.crl(); return *this; }
inline BinID BinID::operator+( const BinIDAbsDelta& bid ) const
        { return BinID( inl()+bid.inl(), crl()+bid.crl() ); }
inline BinID BinID::operator-( const BinIDAbsDelta& bid ) const
{ return BinID( inl()-bid.inl(), crl()-bid.crl() ); }
 
inline BinID BinID::operator-() const
{ return BinID( -inl(), -crl() ); }
 
inline BinIDAbsDelta BinID::operator*( const Pos::Index_Type_Pair& ip ) const
{ return BinID( first*ip.first, second*ip.second ); }
 
inline BinIDAbsDelta BinID::operator/( const Pos::Index_Type_Pair& ip ) const
{ return BinID( first/ip.first, second/ip.second ); }
 
inline BinID BinID::operator*( int factor ) const
{ return BinID( inl()*factor, crl()*factor ); }
 
inline BinID BinID::operator/( int denominator ) const
        { return BinID( inl()/denominator, crl()/denominator ); }
 
 
inline BinID BinID::fromInt64( od_int64 i64 )
{
    Pos::IdxPair p( Pos::IdxPair::fromInt64(i64) );
    return BinID( p.first, p.second );
}
 
 
inline const char* BinID::toString( bool is2d ) const
{
    return IdxPair::getUsrStr( "", "/", "", is2d );
}
 
 
inline bool BinID::fromString( const char* str )
{
    return IdxPair::parseUsrStr( str, "", "/", "" );
}
 
 
BufferString BinID::usrDispStr() const
{
    BufferString ret;
    ret.set( inl() ).add( "/" ).add( crl() );
    return ret;
}