Changeset 22682 for trunk/psLib/src/astro/psTime.h

Timestamp:

Feb 26, 2009, 10:21:48 AM (17 years ago)

Author:

Paul Price

Message:

API for psTimeConvert was confusing: the time is converted in-place, but returning a psTime* implies that a new structure is created and the operation is performed on it.

File:

• trunk/psLib/src/astro/psTime.h (modified) (1 diff)

trunk/psLib/src/astro/psTime.h

@@ -135 +135 @@
 /** Convert psTime to UTC, TAI, UT1, or TT time.
  *
- *  Converts psTime to UTC, TAI, UT1, or TT time based on the psTimeType argument.
- *
- *  @return psTime*:    Pointer to psTime.
- */
-psTime* psTimeConvert(
+ *  Converts psTime in-place to UTC, TAI, UT1, or TT time based on the psTimeType argument.
+ *
+ *  @return bool: Successful conversion?
+ */
+bool psTimeConvert(
     psTime *time,                      ///< Time to be converted.
     psTimeType type                    ///< Type to be converted to.