class Stream : public xobj

XSIL data stream class.

Inheritance:

Public Methods

Stream(void)

XSIL Stream default Constructor.

Stream(const char* Name, const char* Type=0, const char* Data=0)

XSIL Stream Constructor.

Stream(const Stream& x)

Stream copy constructor

~Stream()

XSIL stream destructor

Stream& operator=(const Stream& x)

Stream copy constructor

void Spew(Xwriter& xout) const

Write it out as an XML document

xobj* Clone(void) const

Clone a stream.

const char* getDelimit(void) const

Get delimiter.

const char* getEncode(void) const

Get encoding.

const char* getObjType(void) const

Get object type

void delimit(char Delim)

Set the delimiter character.

void Add(float x)

Append a float.

void Add(const std::string& x)

Append a string.

void Add(int x)

Append an integer.

void Add(double x)

Add a double float.

void Add(const UCVec& x)

Add a byte string.

void Clear(void)

Clear the stream data.

void Fill(int N, const float* x, int perLine=0)

Fill from floats.

void Fill(int N, const double* x, int perLine=0)

Fill from doubles.

void Fill(int N, const int* x, int perLine=0)

Fill with integers.

void Fill(int N, const std::string x[], int perLine=0)

Fill from strings.

void encode64Data(const char* data, int N)

Fill from string.

void lineBreak(void)

Insert a line break.

void setRemote(const char* File)

Define file for remote stream.

void setData(const char* Data)

set stream data.

void setEncode(const char* Code)

Specify the encoding technique.

void setSize(int Size)

set line size.

Inherited from xobj:

Public Methods

const char* getName(void) const

const char* getType(void) const

const std::string& refName(void) const

const std::string& refType(void) const

void setName(const char* Name)

void setType(const char* Type)

Stream(void)

Construct an unnamed empty stream.

Stream(const char* Name, const char* Type=0, const char* Data=0)

Construct a stream. By default an empty stream is produced.

Stream(const Stream& x)

Stream copy constructor

~Stream()

XSIL stream destructor

Stream& operator=(const Stream& x)

Stream copy constructor

void Spew(Xwriter& xout) const

Write it out as an XML document

xobj* Clone(void) const

Create a identical copy of the current Stream.

Returns:

Pointer to the copy.

const char* getDelimit(void) const

Get the delimiter character.

const char* getEncode(void) const

Get encoding type.

const char* getObjType(void) const

Get object type

void delimit(char Delim)

Set the delimiter character. The delimiter character must be unique.

void Add(float x)

Append a floating point entry to the stream string.

Parameters:

x - float point number to be added to the stream.

void Add(const std::string& x)

Append a string to the stream string.

Parameters:

x - Character string to be appended to the stream.

void Add(int x)

Append a floating point entry to the stream string.

Parameters:

x - Integer number to be added to the stream.

void Add(double x)

Append a floating point entry to the stream string.

Parameters:

x - Double floating point number to be added to the stream.

void Add(const UCVec& x)

Append an unsigned byte string.

Parameters:

x - reference to the byte string descriptor.

void Clear(void)

Clear out the stream data.

void Fill(int N, const float* x, int perLine=0)

Fill stream from a floating point array.

Parameters:

x - float point array to be converted and copied to the stream.

void Fill(int N, const double* x, int perLine=0)

Fill stream from a double floating point array.

Parameters:

x - double array to be converted and copied to the stream.

void Fill(int N, const int* x, int perLine=0)

Fill stream from an integer array.

Parameters:

x - Integer array to be converted and copied to the stream.

void Fill(int N, const std::string x[], int perLine=0)

Fill stream from a string array.

Parameters:

x - String array to be copied to the stream.

void encode64Data(const char* data, int N)

Fill stream with base64 encoded data.

Parameters:

data - String array to be encoded into the stream.
N - length of data to be encoded into the stream.

void lineBreak(void)

Insert a line break at the current position.

void setRemote(const char* File)

Make the stream a remote stream and define the file name.

Parameters:

File - File name or web address from which data are to be read.

void setData(const char* Data)

Set the input data to the specified character string.

Parameters:

Data - pointer to a data string.

void setEncode(const char* Code)

Specify the encoding technique used for binary data.

Parameters:

Code - pointer to a string describing the encodeing technique.

void setSize(int Size)

Set the Maximum line size.

Parameters:

Size - Maximum line size to be used when printing the stream.

alphabetic index hierarchy of classes

generated by doc++