IntervalDS Class

Leading field precision will be determined by number of decimal digits in day input. Fraction second precision will be determined by number of fraction digits on input.

IntervalDS(
   const Environment *env,
   int day = 0,
   int hour = 0,
   int minute = 0,
   int second = 0,
   int fs = 0);

The following code example demonstrates that the default constructor creates a NULL value, and how you can assign a non NULL value to a day-second interval and then perform operations on it:

Environment *env = Environment::createEnvironment();

// Create a NULL day-second interval
IntervalDS ds;
if(ds.isNull())
   cout << "\n ds is null";

// Assign a non-NULL value to ds
IntervalDS anotherDS(env, "10 20:14:10.2");
ds = anotherDS;

// Now all operations on IntervalDS are valid
int DAY = ds.getDay();

The following code example demonstrates how to create a NULL day-second interval, initialize the day-second interval by using the fromText() method, add to the day-second interval by using the += operator, multiply by using the * operator, compare 2 day-second intervals, and convert a day-second interval to a string by using the toText method:

Environment *env = Environment::createEnvironment();

// Create a null day-second interval
IntervalDS ds1

// Initialize a null day-second interval by using the fromText method
ds1.fromText("20 10:20:30.9","",env);

IntervalDS addWith(env,2,1);
ds1 += addWith;    //call += operator

IntervalDS mulDs1=ds1 * Number(env,10);  
                   //call * operator
if(ds1==mulDs1)    //call == operator
   .
   .
string strds=ds1.toText(2,4);                       //2 is leading field precision
                   //4 is the fractional field precision

IntervalDS()

IntervalDS class constructor.

IntervalDS();

IntervalDS(
   const IntervalDS &src);

scp

fromText()

Creates the interval from the string specified. The string is converted using the nls parameters associated with the relevant environment. The nls parameters are picked up from env. If env is NULL, the nls parameters are picked up from the environment associated with the instance, if any.

void fromText(
   const string &inpStr,
   const string &nlsParam = "",
   const Environment *env = NULL);

inpStr

nlsParam

env

getDay()

Returns the day component of the interval.

int getDay() const;

getFracSec()

Returns the fractional second component of the interval.

int getFracSec() const;

getHour()

Returns the hour component of the interval.

int getHour() const;

getMinute()

Returns the minute component of this interval.

int getMinute() const;

getSecond()

Returns the seconds component of this interval.

int getSecond() const;

isNull()

Tests whether the interval is NULL. If the interval is NULL then TRUE is returned; otherwise, FALSE is returned.

bool isNull() const;

operator*()

Multiplies an interval by a specified value and returns the result.

const IntervalDS operator*(
   const IntervalDS &interval,
   const Number &val);

interval

val

operator*=()

Assigns the product of IntervalDS and a to IntervalDS.

IntervalDS& operator*=(
   const IntervalDS &val);

val

operator=()

Assigns the specified value to the interval.

IntervalDS& operator=(
   const IntervalDS &val);

val

operator==()

Compares the intervals specified. If the intervals are equal, then TRUE is returned; otherwise, FALSE is returned. If either interval is NULL then SQLException is thrown.

bool operator==(
   const IntervalDS &first,
   const IntervalDS &second);

first

second

operator!=()

Compares the intervals specified. If the intervals are not equal then TRUE is returned; otherwise, FALSE is returned. If either interval is NULL then SQLException is thrown.

bool operator!=(
   const IntervalDS &first,
   const IntervalDS &second);

first

second

operator/()

Returns the result of dividing an interval by a constant value.

const IntervalDS operator/(
   const IntervalDS &dividend,
   const Number &factor);

dividend

factor

operator/=()

Assigns the quotient of IntervalDS and val to IntervalDS.

IntervalDS& operator/=(
   const IntervalDS &val);

val

operator>()

Compares the intervals specified. If the first interval is greater than the second interval then TRUE is returned; otherwise, FALSE is returned. If either interval is NULL then SQLException is thrown.

bool operator>(
   const IntervalDS &first,
   const IntervalDS &second);

first

second

operator>=()

Compares the intervals specified. If the first interval is greater than or equal to the second interval then TRUE is returned; otherwise, FALSE is returned. If either interval is NULL then SQLException is thrown.

bool operator>=(
   const IntervalDS &first,
   const IntervalDS &first);

first

second

operator<()

Compares the intervals specified. If the first interval is less than the second interval then TRUE is returned; otherwise, FALSE is returned. If either interval is NULL then SQLException is thrown.

bool operator<(
   const IntervalDS &first,
   const IntervalDS &second);

first

second

operator<=()

Compares the intervals specified. If the first interval is less than or equal to the second interval then TRUE is returned; otherwise, FALSE is returned. If either interval is NULL then SQLException is thrown.

bool operator<=(
   const IntervalDS &first,
   const IntervalDS &second);

first

second

operator-()

Returns the difference between the intervals first and second.

const IntervalDS operator-(
   const IntervalDS &first,
   const IntervalDS &second);

first

second

operator-=()

Assigns the difference between IntervalDS and val to IntervalDS.

IntervalDS& operator-=(
   const IntervalDS &val);

val

operator+()

Returns the sum of the intervals specified.

const IntervalDS operator+(
   const IntervalDS &first,
   const IntervalDS &second);

first

second

operator+=()

Assigns the sum of IntervalDS and val to IntervalDS.

IntervalDS& operator+=(
   const IntervalDS &val);

val

set()

Sets the interval to the values specified.

void set(
   int day,
   int hour,
   int minute,
   int second,
   int fracsec);

day

hour

min

second

fracsec

setNull()

Sets the IntervalDS to NULL.

void setNull();

toText()

Returns the string representation for the interval.

string toText(
   unsigned int lfPrec,
   unsigned int fsPrec,
   const string &nlsParam = "") const;

lfPrec

fsPrec

nlsParam