CX_PERIODIC_SPAN_TIME

Class hierarchy
Description:

This class maps sequence of regularly spaced points in time, which are all part of a specific time span.

Example:

The periodic time span "every 20 minutes between 10.00 and 11.00 o' clock" contains the time span "from 10.00 to 11.00 o' clock".

Additionally, it contains the interval "20 minutes", which describes specific points in time inside the time span. As shown in the picture below,  this time specification describes the points in time  "10.00, 10.20, 10.40 und 11.00 Uhr".

Code example:

Var(sdate, ptime, value, term, trigger)
CreateTransObject(CX_SPAN_DATE) -> sdate
"24.5.1996-30.5.1996" sdate PutData
CreateTransObject(CX_PERIODIC_SPAN_TIME) -> ptime
"10.00 - 12.00" ptime PutData
CreateTransObject(CX_VALUE) -> value
"1 h" value PutData
value ptime Call(SetFrequency)
CreateTransObject(CX_TERM) -> term
sdate term SetReference(date)
ptime term SetReference(time)
CreateTransObject(CX_TIMED_TRIGGER) -> trigger
term trigger Call(SetTerm)

Screen display

Since this class has been deduced from CX_SPAN_TIME, the input- and output options described for that class can be used for this time span. Moreover, the frequency (time interval between two points in time) needs to be specified. Since this field is of the type CX_VALUE, the input and output can be carried out according to its description. In connection with these display options and with specific InstantView® Statements, the flags that belong to the object play an important role. They can be used to modify the object display.

Operators

The following operators are available for an object of this class.

operator brief description
+, - arithmetics
>, <, = comparisons

Method list (MDI)
function MA* parameter return brief description
Frequency OBJECT interval between two times
GenerateTimes COLL generating all times
SetFrequency (OBJECT) setting a new interval
AddHundredthSecond       adding hundredths of a second
AddSecond       adding seconds
AddMinute       adding minutes
AddHour       adding hours
DayTime     STRING daytime of a specific time
Duration     OBJECT duration return
Encompassed   (OBJECT) INTEGER "Enthalten in"-Test
EndOfPeriod     OBJECT calculating end time
ExportTimeNumber   (INTEGER) STRING exporting time specification
HourOfTime     INTEGER hour fraction of the time
HundredthSecondOfTime     INTEGER hundredth of a second fraction of the time
ImportTimeNumber   (STRING, INTEGER)   importing time specification
JoinPeriods   (OBJECT) VOLATILE_OBJECT joining two passed time spans
MinuteOfTime     INTEGER minute fraction of the time
MLDayTime     MLSTRING multilingual daytime of the time
MovePeriodToEndTime   (OBJECT)   setting the start time without changing the period
MovePeriodToStartTime   (OBJECT)   setting the start time without changing the period
NextTerm   (OBJECT) OBJECT der Zeitpunkt innerhalb des Zeitpunktes
Overlap   (OBJECT) INTEGER overlap test
OverlappingPeriod   (OBJECT) VOLATILE_OBJECT calculating the intersection (disjunction) of two time spans
RealEndOfPeriod     OBJECT calculating the "real" end time
RealStartOfPeriod     OBJECT calculating the "real" start time 
SecondOfTime     INTEGER second fraction of the time
SetDuration   (OBJECT)   setting the duration
SetEndOfPeriod   (OBJECT)   setting the end time and changing the period
SetHour   (INTEGER)   setting a new hour
SetHundredthSecond   (INTEGER)   setting a new hundredth of a second
SetMinute   (INTEGER)   setting a new minute
SetPeriodBorders   (OBJECT, OBJECT)   setting start and end time
SetSecond   (INTEGER)   setting a new second
SetStartOfPeriod   (OBJECT)   setting the start time and changing the period
StartOfPeriod     OBJECT calculating the start time
string   INTEGER CX_STRING provides string display of the object
ValueInMinutes     INTEGER start time in minutes
ValueInSeconds     INTEGER start time in seconds
ValueOfTime     INTEGER start time in hundredths of a second
* MA = member access function

Data directory (DDI)
data field type refernce class I* brief description
this CX_TIME base point in time
frequency CX_VALUE interval between the sequence of times
validEnum ENUMCHAR time span type: "0" = time span with start and end; "1" = start, but there is no end; "2" = end, but there is no start; "3" = infinite time range without start or end
duration CX_VALUE The actual period. A point in time gets mapped for the value "0". Moreover, there can be negative periods as well.
* I = Indizierbares data field

Application in AppsWH
module brief description