Class: TSMPTETimeCode

Declaration: SMPTETimeCode.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

TSMPTE24fps TSMPTE25fps TSMPTE30fps TSMPTE30fpsDrop

Purpose:

An abstract base class for SMPTE time classes with specific rates. The SMPTE format for time is hh:mm:ss:ff, where 0 <= hh <= 23 0 <= mm <= 59 0 <= ss <= 59 0 <= ff <= 29 (depending on the frame rate). TSMPTETime code extends this format by: Allowing hh to be >23. Providing fractional frames.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive to provide specific frame rate representations.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TSMPTETimeCode::GetTimeCode

virtual void GetTimeCode (Hours &, Minutes &, Seconds &, Frames &) const

Interface Category:

API.

Purpose:

Gets the time code in hours, minutes, seconds, and frames.

Calling Context:

Call this function directly.

Parameters:

Hours & -The hours.
Minutes & -The minutes.
Seconds & -The seconds.
Frames & -The frames.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSMPTETimeCode::TSMPTETimeCode

Interface Category:

API.

Purpose:

Default constructor.
Constructor that takes a TTime object.
Copy constructor.

Calling Context:

Called by the stream-in operators and to create an undefined object.
Call this function directly.
Call this function directly.

Parameters:

Takes no parameters.
const TTime & -The TTime object.
const TSMPTETimeCode & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSMPTETimeCode::operator=

TSMPTETimeCode & operator =(const TSMPTETimeCode &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function directly.

Parameters:

const TSMPTETimeCode & -The source object for the assignment.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSMPTETimeCode::~TSMPTETimeCode

virtual ~ TSMPTETimeCode ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSMPTETimeCode::ConvertToTimeCode

virtual void ConvertToTimeCode (Hours &, Minutes &, Seconds &, Frames &, double framesPerSecond) const

Interface Category:

API.

Purpose:

Given a rate, convert hours, minutes, seconds, and frames to an internal value.

Calling Context:

Called by derived classes when constructing.

Parameters:

Hours & -The hours.
Minutes & -The minutes.
Seconds & -The seconds.
Frames & -The frames.
double framesPerSecond -The frame rate.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.