class Geo::IGeoStream

    └>Geo::IGeoInputStream

An IGeoStream allows you to read/write memory/files in a consistent manner, and is an extension point for users wishing to control where data is stored.

The simplest implementation is

Functions

Enums

virtual Geo::IGeoInputStream::~IGeoInputStream

public: virtual ~IGeoInputStream()

Deleting a stream should behave like a close operation.

virtual Geo::IGeoStream::~IGeoStream

public: virtual ~IGeoStream()

Deleting a stream should behave like a close operation.

virtual u32 Geo::IGeoStream::BeginType

public: virtual u32 BeginType
(
    TypeId type,
    u32 count
)

Provide information about the typed data written to the stream.

virtual void Geo::IGeoStream::EndType

public: virtual void EndType
(
    u32 index
)

Provide information about the typed data written to the stream.

virtual u64 Geo::IGeoStream::GetPosition

public: u64 GetPosition() const

Return the position of the read/write pointer within the stream (prototype matches ftell)

virtual Geo::u64 Geo::IGeoInputStream::GetPosition

public: Geo::u64 GetPosition() const

Return the position of the read/write pointer within the stream (prototype matches ftell)

virtual bool Geo::IGeoInputStream::IsEof

public: bool IsEof() const

Is the read pointer at the end of the file (as with feof, only returns true if you have read past end)

virtual bool Geo::IGeoStream::IsEof

public: bool IsEof() const

Is the read/write pointer at the end of the file (as with feof, only returns true if you have read past end)

virtual bool Geo::IGeoStream::IsOk

public: bool IsOk() const

Tests if the stream is valid.

virtual bool Geo::IGeoInputStream::IsOk

public: bool IsOk() const

Tests if the stream is valid.

bool Geo::IGeoInputStream::Read

public: bool Read
(
    TIter begin,
    TIter end
)

Read a collection of objects, returning true on success.

Object must be considered blittable (see IsBlittable<T>). Note that the storage must have been pre-allocated as it will write directly to the iterators provided. Given that we do not have the STL-style 'back-inserter' classes, for GeoArrays you should use the ReadArray helper function.

bool Geo::IGeoInputStream::Read

public: bool Read
(
    T(&) a
)

Read a fixed size array.

virtual size_t Geo::IGeoInputStream::Read

public: size_t Read
(
    void * pData,
    size_t size,
    size_t count
)

Read data (prototype matches fread). Prefer to use the templated Read methods.

GEO_FORCE_INLINE bool Geo::IGeoInputStream::Read

public: GEO_FORCE_INLINE bool Read
(
    T & object
)

Read a single object, returning true on success.

There must either be a ReadObject overload for T, or T be considered blittable (see IsBlittable<T>).

bool Geo::IGeoInputStream::ReadImpl

public: bool ReadImpl
(
    T & object,
    GeoStd::TrueType
)

Read a single object, returning true on success.

There must either be a ReadObject overload for T, or T be considered blittable (see IsBlittable<T>).

bool Geo::IGeoInputStream::ReadImpl

public: bool ReadImpl
(
    T & object,
    GeoStd::FalseType
)

Read a single object, returning true on success.

There must either be a ReadObject overload for T, or T be considered blittable (see IsBlittable<T>).

virtual Geo::GeoArray<char> Geo::IGeoInputStream::ReadToEnd

public: virtual Geo::GeoArray< char > ReadToEnd()

Reads the stream to its end and returns the data as a char array.

virtual bool Geo::IGeoInputStream::SetPosition

public: bool SetPosition
(
    Geo::u64 pos
)

Set the position of the read/write pointer within the stream (prototype matches fseek)

virtual bool Geo::IGeoStream::SetPosition

public: bool SetPosition
(
    u64 pos
)

Set the position of the read/write pointer within the stream (prototype matches fseek)

bool Geo::IGeoStream::Write

public: bool Write
(
    TIter begin,
    TIter end
)

Write a collection of objects, in range [begin, end) as STL-style classes support.

Objects have same requirements single object Write (see IsBlittable<T>).

virtual size_t Geo::IGeoStream::Write

public: size_t Write
(
    const void * pData,
    size_t size,
    size_t count
)

Write data (prototype matches fwrite). Prefer to use the templated Write methods.

bool Geo::IGeoStream::Write

public: bool Write
(
    const T(&) a
)

Write a fixed size array.

GEO_FORCE_INLINE bool Geo::IGeoStream::Write

public: GEO_FORCE_INLINE bool Write
(
    const T & object
)

Write a single object, returning true on success.

There must either be a WriteObject overload for T, or T must be blittable (see IsBlittable<T>).

EStreamMode

public: enum EStreamMode
{
    esmWrite,
    esmRead
}

An IGeoStream is open in either esmRead or esmWrite mode.

enumerators