Class: TGraphicType

Declaration: Video.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TMediaType

Inherited By:

None.

Purpose:

Provides a type description for use by the graphic port classes. The current implementation only provides one graphic type, but others can be added later.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive for different codecs.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TGraphicType::TGraphicType

TGraphicType ()
TGraphicType (const TGraphicType &)
TGraphicType (const TToken & typeName)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Called by derived class constructors to initialize type.

Calling Context:

Called by the stream-in operators and before doing an assignment.
Call this function directly.
Called by derived class constructors.

Parameters:

Takes no parameters.
const TGraphicType & -Copy constructor.
const TToken & typeName -The type name for the derived class.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGraphicType::~TGraphicType

virtual ~ TGraphicType ()

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:

Multithread safe.

Other Considerations:

None.

Member Function: TGraphicType::operator=

TGraphicType & operator =(const TGraphicType &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function directly.

Parameters:

const TGraphicType & -The object to copy.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGraphicType::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Call this function directly.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGraphicType::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Call this function directly.

Parameters:

TStream & fromWhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws TInvalidVersionError if the versions don't match.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGraphicType::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash value.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGraphicType::GetRoadPizzaType

static const TGraphicType & GetRoadPizzaType ()

Interface Category:

API.

Purpose:

Type identification.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A TGraphicType used to identify Road Pizza data.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGraphicType::GetDataType

TToken GetDataType () const

Interface Category:

API.

Purpose:

Type identification.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The TToken representing the graphic type.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

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