System Interface CATIBBStreamer
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIBBStreamer
Interface to stream and unstream backbone messages.
Role: CATIBBStreamer helps the implementation of the
StreamData and UnstreamData methods of the interface. It provides streaming and unstreaming methods for the main simple data types.
CATIBBStreamer is implemented by the supplied
component. Since your message component derives from this component, it inherits
the implementation of CATIBBStreamer.
Method Index
- o
BeginStream()
- Initializes a backbone message streaming operation.
- o
BeginUnstream(void*,int)
- Begins a backbone message unstreaming operation.
- o
EndStream(int*)
- Ends a backbone message streaming operation and returns the streamed buffer.
- o
EndUnstream()
- Ends a backbone message unstreaming operation.
- o
ResetStreamData()
- Frees the streamed buffer created by a backbone message streaming operation.
- o
StreamByte(char)
- Streams a char.
- o
StreamDouble(double)
- Streams a double.
- o
StreamFixedByteArray(void*,int)
- Streams a fixed size array of bytes.
- o
StreamFixedDoubleArray(double[],int)
- Streams fixed size array of doubles.
- o
StreamFixedFloatArray(float[],int)
- Streams fixed size array of float.
- o
StreamFixedIntArray(int[],int)
- Streams a fixed size array of int.
- o
StreamFixedShortArray(short[],int)
- Streams a fixed size array of short.
- o
StreamFixedUnsignedArray(unsigned int[],int)
- Streams a fixed size array of unsigned int.
- o
StreamFixedUnsignedShortArray(unsigned short[],int)
- Streams a fixed size array of unsigned short.
- o
StreamFloat(float)
- Streams a float.
- o
StreamInt(int)
- Streams an int.
- o
StreamShort(short)
- Streams a short.
- o
StreamString(char*)
- Streams a string.
- o
StreamUnsigned(unsigned int)
- Streams an unsigned int.
- o
StreamUnsignedShort(unsigned short)
- Streams an unsigned short.
- o
StreamVariableByteArray(void*,int)
- Streams a variable size array of bytes.
- o
StreamVariableDoubleArray(double[],int)
- Streams variable size array of doubles.
- o
StreamVariableFloatArray(float[],int)
- Streams variable size array of float.
- o
StreamVariableIntArray(int[],int)
- Streams a variable size array of int.
- o
StreamVariableShortArray(short[],int)
- Streams a variable size array of short.
- o
StreamVariableUnsignedArray(unsigned int[],int)
- Streams a variable size array of unsigned int.
- o
StreamVariableUnsignedShortArray(unsigned short[],int)
- Streams variable size array of unsigned short.
- o
UnstreamByte(char*)
- Unstreams a char.
- o
UnstreamDouble(double*)
- Unstreams a double.
- o
UnstreamFixedByteArray(void*,int)
- Unstreams a fixed size byte array.
- o
UnstreamFixedDoubleArray(double[],int)
- Unstreams a fixed double array.
- o
UnstreamFixedFloatArray(float[],int)
- Unstreams a fixed float array.
- o
UnstreamFixedIntArray(int[],int)
- Unstreams a fixed int array.
- o
UnstreamFixedShortArray(short[],int)
- Unstreams a fixed short array.
- o
UnstreamFixedUnsignedArray(unsigned[],int)
- Unstreams a fixed size array of unsigned int.
- o
UnstreamFixedUnsignedShortArray(unsigned short[],int)
- Unstreams a fixed unsigned short array.
- o
UnstreamFloat(float*)
- Unstreams a float.
- o
UnstreamInt(int*)
- Unstreams an int.
- o
UnstreamNeededStringLength(int*)
- Unstreams the length of a string.
- o
UnstreamShort(short*)
- Unstreams a short.
- o
UnstreamString(char*)
- Unstreams a string.
- o
UnstreamUnsigned(unsigned int*)
- Unstreams an unsigned int.
- o
UnstreamUnsignedShort(unsigned short*)
- Unstreams an unsigned short.
- o
UnstreamVariableArrayLength(int*)
- Unstreams the size of a variable size array.
Methods
o BeginStream
| public virtual BeginStream( | ) |
-
Initializes a backbone message streaming operation.
Role: Mandatory call at the beginning of a streaming operation.
BeginStream must be called at the beginning of a streaming operation
to set or reset the streamed buffer.
o BeginUnstream
| public virtual BeginUnstream( | | iData, |
| | iLength) |
-
Begins a backbone message unstreaming operation.
Role: Mandatory call at the beginning of an unstreaming operation.
BeginUnstream must be called at the beginning of an unstreaming operation
to designate the streamed buffer to unstream.
- Parameters:
-
- iData
- The buffer of data to unstream
- iLength
- The length of the buffer to unstream expressed in bytes
o EndStream
| public virtual EndStream( | | oLength) |
-
Ends a backbone message streaming operation and returns the streamed buffer.
Role: Mandatory call at the end of a streaming operation.
EndStream must be called at the end of a streaming operation
to close the streamed buffer and to retrieve it.
- Parameters:
-
- oLength
- The length of the streamed buffer
- Returns:
- The streamed buffer
o EndUnstream
| public virtual EndUnstream( | ) |
-
Ends a backbone message unstreaming operation.
Role: Mandatory call at the end of an unstreaming operation.
o ResetStreamData
| public virtual ResetStreamData( | ) |
-
Frees the streamed buffer created by a backbone message streaming operation.
Role: Once the backbone message is streamed and sent, the buffer
that contains the streamed message becomes of no use and must be freed
using ResetStreamData.
o StreamByte
| public virtual StreamByte( | | iVal) |
-
Streams a char.
- Parameters:
-
- iVal
- the char to stream
o StreamDouble
| public virtual StreamDouble( | | iDouble) |
-
Streams a double.
- Parameters:
-
- iDouble
- The double to stream
o StreamFixedByteArray
| public virtual StreamFixedByteArray( | const | iTab, |
| | iLength) |
-
Streams a fixed size array of bytes.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamFixedDoubleArray
| public virtual StreamFixedDoubleArray( | const | iTab, |
| | iLength) |
-
Streams fixed size array of doubles.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamFixedFloatArray
| public virtual StreamFixedFloatArray( | const | iTab, |
| | iLength) |
-
Streams fixed size array of float.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamFixedIntArray
| public virtual StreamFixedIntArray( | const | iTab, |
| | iLength) |
-
Streams a fixed size array of int.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamFixedShortArray
| public virtual StreamFixedShortArray( | const | iTab, |
| | iLength) |
-
Streams a fixed size array of short.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamFixedUnsignedArray
| public virtual StreamFixedUnsignedArray( | const | iTab, |
| | iLength) |
-
Streams a fixed size array of unsigned int.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamFixedUnsignedShortArray
| public virtual StreamFixedUnsignedShortArray( | const | iTab, |
| | iLength) |
-
Streams a fixed size array of unsigned short.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamFloat
| public virtual StreamFloat( | | iFloat) |
-
Streams a float.
- Parameters:
-
- iFloat
- The float to stream
o StreamInt
| public virtual StreamInt( | | iInt) |
-
Streams an int.
- Parameters:
-
- iInt
- The int to stream
o StreamShort
| public virtual StreamShort( | | iVal) |
-
Streams a short.
- Parameters:
-
- iShort
- The short to stream
o StreamString
| public virtual StreamString( | const | iString) |
-
Streams a string.
- Parameters:
-
- iString
- The string to stream
o StreamUnsigned
| public virtual StreamUnsigned( | | iUnsignedInt) |
-
Streams an unsigned int.
- Parameters:
-
- iUnsignedInt
- The unsigned int to stream
o StreamUnsignedShort
| public virtual StreamUnsignedShort( | | iVal) |
-
Streams an unsigned short.
- Parameters:
-
- iUnsignedShort
- The unsigned short to stream
o StreamVariableByteArray
| public virtual StreamVariableByteArray( | const | iTab, |
| | iLength) |
-
Streams a variable size array of bytes.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamVariableDoubleArray
| public virtual StreamVariableDoubleArray( | const | iTab, |
| | iLength) |
-
Streams variable size array of doubles.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamVariableFloatArray
| public virtual StreamVariableFloatArray( | const | iTab, |
| | iLength) |
-
Streams variable size array of float.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamVariableIntArray
| public virtual StreamVariableIntArray( | const | iTab, |
| | iLength) |
-
Streams a variable size array of int.
- Parameters:
-
- iTab
- The array of int to stream
- iLength
- The size of the array to stream
o StreamVariableShortArray
| public virtual StreamVariableShortArray( | const | iTab, |
| | iLength) |
-
Streams a variable size array of short.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamVariableUnsignedArray
| public virtual StreamVariableUnsignedArray( | const | iTab, |
| | iLength) |
-
Streams a variable size array of unsigned int.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o StreamVariableUnsignedShortArray
| public virtual StreamVariableUnsignedShortArray( | const | iTab, |
| | iLength) |
-
Streams variable size array of unsigned short.
- Parameters:
-
- iTab
- The array to stream
- iLength
- The size of the array to stream
o UnstreamByte
| public virtual UnstreamByte( | | oChar) |
-
Unstreams a char.
- Parameters:
-
- oChar
- The unstreamed char
o UnstreamDouble
| public virtual UnstreamDouble( | | oDouble) |
-
Unstreams a double.
- Parameters:
-
- oDouble
- The unstreamed double
o UnstreamFixedByteArray
| public virtual UnstreamFixedByteArray( | | oByteArray, |
| | iLength) |
-
Unstreams a fixed size byte array.
- Parameters:
-
- oByteArray
- The unstreamed array
- iLength
- The length of the fixed size array
o UnstreamFixedDoubleArray
| public virtual UnstreamFixedDoubleArray( | | iTab, |
| | iLength) |
-
Unstreams a fixed double array.
- Parameters:
-
- iTab
- The array to fill with doubles
- iLength
- The length of the fixed size array (or obtained using
)
o UnstreamFixedFloatArray
| public virtual UnstreamFixedFloatArray( | | iTab, |
| | iLength) |
-
Unstreams a fixed float array.
- Parameters:
-
- iTab
- The array to fill with floats
- iLength
- The length of the fixed size array (or obtained using
)
o UnstreamFixedIntArray
| public virtual UnstreamFixedIntArray( | | iTab, |
| | iLength) |
-
Unstreams a fixed int array.
- Parameters:
-
- iTab
- The array to fill with ints
- iLength
- The length of the fixed size array (or obtained using
)
o UnstreamFixedShortArray
| public virtual UnstreamFixedShortArray( | | iTab, |
| | iLength) |
-
Unstreams a fixed short array.
- Parameters:
-
- iTab
- The array to fill with shorts
- iLength
- The length of the fixed size array (or obtained using
)
o UnstreamFixedUnsignedArray
| public virtual UnstreamFixedUnsignedArray( | | iTab, |
| | iLength) |
-
Unstreams a fixed size array of unsigned int.
- Parameters:
-
- iTab
- The array to fill with unsigned ints
- iLength
- The length of the fixed size array (or obtained using
)
o UnstreamFixedUnsignedShortArray
| public virtual UnstreamFixedUnsignedShortArray( | | iTab, |
| | iLength) |
-
Unstreams a fixed unsigned short array.
- Parameters:
-
- iTab
- The array to fill with unsigned shorts
- iLength
- The length of the fixed size array (or obtained using
)
o UnstreamFloat
| public virtual UnstreamFloat( | | oFloat) |
-
Unstreams a float.
- Parameters:
-
- oFloat
- The unstreamed float
o UnstreamInt
| public virtual UnstreamInt( | | oInt) |
-
Unstreams an int.
- Parameters:
-
- oInt
- The unstreamed int
o UnstreamNeededStringLength
| public virtual UnstreamNeededStringLength( | | oLength) |
-
Unstreams the length of a string.
- Parameters:
-
- oLength
- The length of the string to unstream
o UnstreamShort
| public virtual UnstreamShort( | | oShort) |
-
Unstreams a short.
- Parameters:
-
- oShort
- The unstreamed short
o UnstreamString
| public virtual UnstreamString( | | oString) |
-
Unstreams a string.
- Parameters:
-
- oString
- The unstreamed string
o UnstreamUnsigned
| public virtual UnstreamUnsigned( | | oUnsignedInt) |
-
Unstreams an unsigned int.
- Parameters:
-
- oUnsignedInt
- The unstreamed unsigned int
o UnstreamUnsignedShort
| public virtual UnstreamUnsignedShort( | | oUnsignedShort) |
-
Unstreams an unsigned short.
- Parameters:
-
- oUnsignedShort
- The unstreamed unsigned short
o UnstreamVariableArrayLength
| public virtual UnstreamVariableArrayLength( | | oLength) |
-
Unstreams the size of a variable size array.
Role: A variable size array can be unstreamed as a fixed-size array
as soon as its size is known.
Before calling the appropriate unstreaming method for a fixed-size array (UnstreamFixed(type)Array),
UnstreamVariableArrayLength enables you to retrieve the array size and
to allocate the array accordingly.
- Parameters:
-
- oLength
- The length (number of elements) of the array to unstream.
This object is included in the file: CATIBBStreamer.h
If needed, your Imakefile.mk should include the module: CATSysCommunication
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.