CATMathStream CATMathStream

Usage: you must use this class as is. You should never derive it.


public class CATMathStream

Base class of the stream and unstream operations.


Constructor and Destructor Index


o CATMathStream(CATMathStreamImpl*)
Constructs CATMathStream for stream operation (read and write acces are allowed).
o CATMathStream(istream&,CATMathStreamImpl*)
Constructs CATMathStream for read only stream operation.
o CATMathStream(void*,size_t,CATMathStreamImpl*)
Constructs CATMathStream for read only stream operation.
o CATMathStream(ostream&,size_t,CATBoolean,CATMathStreamImpl*)
Constructs CATMathStream for write only stream operation.
o CATMathStream(char*,CATCGMStreamType,CATBoolean,CATMathStreamImpl*)
Constructs CATMathStream for read only or write only stream operation.
o CATMathStream(size_t,CATCGMStreamType,CATBoolean,CATMathStreamImpl*)
Constructs CATMathStream for stream operation.
o ~CATMathStream()
Destructor

Method Index


o Advance(size_t)
Skips of a given length.
o Clear()
Clear the Contents of the current Stream.
o CloseReadStreamHeader(size_t,short)
Close a CATMathStream for read acces.
o CloseWriteStreamHeader(size_t,short)
Close a CATMathStream for write acces.
o GetCurrentPosition()
Returns the current position.
o GetLength()
Returns the length of this.
o GetMemoryCopy(size_t,void*,size_t&)
Get the CATMathStream contents in a memory area.
o OpenReadStreamHeader(size_t&,short&,short)
Open a CATMathStream for read acces.
o OpenWriteStreamHeader(size_t&,short&,short)
Open a CATMathStream for write acces.
o Read3x3Matrix(CATMath3x3Matrix&,char[])
Reads a CATMath3x3Matrix.
o ReadAxis(CATMathAxis&,char[])
Reads a CATMathAxis.
o ReadBoolean(CATBoolean&,char[])
Reads an CATBoolean.
o ReadBox(CATMathBox&,char[])
Reads a CATMathBox.
o ReadCATUuid(CATUuid&,char[])
Reads a CATUuid.
o ReadConfig(CATSoftwareConfiguration&,char[])
Reads a CATSoftwareConfiguration.
o ReadDouble(double&,char[])
Reads a double.
o ReadDouble(double*,CATLONG32,char[])
Reads an array of doubles.
o ReadFloat(float&,char[])
Reads a float.
o ReadFloat(float*,CATLONG32,char[])
Reads an array of floats.
o ReadLong(CATLONG32&,char[])
Reads a CATLONG32 integer.
o ReadLong(CATLONG32*,CATLONG32,char[])
Reads a CATLONG32 integer.
o ReadPlane(CATMathPlane&,char[])
Reads a CATMathPlane.
o ReadPoint(CATMathPoint&,char[])
Reads a CATMathPoint.
o ReadShort(short&,char[])
Reads a short integer.
o ReadShort(short*,CATLONG32,char[])
Reads an array of short integers.
o ReadStream(CATMathStream&,size_t,char[])
Reads a stream on this.
o ReadString(char*&,char[])
Reads a string.
o ReadTransformation(CATMathTransformation&,char[])
Reads a CATMathTransformation.
o ReadUChar(unsigned char&,char[])
Reads an unsigned char.
o ReadUChar(unsigned char*,CATLONG32,char[])
Reads an array of unsigned chars.
o ReadULong(CATULONG32&,char[])
Reads an CATULONG32 integer.
o ReadULong(CATULONG32*,CATLONG32,char[])
Reads an array of CATULONG32 integers.
o ReadUShort(unsigned short&,char[])
Reads an unsigned short integer.
o ReadVector(CATMathVector&,char[])
Reads a CATMathVector.
o ReadVector2D(CATMathVector2D&,char[])
Reads a CATMathVector2D.
o Reset()
Resets the position to the beginning.
o Write3x3Matrix(CATMath3x3Matrix&,char[])
Writes a CATMath3x3Matrix.
o WriteAxis(CATMathAxis&,char[])
Writes a CATMathAxis.
o WriteBoolean(CATBoolean,char[])
Writes an CATBoolean.
o WriteBox(CATMathBox&,char[])
Writes a CATMathBox.
o WriteCATUuid(CATUuid&,char[])
Writes a CATUuid.
o WriteConfig(CATSoftwareConfiguration&,char[])
Writes a CATSoftwareConfiguration.
o WriteDouble(double,char[])
Writes a double.
o WriteDouble(double*,CATLONG32,char[])
Writes a sequence of doubles.
o WriteFloat(float,char[])
Writes a float.
o WriteFloat(float*,CATLONG32,char[])
Writes a sequence of floats.
o WriteLong(CATLONG32,char[])
Writes a CATLONG32 integer.
o WriteLong(CATLONG32*,CATLONG32,char[])
Writes a sequence of CATLONG32 integers.
o WritePlane(CATMathPlane&,char[])
Writes a CATMathPlane.
o WritePoint(CATMathPoint&,char[])
Writes a CATMathPoint.
o WriteShort(short,char[])
Writes a short integer.
o WriteShort(short*,CATLONG32,char[])
Writes a sequence of short integers.
o WriteStream(CATMathStream&,char[])
Writes the content of a stream on this.
o WriteString(char*,char[])
Writes a string.
o WriteTransformation(CATMathTransformation&,char[])
Writes a CATMathTransformation.
o WriteUChar(unsigned char,char[])
Writes an unsigned char.
o WriteUChar(unsigned char*,CATLONG32,char[])
Writes a sequence of unsigned chars.
o WriteULong(CATULONG32,char[])
Writes an CATULONG32 integer.
o WriteULong(CATULONG32*,CATLONG32,char[])
Writes a sequence of CATULONG32 integers.
o WriteUShort(unsigned short,char[])
Writes an unsigned short integer.
o WriteVector(CATMathVector&,char[])
Writes a CATMathVector.
o WriteVector2D(CATMathVector2D&,char[])
Writes a CATMathVector2D.

Constructor and Destructor


o CATMathStream
public CATMathStream( ipImpl= NULL)
Constructs CATMathStream for stream operation (read and write acces are allowed).
Parameters:
ipMathStreamImpl
Internal use only. Do not change the default value.
o CATMathStream
public CATMathStream( ioFile,
ipImpl= NULL)
Constructs CATMathStream for read only stream operation.
Parameters:
ioFile
The stream from which the stream is read.
The first acces of the stream may be done with OpenWriteStreamHeader.
The last acces of the stream may be done with CloseWriteStreamHeader.
ipMathStreamImpl
Internal use only. Do not change the default value.
o CATMathStream
public CATMathStream( iBuffer,
iSizeBuffer,
ipImpl= NULL)
Constructs CATMathStream for read only stream operation.
Parameters:
iBuffer
The memory area directly acceded for the read operation.
iSizeBuffer
The size in bytes of iBuffer.
ipMathStreamImpl
Internal use only. Do not change the default value.
o CATMathStream
public CATMathStream( ioFile,
iInitialNumberOfBytes= 0,
const iEnableByAddress= FALSE,
ipImpl= NULL)
Constructs CATMathStream for write only stream operation.
Parameters:
ioFile
The stream on which the stream is saved.
iInitialNumberOfBytes
The initial memory size of internal buffer in bytes.
The first acces of the stream may be done with OpenReadStreamHeader.
The last acces of the stream may be done with CloseReadStreamHeader.
iEnableByAddress
Reserved for future use. Do not change the default value.
ipMathStreamImpl
Internal use only. Do not change the default value.
o CATMathStream
public CATMathStream( const iFilename,
const iAcces,
const iEnableByAddress= FALSE,
ipImpl= NULL)
Constructs CATMathStream for read only or write only stream operation.
Parameters:
ioFile
The stream from which the stream is read.
iAcces
The kind of acces allowed on the CATMathStream.
The first acces of the stream may be done with OpenReadStreamHeader or OpenWriteStreamHeader.
The last acces of the stream may be done with CloseReadStreamHeader or CloseWriteStreamHeader.
iEnableByAddress
Reserved for future use. Do not change the default value.
ipMathStreamImpl
Internal use only. Do not change the default value.
o CATMathStream
public CATMathStream( iInitialNumberOfBytes,
const iAcces,
const iEnableByAddress= FALSE,
ipImpl= NULL)
Constructs CATMathStream for stream operation.
Parameters:
iInitialNumberOfBytes
The initial number of bytes for internal buffer.
iAcces
The kind of acces allowed on the CATMathStream.
iEnableByAddress
Reserved for future use. Do not change the default value.
ipMathStreamImpl
Internal use only. Do not change the default value.
o ~CATMathStream
public virtual ~CATMathStream()
Destructor

Methods


o Advance
public Advance( iSiz)
Skips of a given length.
o Clear
public Clear()
Clear the Contents of the current Stream.
o CloseReadStreamHeader
public CloseReadStreamHeader( const iWhere,
const iLevel)
Close a CATMathStream for read acces.
Parameters:
iWhere
internal parameter given by CloseReadStreamHeader.
iLevel
internal parameter given by CloseReadStreamHeader.
o CloseWriteStreamHeader
public CloseWriteStreamHeader( const iWhere,
const iLevel)
Close a CATMathStream for write acces.
Parameters:
iWhere
internal parameter given by OpenWriteStreamHeader.
iLevel
internal parameter given by OpenWriteStreamHeader.
o GetCurrentPosition
public GetCurrentPosition()
Returns the current position.
o GetLength
public GetLength()
Returns the length of this.
Returns:
The length.
o GetMemoryCopy
public GetMemoryCopy( const iSizeBuffer,
iBuffer,
ioSizeCopied)
Get the CATMathStream contents in a memory area.
Parameters:
iSizeBuffer
The size in bytes of iBuffer, given to avoid overwriting.
iBuffer
The memory area where bytes are copied.
ioSizeCopied
Number of bytes copied in iBuffer.
o OpenReadStreamHeader
public OpenReadStreamHeader( oWhere,
oLevel,
const iWithEndianFormat= 1)
Open a CATMathStream for read acces.
Parameters:
oWhere
internal parameter you must give back at CloseReadStreamHeader.
oLevel
internal parameter you must give back at CloseReadStreamHeader.
iWithEndianFormat
little big endian format is written, allowing interoperability between different Operating Systems
o OpenWriteStreamHeader
public OpenWriteStreamHeader( oWhere,
oLevel,
const iWithEndianFormat= 1)
Open a CATMathStream for write acces.
Parameters:
oWhere
internal parameter you must give back at CloseWriteStreamHeader.
oLevel
internal parameter you must give back at CloseWriteStreamHeader.
iWithEndianFormat
little big endian format is written, allowing interoperability between different Operating Systems
o Read3x3Matrix
public Read3x3Matrix( ioMatrix,
const iReservedLabel= "")
Reads a CATMath3x3Matrix.
Parameters:
ioMatrix
The read CATMath3x3Matrix.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadAxis
public ReadAxis( ioAxis,
const iReservedLabel= "")
Reads a CATMathAxis.
Parameters:
ioAxis
The read CATMathAxis.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadBoolean
public ReadBoolean( ioBoolean,
const iReservedLabel= "")
Reads an CATBoolean.
Parameters:
iBoolean
The read CATBoolean.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadBox
public ReadBox( ioBox,
const iReservedLabel= "")
Reads a CATMathBox.
Parameters:
ioBox
The read box.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadCATUuid
public ReadCATUuid( iid,
const iReservedLabel= "")
Reads a CATUuid.
Parameters:
iid
The read CATUuid.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadConfig
public ReadConfig( ioConfig,
const iReservedLabel= "")
Reads a CATSoftwareConfiguration.
Parameters:
iConfig
The read CATSoftwareConfiguration.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadDouble
public ReadDouble( ioDouble,
const iReservedLabel= "")
Reads a double.
Parameters:
ioDouble
The read double.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadDouble
public ReadDouble( ioArrayDouble,
const iNbCell,
const iReservedLabel= "")
Reads an array of doubles.
Parameters:
ioArrayDouble
The array of doubles to write.
iNbCell
The size of ioArrayDouble. If the the count of doubles to read is greater than iNbCell, nothing is read.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadFloat
public ReadFloat( ioFloat,
const iReservedLabel= "")
Reads a float.
Parameters:
ioFloat
The read float.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadFloat
public ReadFloat( ioArrayFloat,
const iNbCell,
const iReservedLabel= "")
Reads an array of floats.
Parameters:
ioArrayFloat
The array of floats to write.
iNbCell
The size of ioArrayFloat. If the the count of floats to read is greater than iNbCell, nothing is read.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadLong
public ReadLong( ioLong,
const iReservedLabel= "")
Reads a CATLONG32 integer.
Parameters:
ioLong
The read CATLONG32 integer.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadLong
public ReadLong( ioArrayLong,
const iNbCell,
const iReservedLabel= "")
Reads a CATLONG32 integer.
Parameters:
ioLong
The read CATLONG32 integer.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadPlane
public ReadPlane( ioPlane,
const iReservedLabel= "")
Reads a CATMathPlane.
Parameters:
ioPlane
The read CATMathPlane.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadPoint
public ReadPoint( ioPoint,
const iReservedLabel= "")
Reads a CATMathPoint.
Parameters:
ioPoint
The read CATMathPoint.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadShort
public ReadShort( ioShort,
const iReservedLabel= "")
Reads a short integer.
Parameters:
ioShort
The read short integer.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadShort
public ReadShort( ioArrayShort,
const iNbCell,
const iReservedLabel= "")
Reads an array of short integers.
Parameters:
ioArrayShort
The array of short integers to write.
iNbCell
The size of ioArrayShort. If the the count of short integers to read is greater than iNbCell, nothing is read.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadStream
public ReadStream( iToRead,
iLengthToRead,
const iReservedLabel= "")
Reads a stream on this.
Parameters:
iToRead
The stream to read.
iLengthToRead
the length of iToRead.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadString
public ReadString( ioString,
const iReservedLabel= "")
Reads a string.
Parameters:
ioString
The read string.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadTransformation
public ReadTransformation( ioTransfo,
const iReservedLabel= "")
Reads a CATMathTransformation.
Parameters:
ioTransfo
The read CATMathTransformation.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadUChar
public ReadUChar( ioUChar,
const iReservedLabel= "")
Reads an unsigned char.
Parameters:
ioUChar
The read char.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadUChar
public ReadUChar( ioArrayUChar,
const iNbCell,
const iReservedLabel= "")
Reads an array of unsigned chars.
Parameters:
ioArrayUChar
The array of unsigned chars to write.
iNbCell
The size of ioArrayUChar. If the the count of UChars to read is greater than iNbCell, nothing is read.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadULong
public ReadULong( ioULong,
const iReservedLabel= "")
Reads an CATULONG32 integer.
Parameters:
ioULong
The read unsigned short integer.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadULong
public ReadULong( ioArrayULong,
const iNbCell,
const iReservedLabel= "")
Reads an array of CATULONG32 integers.
Parameters:
ioArrayULong
The array of CATLONG32 integers to write.
iNbCell
The size of ioArrayULong. If the the count of CATLONG32 integers to read is greater than iNbCell, nothing is read.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadUShort
public ReadUShort( ioUShort,
const iReservedLabel= "")
Reads an unsigned short integer.
Parameters:
ioUShort
The read unsigned short integer.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadVector
public ReadVector( ioVector,
const iReservedLabel= "")
Reads a CATMathVector.
Parameters:
ioVector
The read CATMathVector.
iReservedLabel
Reserved for future use. Do not change the default value.
o ReadVector2D
public ReadVector2D( ioVector2D,
const iReservedLabel= "")
Reads a CATMathVector2D.
Parameters:
ioVector2D
The read CATMathVector2D.
iReservedLabel
Reserved for future use. Do not change the default value.
o Reset
public Reset()
Resets the position to the beginning.
o Write3x3Matrix
public Write3x3Matrix( const ioMatrix,
const iReservedLabel= "")
Writes a CATMath3x3Matrix.
Parameters:
ioMatrix
The CATMath3x3Matrix to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteAxis
public WriteAxis( const ioAxis,
const iReservedLabel= "")
Writes a CATMathAxis.
Parameters:
ioAxis
The CATMathAxis to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteBoolean
public WriteBoolean( const iBoolean,
const iReservedLabel= "")
Writes an CATBoolean.
Parameters:
iBoolean
The CATBoolean to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteBox
public WriteBox( const ioBox,
const iReservedLabel= "")
Writes a CATMathBox.
Parameters:
iBox
The box to write. The box is written with floats, precision can be lost.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteCATUuid
public WriteCATUuid( const iid,
const iReservedLabel= "")
Writes a CATUuid.
Parameters:
iid
The CATUuid to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteConfig
public WriteConfig( const iConfig,
const iReservedLabel= "")
Writes a CATSoftwareConfiguration.
Parameters:
iConfig
The CATSoftwareConfiguration to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteDouble
public WriteDouble( const iDouble,
const iReservedLabel= "")
Writes a double.
Parameters:
iDouble
The double to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteDouble
public WriteDouble( const iDoubleArray,
const iNbCell,
const iReservedLabel= "")
Writes a sequence of doubles.
Parameters:
iDoubleArray
The array of doubles to write.
iNbCell
The count of doubles to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteFloat
public WriteFloat( const iFloat,
const iReservedLabel= "")
Writes a float.
Parameters:
iFloat
The float to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteFloat
public WriteFloat( const iFloatArray,
const iNbCell,
const iReservedLabel= "")
Writes a sequence of floats.
Parameters:
iFloatArray
The array of floats to write.
iNbCell
The count of floats to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteLong
public WriteLong( const iLong,
const iReservedLabel= "")
Writes a CATLONG32 integer.
Parameters:
iLong
The CATLONG32 to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteLong
public WriteLong( const iLongArray,
const iNbCell,
const iReservedLabel= "")
Writes a sequence of CATLONG32 integers.
Parameters:
iLongArray
The array of longs to write.
iNbCell
The count of longs to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WritePlane
public WritePlane( const ioPlane,
const iReservedLabel= "")
Writes a CATMathPlane.
Parameters:
ioPlane
The CATMathPlane to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WritePoint
public WritePoint( const ioPoint,
const iReservedLabel= "")
Writes a CATMathPoint.
Parameters:
ioPoint
The CATMathPoint to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteShort
public WriteShort( const iShort,
const iReservedLabel= "")
Writes a short integer.
Parameters:
iShort
The short to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteShort
public WriteShort( const iShortArray,
const iNbCell,
const iReservedLabel= "")
Writes a sequence of short integers.
Parameters:
iShortArray
The array of shorts to write.
iNbCell
The count of shorts to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteStream
public WriteStream( const iToWrite,
const iReservedLabel= "")
Writes the content of a stream on this.
Parameters:
iToWrite
The stream
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteString
public WriteString( const iString,
const iReservedLabel= "")
Writes a string.
Parameters:
iString
The string to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteTransformation
public WriteTransformation( const ioTransfo,
const iReservedLabel= "")
Writes a CATMathTransformation.
Parameters:
ioTransfo
The CATMathTransformation to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteUChar
public WriteUChar( const iUChar,
const iReservedLabel= "")
Writes an unsigned char.
Parameters:
iUChar
The unsigned char to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteUChar
public WriteUChar( const iUCharArray,
const iNbCell,
const iReservedLabel= "")
Writes a sequence of unsigned chars.
Parameters:
iUCharArray
The array of unsigned chars to write.
iNbCell
The count of unsigned chars to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteULong
public WriteULong( const iULong,
const iReservedLabel= "")
Writes an CATULONG32 integer.
Parameters:
iULong
The CATULONG32 to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteULong
public WriteULong( const iULongArray,
const iNbCell,
const iReservedLabel= "")
Writes a sequence of CATULONG32 integers.
Parameters:
iULongArray
The array of CATULONG32s to write.
iNbCell
The count of CATULONG32s to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteUShort
public WriteUShort( const iUShort,
const iReservedLabel= "")
Writes an unsigned short integer.
Parameters:
iUShort
The unsigned short to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteVector
public WriteVector( const ioVector,
const iReservedLabel= "")
Writes a CATMathVector.
Parameters:
ioVector
The CATMathVector to write.
iReservedLabel
Reserved for future use. Do not change the default value.
o WriteVector2D
public WriteVector2D( const ioVector2D,
const iReservedLabel= "")
Writes a CATMathVector2D.
Parameters:
ioVector2D
The CATMathVector2D to write.
iReservedLabel
Reserved for future use. Do not change the default value.

This object is included in the file: CATMathStream.h
If needed, your Imakefile.mk should include the module: CATMathStream

Copyright © 1999-2015, Dassault Systèmes. All rights reserved.