MStreamUtils Class Reference
[OpenMaya - API module for common classes]

#include <MStreamUtils.h>

List of all members.


Detailed Description

Stream functionality.

This class provides some standard stream functionality for developers working in C++ or script. Write methods are provided for writing to ASCII or binary. Read methods are only binary.


Static Public Member Functions

static std::ostream &  stdErrorStream ()
static std::ostream &  stdOutStream ()
static MStatus  writeChar (std::ostream &out, const char value, bool binary=false)
static MStatus  writeCharBuffer (std::ostream &out, const char *value, bool binary=false)
static MStatus  writeInt (std::ostream &out, const int value, bool binary=false)
static MStatus  writeFloat (std::ostream &out, const float value, bool binary=false)
static MStatus  writeDouble (std::ostream &out, const double value, bool binary=false)
static MStatus  readChar (std::istream &in, char &value, bool binary=false)
static MStatus  readCharBuffer (std::istream &in, char *&value, unsigned int length, bool binary=false)
static MStatus  readInt (std::istream &in, int &value, bool binary=false)
static MStatus  readFloat (std::istream &in, float &value, bool binary=false)
static MStatus  readDouble (std::istream &in, double &value, bool binary=false)

Member Function Documentation

std::ostream & MStreamUtils::stdErrorStream (  )  [static]

This method returns the cerr ostream.

std::ostream & MStreamUtils::stdOutStream (  )  [static]

This method returns the cout ostream.

MStatus MStreamUtils::writeChar ( std::ostream &  out,
const char  value,
bool  binary = false  
) [static]

This method is used to write out a "char" value to an ostream.

Parameters:
[in]  out  the output ostream
[in]  value  value to write out
[in]  binary  If true, the byte(s) of value are written out. If false, the string representation is written out.
Returns:

MStatus MStreamUtils::writeCharBuffer ( std::ostream &  out,
const char *  value,
bool  binary = false  
) [static]

This method is used to write out a "const char*" value to an ostream.

Parameters:
[in]  out  the output ostream
[in]  value  value to write out
[in]  binary  If true, the byte(s) of the value string are written out. If false, the string representation is written out.
Returns:

MStatus MStreamUtils::writeInt ( std::ostream &  out,
const int  value,
bool  binary = false  
) [static]

This method is used to write out a "int" value to an ostream.

Parameters:
[in]  out  the output ostream
[in]  value  value to write out
[in]  binary  If true, the byte(s) of value are written out. If false, the string representation is written out.
Returns:

MStatus MStreamUtils::writeFloat ( std::ostream &  out,
const float  value,
bool  binary = false  
) [static]

This method is used to write out a "float" value to an ostream.

Parameters:
[in]  out  the output ostream
[in]  value  value to write out
[in]  binary  If true, the byte(s) of value are written out. If false, the string representation is written out.
Returns:

MStatus MStreamUtils::writeDouble ( std::ostream &  out,
const double  value,
bool  binary = false  
) [static]

This method is used to write out a "double" value to an ostream.

Parameters:
[in]  out  the output ostream
[in]  value  value to write out
[in]  binary  If true, the byte(s) of value are written out. If false, the string representation is written out.
Returns:

MStatus MStreamUtils::readChar ( std::istream &  in,
char &  value,
bool  binary = false  
) [static]

This method is used to read a "char" binary value from an istream.

Parameters:
[in]  in  the input istream
[out]  value  where the input is stored
Returns:

MStatus MStreamUtils::readCharBuffer ( std::istream &  in,
char *&  value,
unsigned int  length,
bool  binary = false  
) [static]

This method is used to read a "char*" binary value from an istream.

Parameters:
[in]  in  the input istream
[out]  value  where the input is stored
Returns:

MStatus MStreamUtils::readInt ( std::istream &  in,
int &  value,
bool  binary = false  
) [static]

This method is used to read a "int" binary value from an istream.

Parameters:
[in]  in  the input istream
[out]  value  where the input is stored
Returns:

MStatus MStreamUtils::readFloat ( std::istream &  in,
float &  value,
bool  binary = false  
) [static]

This method is used to read a "float" binary value from an istream.

Parameters:
[in]  in  the input istream
[out]  value  where the input is stored
Returns:

MStatus MStreamUtils::readDouble ( std::istream &  in,
double &  value,
bool  binary = false  
) [static]

This method is used to read a "double" binary value from an istream.

Parameters:
[in]  in  the input istream
[out]  value  where the input is stored
Returns:

Autodesk® Maya® 2011 © 1997-2010 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6