Navigation:  Module 1 - Energy Accounting > Accounts & Invoices Tab > User Defined Components > Object Types > DateRange Object Type >

InPeriod Method

Previous page Next page
  rev. 2011-02-09        

Description:

Gets the portion of the date range which falls within the specified period, expressed in elapsed  time units.

Syntax:

[DateRange Object].InPeriod( startMonth, startDay, endMonth, endDay)

[DateRange Object].InPeriod( startDate, endDate) (year specific)

Arguments:

Argument

Type

Description

startMonth

Numeric

The start month (1-12)

startDay

Numeric

The start day

endMonth

Numeric

The end month (1-12)

endDay

Numeric

The end day

startDate

DateTime

The start date

endDate

DateTime

The end date

Returns:

The TimeSpan object representing the common period.

Examples:

The variable BillPeriod has been previously defined as DateRange(Date(2009,1,20), Date(2009,6,15)).  Get the time span from BillPeriod which falls within Jan 1 to Feb 1.

Expression

Result

[BillPeriod].InPeriod(1,1,2,1)

12.00:00:00 (12 days)

[BillPeriod].InPeriod(1,1,2,1).Hours

288

[BillPeriod].InPeriod(Date(2009,1,1),Date(2009,2,1))

12.00:00:00 (12 days)

[BillPeriod].InPeriod(Date(2009,7,10),Date(2009,8,15))

00.00:00:00

 



snippet_InPeriod_Method         ©2014 Managing Energy Inc.