OmniPvdFileWriteStream

Defined in pvdruntime/include/OmniPvdFileWriteStream.h

class OmniPvdFileWriteStream : public OmniPvdWriteStream

Used to abstract a file write stream.

Used to set the filename, opening and closing it.

Public Functions

inline virtual ~OmniPvdFileWriteStream()

virtual void setFileName(const char *fileName) = 0

Sets the file name of the file to write to.

Parameters:

fileName – The file name of the file to open

virtual bool openFile() = 0

Opens the file.

Returns:

True if the file opening was successfull

virtual bool closeFile() = 0

Closes the file.

Returns:

True if the file closing was successfull

virtual uint64_t writeBytes(

const uint8_t *bytes,

uint64_t nbrBytes,

) = 0

Write n bytes to the shared memory buffer.

Parameters:

• bytes – pointer to the bytes to write

• nbrBytes – The requested number of bytes to write

Returns:

The actual number of bytes written

virtual bool flush() = 0

Flushes the writes.

Returns:

The success of the operation

virtual bool openStream() = 0

Opens the stream.

Returns:

The success of the operation

virtual bool closeStream() = 0

Closes the stream.

Returns:

The success of the operation