A singleton object used to maintain the start date and time of the simulation. More...

#include <WsfDateTime.hpp>

Public Member Functions
	WsfDateTime ()=default
	WsfDateTime (const WsfDateTime &)=default
	~WsfDateTime ()=default
bool	ProcessInput (UtInput &aInput)
	Process simulation input commands 'start_date' and 'start_time'.
double	GetJulianDate (int aYear, int aMonth, int aDay, double aSecondsPastMidnight) const
	Return the Julian date (i.e.: the number of days since 12:00:00 UTC on 1 January 4713 B.C.).
double	GetStartJulianDate () const
	Return the Julian date of the start date and time.
void	GetStartDate (int &aYear, int &aMonth, int &aDay) const
	Get the start date of the simulation.
void	GetStartTime (int &aHour, int &aMinute, double &aSecond) const
	Get the start time as the number of hours, minutes and seconds past midnight of the start day.
double	GetStartTime () const
	Get the time as the number of seconds past midnight of the start day.
const UtCalendar &	GetStartDateAndTime () const
	Get the start date and time of the simulation.
bool	SetStartDate (int aYear, int aMonth, int aDay)
	Set the start date.
bool	SetStartTime (int aHour, int aMinute, double aSecond)
	Set the start time as the number of hours, minutes and seconds past midnight of the start day.
bool	SetStartEpoch (double aEpoch)
	Set the start time as the Epoch (year*1000 + day "." fractional day).
void	SetCurrentDateAndTime ()
bool	UsingSystemTime () const
	Return whether this object was initialized with system / wall clock time.
UtCalendar	GetCurrentTime (double aSimTime) const
void	GetCurrentTime (double aSimTime, UtCalendar &aCurrentTime) const

Protected Member Functions
WsfDateTime &	operator= (const WsfDateTime &aRhs)=delete
	operator= declared but not defined to prevent use.

Detailed Description

A singleton object used to maintain the start date and time of the simulation.

Year, month and day values are subject to the following constraints:

Year must be specified as 4 digits (1999, 2000, etc).
Month must be in the range [1..12]
Days must be in the range [1..31] (modified appropriately for those months that don't have 31 days.

Constructor & Destructor Documentation

◆ WsfDateTime() [1/2]

WsfDateTime::WsfDateTime ( )

default

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

◆ WsfDateTime() [2/2]

WsfDateTime::WsfDateTime ( const WsfDateTime & )

default

References WsfDateTime().

◆ ~WsfDateTime()

WsfDateTime::~WsfDateTime ( )

default

References GetCurrentTime(), GetJulianDate(), GetStartDate(), GetStartDateAndTime(), GetStartJulianDate(), GetStartTime(), ProcessInput(), SetCurrentDateAndTime(), SetStartDate(), SetStartEpoch(), SetStartTime(), and UsingSystemTime().

Member Function Documentation

◆ GetCurrentTime() [1/2]

UtCalendar WsfDateTime::GetCurrentTime ( double aSimTime ) const

Returns the absolute time as a UtCalendar, given the current simulation time.

Parameters

aSimTime The current simulation time, in seconds.

Note: This method is deprecated; the preferred version is the two parameter version below

Referenced by wsf::space::KinematicStateExtrapolation::Extrapolate(), WsfSpaceMoverBase::GetFutureLocationWCS(), WsfSolarTerminator::GetPlatformSolarIllumination(), UCI_Util::GetTimeStamp(), WsfOpticalEnvironment::Initialize(), WsfSpaceMoverBase::Initialize(), WsfExclusionSensorComponent::PostAttemptToDetect(), WsfMoonLOS_SensorComponent::PostAttemptToDetect(), WsfSolarElevationAtTargetSensorComponent::PostAttemptToDetect(), WsfSolarIlluminationComponent::PostAttemptToDetect(), WsfSpaceMoverBase::PreInitialize(), wsf::event::utils::PrintDateTime(), UT_DEFINE_SCRIPT_METHOD(), and ~WsfDateTime().

◆ GetCurrentTime() [2/2]

void WsfDateTime::GetCurrentTime	(	double	aSimTime,
		UtCalendar &	aCurrentTime ) const

This is an optimized implementation of GetCurrentTime.

Parameters

aSimTime	The current simulation time, in seconds.
aCurrentTime	(in/out) The time at aSimTime as a UtCalendar.

References simTime.

◆ GetJulianDate()

double WsfDateTime::GetJulianDate	(	int	aYear,
		int	aMonth,
		int	aDay,
		double	aSecondsPastMidnight ) const

Return the Julian date (i.e.: the number of days since 12:00:00 UTC on 1 January 4713 B.C.).

Parameters

aYear	The year of interest.
aMonth	The month of interest.
aDay	The day of interest.
aSecondsPastMidnight	The number of seconds past midnight on the day of interest.

Referenced by WsfL16::Interface::Initialize(), and ~WsfDateTime().

◆ GetStartDate()

void WsfDateTime::GetStartDate	(	int &	aYear,
		int &	aMonth,
		int &	aDay ) const

Get the start date of the simulation.

Parameters

aYear	The start year (output).
aMonth	The start month (output).
aDay	The start day (output).

Referenced by WsfL16::Interface::Initialize(), and ~WsfDateTime().

◆ GetStartDateAndTime()

const UtCalendar & WsfDateTime::GetStartDateAndTime ( ) const

Get the start date and time of the simulation.

Returns: The start date and time in the form of a const UtCalendar reference.

Referenced by WsfSpaceMoverBase::CreateKinematicModel(), WsfOrbitalScriptEvent::ExecuteEvent(), WsfOrbitalManeuver::GetTargetPropagatorPerception(), WsfAccessReport::Initialize(), WsfEclipseReport::Initialize(), WsfNORAD_SpaceMover::Initialize(), WsfOrbitalScriptEvent::Initialize(), WsfOrbitDeterminationKalmanFilter::Initialize(), WsfSpaceMover::Initialize(), WsfSpaceMoverBase::Initialize(), WsfIntegratingSpaceMover::Initialize2(), WsfSpaceMoverBase::Initialize2(), wsf::coverage::Coverage::PendingStart(), wsf::event::utilsCSV::PrintDateTime(), wsf::event::utils::PrintTrackData(), wsf::event::utilsCSV::PrintTrackData(), WsfSpaceMoverBase::Update(), UT_DEFINE_SCRIPT_METHOD(), and ~WsfDateTime().

◆ GetStartJulianDate()

double WsfDateTime::GetStartJulianDate ( ) const

Return the Julian date of the start date and time.

Returns: The number of days since 12:00:00 UTC on 1 January 4713 B.C., corresponding to the start date and time.

Referenced by WsfL16::Interface::Initialize(), and ~WsfDateTime().

◆ GetStartTime() [1/2]

double WsfDateTime::GetStartTime ( ) const

Get the time as the number of seconds past midnight of the start day.

Returns: The number of seconds past midnight of the start day. (i.e. Midnight= 0.0, 1AM=3600.0, Noon=43200.0, 11:59:59PM=86399.0)

◆ GetStartTime() [2/2]

void WsfDateTime::GetStartTime	(	int &	aHour,
		int &	aMinute,
		double &	aSecond ) const

Get the start time as the number of hours, minutes and seconds past midnight of the start day.

Parameters

aHour	The start hour (output).
aMinute	The start minute (output).
aSecond	The start second (output).

Referenced by ~WsfDateTime().

◆ operator=()

WsfDateTime & WsfDateTime::operator= ( const WsfDateTime & aRhs )

protecteddelete

operator= declared but not defined to prevent use.

References WsfDateTime().

◆ ProcessInput()

bool WsfDateTime::ProcessInput ( UtInput & aInput )

Process simulation input commands 'start_date' and 'start_time'.

Referenced by ~WsfDateTime().

◆ SetCurrentDateAndTime()

void WsfDateTime::SetCurrentDateAndTime ( )

Referenced by ~WsfDateTime().

◆ SetStartDate()

bool WsfDateTime::SetStartDate	(	int	aYear,
		int	aMonth,
		int	aDay )

Set the start date.

See the NOTE at the top of the file concerning the valid values.

Parameters

aYear	The year to which the date will be set.
aMonth	The month to which the date will be set.
aDay	The day to which the date will be set.

Referenced by ~WsfDateTime().

◆ SetStartEpoch()

bool WsfDateTime::SetStartEpoch ( double aEpoch )

Set the start time as the Epoch (year*1000 + day "." fractional day).

Parameters

aEpoch The epoch of the start time and date.

Referenced by ~WsfDateTime().

◆ SetStartTime()

bool WsfDateTime::SetStartTime	(	int	aHour,
		int	aMinute,
		double	aSecond )

Set the start time as the number of hours, minutes and seconds past midnight of the start day.

Parameters

aHour	The hour to which the time will be set.
aMinute	The minute to which the time will be set.
aSecond	The second to which the time will be set.

Referenced by ~WsfDateTime().

◆ UsingSystemTime()

bool WsfDateTime::UsingSystemTime ( ) const

Return whether this object was initialized with system / wall clock time.

Referenced by ~WsfDateTime().

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ WsfDateTime() [1/2]

◆ WsfDateTime() [2/2]

◆ ~WsfDateTime()

Member Function Documentation

◆ GetCurrentTime() [1/2]

◆ GetCurrentTime() [2/2]

◆ GetJulianDate()

◆ GetStartDate()

◆ GetStartDateAndTime()

◆ GetStartJulianDate()

◆ GetStartTime() [1/2]

◆ GetStartTime() [2/2]

◆ operator=()

◆ ProcessInput()

◆ SetCurrentDateAndTime()

◆ SetStartDate()

◆ SetStartEpoch()

◆ SetStartTime()

◆ UsingSystemTime()