FBTime Class Reference

FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime
Inheritance diagram for FBTime:
Inheritance graph
[legend]

List of all members.


Detailed Description

Time data structure.

See samples: FBTime.py, CameraSwitcher.py, StartKeysAtCurrentTime.py.


Public Member Functions

  FBTime (long pTime=0)
  FBTime (int pHour, int pMinute, int pSecond=0, int pFrame=0, int pField=0, FBTimeMode pTimeMode=kFBTimeModeDefault, float pFramerate=0.0)
  Constructor.
long  Get ()
  Get time value (long).
long  Get ()
  Get time value (long).
long  GetFrame (bool pCummul=False, FBTimeMode pTimeMode=kFBTimeModeDefault, float pFramerate=0.0)
  Get the frame count.
long  GetMilliSeconds ()
  Get milliseconds for time.
float  GetSecondDouble ()
  Get seconds as double.
str  GetTimeString ()
  Get time as a string.
  Set (long pTime)
  Set time value from a long.
  SetMilliSeconds (long pMilliSeconds)
  Set milliseconds time.
  SetSecondDouble (float pTime)
  Set seconds from double.
  SetTime (int pHour, int pMinute=0, int pSecond=0, int pFrame=0, int pField=0, FBTimeMode pTimeMode=kFBTimeModeDefault, float pFramerate=0.0)
  Set time (from separate values).
  SetTimeString (str pTime)
  Set time from string.

Public Attributes

FBTime  Infinity
  Time constant: Infinity, the largest time value.
FBTime  MinusInfinity
  Time constant: Minus Infinity, the lowest negative time value.
FBTime  OneHour
  Time constant: One Hour.
FBTime  OneMinute
  Time constant: One Minute.
FBTime  OneSecond
  Time constant: One Second.
FBTime  Zero
  Time constant: Zero.

Constructor & Destructor Documentation

FBTime ( long  pTime = 0  ) 

FBTime ( int  pHour,
int  pMinute,
int  pSecond = 0,
int  pFrame = 0,
int  pField = 0,
FBTimeMode  pTimeMode = kFBTimeModeDefault,
float  pFramerate = 0.0  
)

Constructor.

Parameters:
pHour  Hour value.
pMinute  Minute value.
pSecond  Second value.
pFrame  Frame value.
pField  Field value.
pTimeMode  Time mode(default=kFBTimeModeDefault).
pFramerate  Custom framerate value in case of pTimeMode = kFBTimeModeCustom.

Member Function Documentation

long Get (  ) 

Get time value (long).

Returns:
Time value as long.

long Get (  ) 

Get time value (long).

Returns:
Time value as long.

long GetFrame ( bool  pCummul = False,
FBTimeMode  pTimeMode = kFBTimeModeDefault,
float  pFramerate = 0.0  
)

Get the frame count.

With this function, it is possible to obtain the cumulative and local frame counts.

Parameters:
pCummul  Cumulative frame count (true ), or local frame count (false )(default is false).
pTimeMode  Time mode to get the constant (default is kFBTimeModeDefault).
pFramerate  Custom framerate value in case of pTimeMode = kFBTimeModeCustom.
Returns:
Frames per second constant for the specified time mode.

long GetMilliSeconds (  ) 

Get milliseconds for time.

Returns:
MilliSeconds value.

float GetSecondDouble (  ) 

Get seconds as double.

Returns:
Seconds in double form.

str GetTimeString (  ) 

Get time as a string.

Returns:
String value of time.

Set ( long  pTime  ) 

Set time value from a long.

Parameters:
pTime  Time value to set.

SetMilliSeconds ( long  pMilliSeconds  ) 

Set milliseconds time.

Parameters:
pMilliSeconds  MilliSeconds value.

SetSecondDouble ( float  pTime  ) 

Set seconds from double.

Parameters:
pTime  Time to set seconds from.

SetTime ( int  pHour,
int  pMinute = 0,
int  pSecond = 0,
int  pFrame = 0,
int  pField = 0,
FBTimeMode  pTimeMode = kFBTimeModeDefault,
float  pFramerate = 0.0  
)

Set time (from separate values).

Parameters:
pHour  Hour value.
pMinute  Minute value(default=0).
pSecond  Second value(default=0).
pFrame  Frame value(default=0).
pField  Field value(default=0).
pTimeMode  Time mode to get time as(default=kFBTimeModeDefault).
pFramerate  Custom framerate value in case of pTimeMode = kFBTimeModeCustom.

SetTimeString ( str  pTime  ) 

Set time from string.

Parameters:
pTime  String to set time from.

Member Data Documentation

FBTime Infinity

Time constant: Infinity, the largest time value.

FBTime MinusInfinity

Time constant: Minus Infinity, the lowest negative time value.

FBTime OneHour

Time constant: One Hour.

FBTime OneMinute

Time constant: One Minute.

FBTime OneSecond

Time constant: One Second.

FBTime Zero

Time constant: Zero.


Generated on Tue Feb 9 19:34:41 2010 for Python Reference Guide by  doxygen 1.5.3