ossimDuration Class Reference

#include <ossimDuration.h>

Public Member Functions
	ossimDuration (const ossimString &iso8601Duration=ossimString(""))
	This will take an iso8601 encoded duration string and parse out the individual values. More...
void	clearFields ()
	zero out all fields More...
bool	readIso8601Encoding (std::istream &in)
	This will take an iso8601 encoded duration stream and parse out the individual values it will stop when a blank character or whitespace is found. More...
bool	setByIso8601DurationString (const ossimString &iso8601Duration)
	This will take an iso8601 encoded duration stream and parse out the individual values it will stop when a blank character or whitespace is found. More...
void	toIso8601DurationString (ossimString &result)
	Will take the field values and encode into a iso8601 string format. More...
ossim_float64	toSeconds () const
	this will not use the months field or the years field but will use all other fields to calculate a total value in seconds. More...
void	setSign (ossim_int32 value)
ossim_int32	sign () const
	returns the sign. More...
void	setYears (ossim_uint64 value)
ossim_int64	years () const
void	setMonths (ossim_uint64 value)
ossim_int64	months () const
void	setWeeks (ossim_uint64 value)
ossim_int64	weeks () const
void	setDays (ossim_uint64 value)
ossim_int64	days () const
void	setHours (ossim_uint64 value)
ossim_int64	hours () const
void	setMinutes (ossim_uint64 value)
ossim_int64	minutes () const
void	setSeconds (ossim_float64 value)
ossim_float64	seconds () const
void	setAll (ossim_int32 signValue, ossim_uint64 yearsValue, ossim_uint64 monthsValue, ossim_uint64 weeksValue, ossim_uint64 daysValue, ossim_uint64 hoursValue, ossim_uint64 minutesValue, ossim_float64 secondsValue)
	Sets all values in one call. More...

Protected Attributes
ossim_int32	theSign
ossim_int64	theYears
ossim_int64	theMonths
ossim_int64	theWeeks
ossim_int64	theDays
ossim_int64	theHours
ossim_int64	theMinutes
ossim_float64	theSeconds

Detailed Description

Definition at line 18 of file ossimDuration.h.

Constructor & Destructor Documentation

ossimDuration()

ossimDuration::ossimDuration

(

const ossimString &

iso8601Duration = ossimString("")

)

This will take an iso8601 encoded duration string and parse out the individual values.

Definition at line 15 of file ossimDuration.cpp.

References ossimString::empty(), and setByIso8601DurationString().

:theSign(1),
theYears(0),
theMonths(0),
theWeeks(0),
theDays(0),
theHours(0),
theMinutes(0),
theSeconds(0)
{
   if(!iso8601Duration.empty())
   {
      setByIso8601DurationString(iso8601Duration);
   }
}

Member Function Documentation

clearFields()

void ossimDuration::clearFields

(

)

zero out all fields

Definition at line 31 of file ossimDuration.cpp.

References theDays, theHours, theMinutes, theMonths, theSeconds, theSign, theWeeks, and theYears.

Referenced by readIso8601Encoding(), and setByIso8601DurationString().

{
   theSign = 1; 
   theYears = 0;
   theMonths = 0;
   theWeeks = 0;
   theDays = 0;
   theHours = 0;
   theMinutes = 0;
   theSeconds = 0; 
}

days()

ossim_int64 ossimDuration::days ( ) const

inline

Definition at line 103 of file ossimDuration.h.

   {
      return theDays;
   }

hours()

ossim_int64 ossimDuration::hours ( ) const

inline

Definition at line 111 of file ossimDuration.h.

   {
      return theHours;
   }

minutes()

ossim_int64 ossimDuration::minutes ( ) const

inline

Definition at line 119 of file ossimDuration.h.

   {
      return theMinutes;
   }

months()

ossim_int64 ossimDuration::months ( ) const

inline

Definition at line 87 of file ossimDuration.h.

   {
      return theMonths;
   }

readIso8601Encoding()

bool ossimDuration::readIso8601Encoding

(

std::istream &

in

)

This will take an iso8601 encoded duration stream and parse out the individual values it will stop when a blank character or whitespace is found.

Definition at line 51 of file ossimDuration.cpp.

References clearFields(), and theSign.

Referenced by setByIso8601DurationString().

{
   clearFields();
   
   if(in.peek()=='-')
   {
      theSign = -1;
      in.ignore();
   }
   if(in.peek()!='P')
   {
      return false;
   }
   // skip the period indicater
   in.ignore();
   
   // now we start parsing the date portion and the time portion
   ossimString value;
   bool doneFlag     = false;
   bool badParseFlag = false;
   bool doingTimeFlag = false;
   while(!doneFlag)
   {
      int c = in.peek();
      if(!in)
      {
         doneFlag = true;
      }
      else
      {
         if(isWhiteSpace(c))
         {
            doneFlag = true; // parse til blank character is met
         }
         else if(isalpha(c))
         {
            // we are done with current value 
            //
            // check to see if was a Time seaprator of value
            // 'T'
            if(c == 'T')
            {
               // then it was a time separator so do nothing
               value = ""; // go ahead and null it out for now
               doingTimeFlag = true; // now in time parsing portion
            }
            else
            {
               if(doingTimeFlag)
               {
                  // check time values
                  if(c == 'H')
                  {
                     theHours = value.toUInt64();
                  }
                  else if(c == 'M')
                  {
                     theMinutes = value.toUInt64();
                  }
                  else if(c == 'S')
                  {
                     theSeconds = value.toFloat64();
                  }
                  else
                  {
                     doneFlag = true;
                     badParseFlag = true;
                  }
                  value = ""; // reset the value
               }
               else // check date characters instead
               {
                  if(c == 'Y')
                  {
                     theYears = value.toUInt64();
                  }
                  else if(c == 'M')
                  {
                     theMonths = value.toUInt64();
                  }
                  else if(c == 'W')
                  {
                     theWeeks = value.toUInt64();
                  }
                  else if(c == 'D')
                  {
                     theDays = value.toUInt64();
                  }
                  else
                  {
                     doneFlag = true;
                     badParseFlag = true;
                  }
                  value = ""; // reset the value
               }
            }
         }
         else if(isdigit(c)||(c=='.'))// not an alphabetic character so add it to the value string
         {
            value += static_cast<char>(c);
         }
         else
         {
            doneFlag = true;
            badParseFlag = true;
         }
      }
      if(!doneFlag)
      {
         in.ignore();
      }
   }
   
   return badParseFlag;
}

seconds()

ossim_float64 ossimDuration::seconds ( ) const

inline

Definition at line 127 of file ossimDuration.h.

   {
      return theSeconds;
   }

setAll()

void ossimDuration::setAll ( ossim_int32  signValue, ossim_uint64  yearsValue, ossim_uint64  monthsValue, ossim_uint64  weeksValue, ossim_uint64  daysValue, ossim_uint64  hoursValue, ossim_uint64  minutesValue, ossim_float64  secondsValue  )

inline

Sets all values in one call.

Definition at line 135 of file ossimDuration.h.

   {
      theSign    = ((signValue < 0)?-1:1);
      theYears   = yearsValue;
      theMonths  = monthsValue;
      theWeeks   = weeksValue;
      theDays    = daysValue;
      theHours   = hoursValue;
      theMinutes = minutesValue;
      theSeconds = secondsValue;
   }

setByIso8601DurationString()

bool ossimDuration::setByIso8601DurationString

(

const ossimString &

iso8601Duration

)

This will take an iso8601 encoded duration stream and parse out the individual values it will stop when a blank character or whitespace is found.

Definition at line 167 of file ossimDuration.cpp.

References clearFields(), ossimString::empty(), and readIso8601Encoding().

Referenced by ossimDuration().

{
   if(iso8601Duration.empty())
   {
      clearFields();
      return true;
   }
   std::istringstream in(iso8601Duration);
   return readIso8601Encoding(in);
}

setDays()

void ossimDuration::setDays ( ossim_uint64  value )

inline

Definition at line 99 of file ossimDuration.h.

   {
      theDays = value;
   }

setHours()

void ossimDuration::setHours ( ossim_uint64  value )

inline

Definition at line 107 of file ossimDuration.h.

   {
      theHours = value;
   }

setMinutes()

void ossimDuration::setMinutes ( ossim_uint64  value )

inline

Definition at line 115 of file ossimDuration.h.

   {
      theMinutes = value;
   }

setMonths()

void ossimDuration::setMonths ( ossim_uint64  value )

inline

Definition at line 83 of file ossimDuration.h.

   {
      theMonths = value;
   }

setSeconds()

void ossimDuration::setSeconds ( ossim_float64  value )

inline

Definition at line 123 of file ossimDuration.h.

   {
      theSeconds = value;
   }

setSign()

void ossimDuration::setSign ( ossim_int32  value )

inline

Definition at line 64 of file ossimDuration.h.

   {
      theSign = ((value < 0)?-1:1);
   }

setWeeks()

void ossimDuration::setWeeks ( ossim_uint64  value )

inline

Definition at line 91 of file ossimDuration.h.

   {
      theWeeks = value;
   }

setYears()

void ossimDuration::setYears ( ossim_uint64  value )

inline

Definition at line 75 of file ossimDuration.h.

   {
      theYears = value;
   }

sign()

ossim_int32 ossimDuration::sign ( ) const

inline

returns the sign.

Should be either -1 or 1 for the return

Definition at line 71 of file ossimDuration.h.

   {
      return theSign;
   }

toIso8601DurationString()

void ossimDuration::toIso8601DurationString

(

ossimString &

result

)

Will take the field values and encode into a iso8601 string format.

Note, anything that is 0 will not be output.

Definition at line 178 of file ossimDuration.cpp.

References ossim::almostEqual(), theDays, theHours, theMinutes, theMonths, theSeconds, theSign, theWeeks, theYears, and ossimString::toString().

{
   result = "";
   bool hasDatePeriod = ((theYears!=0)||
                         (theMonths!=0)||
                         (theWeeks!=0)||
                         (theDays!=0));
   bool hasTimePeriod = ((theHours!=0)||
                         (theMinutes!=0)||
                         (!ossim::almostEqual(theSeconds, 0.0, .00000000001)));
   // if no time or date period present then return empty
   if(!(hasDatePeriod || hasTimePeriod))
   {
      return;
   }
   if(theSign < 0)
   {
      result += "-";
   }
   result += "P";
   if(hasDatePeriod)
   {
      if(theYears > 0)
      {
         result+=ossimString::toString(theYears);
         result+="Y";
      }
      if(theMonths>0)
      {
         result+=ossimString::toString(theMonths);
         result+="M";
      }
      if(theWeeks>0)
      {
         result+=ossimString::toString(theWeeks);
         result+="W";
      }
      if(theDays>0)
      {
         result+=ossimString::toString(theDays);
         result+="D";
      }
   }
   if(hasTimePeriod)
   {
      result+="T";
      if(theHours>0)
      {
         result+=ossimString::toString(theHours);
         result+="H";
      }
      if(theMinutes>0)
      {
         result+=ossimString::toString(theMinutes);
         result+="M";
      }
      if(theSeconds>0)
      {
         result+=ossimString::toString(theSeconds, 15);
         result+="S";
      }
   }
}

toSeconds()

ossim_float64 ossimDuration::toSeconds

(

)

const

this will not use the months field or the years field but will use all other fields to calculate a total value in seconds.

We can not determine leap years and how many days are in a month so those are omitted and so this serves as a utility method to just calculate the total seconds if you give a duration string that contains only one or all or any of the following: weeks, days, minutes, hours, and/or seconds.

If the sign is set to negative it will return a negative value.

Definition at line 242 of file ossimDuration.cpp.

References theDays, theHours, theMinutes, theSeconds, theSign, and theWeeks.

{
   ossim_float64 result = theSeconds;
   
   if(theMinutes > 0)
   {
      result += theMinutes*60.0;
   }
   if(theHours > 0)
   {
      result += theHours*3600.0;
   }
   if(theDays > 0)
   {
      result += theDays*86400.0;
   }
   if(theWeeks > 0)
   {
      result += theWeeks*604800;
   }
   if(theSign < 0)
   {
      result *= -1.0;
   }
   return result;
}

weeks()

ossim_int64 ossimDuration::weeks ( ) const

inline

Definition at line 95 of file ossimDuration.h.

   {
      return theWeeks;
   }

years()

ossim_int64 ossimDuration::years ( ) const

inline

Definition at line 79 of file ossimDuration.h.

   {
      return theYears;
   }

Member Data Documentation

theDays

ossim_int64 ossimDuration::theDays

protected

Definition at line 160 of file ossimDuration.h.

Referenced by clearFields(), toIso8601DurationString(), and toSeconds().

theHours

ossim_int64 ossimDuration::theHours

protected

Definition at line 161 of file ossimDuration.h.

Referenced by clearFields(), toIso8601DurationString(), and toSeconds().

theMinutes

ossim_int64 ossimDuration::theMinutes

protected

Definition at line 162 of file ossimDuration.h.

Referenced by clearFields(), toIso8601DurationString(), and toSeconds().

theMonths

ossim_int64 ossimDuration::theMonths

protected

Definition at line 158 of file ossimDuration.h.

Referenced by clearFields(), and toIso8601DurationString().

theSeconds

ossim_float64 ossimDuration::theSeconds

protected

Definition at line 163 of file ossimDuration.h.

Referenced by clearFields(), toIso8601DurationString(), and toSeconds().

theSign

ossim_int32 ossimDuration::theSign

protected

Definition at line 156 of file ossimDuration.h.

Referenced by clearFields(), readIso8601Encoding(), toIso8601DurationString(), and toSeconds().

theWeeks

ossim_int64 ossimDuration::theWeeks

protected

Definition at line 159 of file ossimDuration.h.

Referenced by clearFields(), toIso8601DurationString(), and toSeconds().

theYears

ossim_int64 ossimDuration::theYears

protected

Definition at line 157 of file ossimDuration.h.

Referenced by clearFields(), and toIso8601DurationString().

---

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

• ossimDuration.h
• ossimDuration.cpp