IExStreamIO Struct Reference
[External Interfaces]

Inheritance diagram for IExStreamIO:
IMCUnknown TBasicGenericData

List of all members.

Public Member Functions

virtual MCCOMErr MCCOMAPI Read (IShTokenStream *stream, ReadAttributeProc readUnknown, void *privData)=0
virtual MCCOMErr MCCOMAPI Write (IShTokenStream *stream)=0
virtual MCCOMErr MCCOMAPI FinishRead (IStreamContext *streamContext)=0

Detailed Description

Derive from StreamIO if your component needs to read/write data that are not included in its parameter map.


Member Function Documentation

virtual MCCOMErr MCCOMAPI IExStreamIO::FinishRead ( IStreamContext streamContext  )  [pure virtual]

This function is called after everything in the component has been read. It allows, for instance, postcomputation on the values that have been read.

Parameters:
streamContext the context of the stream where the values have been read

Implemented in TBasicGenericData.

virtual MCCOMErr MCCOMAPI IExStreamIO::Read ( IShTokenStream stream,
ReadAttributeProc  readUnknown,
void *  privData 
) [pure virtual]

Read the extra data of a component from a stream. The data will be enclosed in a begin '{' token and an end '}' token. Even if no extra data is read, this function should at least read these two tokens.

Parameters:
stream A token stream
readUnknown A callback function to call when an unknown token is encountered.
privData The private data that should be passed to the callback.

Implemented in TBasicGenericData.

virtual MCCOMErr MCCOMAPI IExStreamIO::Write ( IShTokenStream stream  )  [pure virtual]

Writes extra data that are not stored in the parameter map of the component. Unlike Read (cf. above), this function should not write the enclosing tokens, but just the extra data.

Parameters:
stream A tocken stream

Implemented in TBasicGenericData.


The documentation for this struct was generated from the following file:
Generated on Mon Apr 26 22:47:43 2010 for Carrara SDK Doc by  doxygen 1.6.3