Python Reference Guide
 
Loading...
Searching...
No Matches
FBTimeSpan Class Reference

TimeSpan class. More...

#include <pyfbsdk.h>

Inheritance diagram for FBTimeSpan:

Public Member Functions

 FBTimeSpan (FBTime pStart=0, FBTime pStop=0)
 Constructor.
 
int GetDirection ()
 Get the direction of the timespan.
 
FBTime GetDuration ()
 Get the unsigned duration value of a timespan.
 
FBTime GetSignedDuration ()
 Get the signed duration value of a timespan.
 
FBTime GetStart ()
 Get the start/stop time.
 
FBTime GetStart ()
 
FBTime GetStop ()
 
FBTime GetStop ()
 
 Set (FBTime pStart, FBTime pStop)
 Set the TimeSpan.
 

Detailed Description

TimeSpan class.


Constructor & Destructor Documentation

◆ FBTimeSpan()

FBTimeSpan ( FBTime  pStart = 0,
FBTime  pStop = 0 
)

Constructor.

Parameters
pStartStart time(default=0).
pStopStop time(default=0).

Member Function Documentation

◆ GetDirection()

int GetDirection ( )

Get the direction of the timespan.

Returns 1 if positive, -1 otherwise.

Returns
Direction of timespan.

◆ GetDuration()

FBTime GetDuration ( )

Get the unsigned duration value of a timespan.

Returns
Unsigned duration of the timespan.

◆ GetSignedDuration()

FBTime GetSignedDuration ( )

Get the signed duration value of a timespan.

Returns
Signed duration of the timespan.

◆ GetStart() [1/2]

FBTime GetStart ( )

Get the start/stop time.

Returns
Start/Stop time.

◆ GetStart() [2/2]

FBTime GetStart ( )

◆ GetStop() [1/2]

FBTime GetStop ( )

◆ GetStop() [2/2]

FBTime GetStop ( )

◆ Set()

Set ( FBTime  pStart,
FBTime  pStop 
)

Set the TimeSpan.

Parameters
pStartStart time.
pStopStop time.