OSB_LIB::RecordStreams Struct Reference

Collaboration diagram for OSB_LIB::RecordStreams:

[legend]List of all members.

---

Detailed Description

List of record streams.

Definition at line 101 of file recordstreams.h.

Public Types

• typedef std::set< RecordStreamInfo::Oid > RsIdSet

  STL container of record streams.
  

• typedef std::map< RecordStreamInfo::Oid,
  RecordStreamInfo > Cont

  STL container of record streams.
  

Public Member Functions

• bool empty () const

  List of primary record streams empty?
  

• size_t size () const

  Number of primary record streams.
  

• RecordStreamInfo * find (const RecordStreamInfo::Oid &rsId)

  Find a record stream by its id.
  

• const RecordStreamInfo * find (const RecordStreamInfo::Oid &rsId) const

  Find a record stream by its id.
  

• RsIdSet getChildren (const RecordStreamInfo::Oid &rsId) const

  Get all existing children of a record stream.
  

• void replace (const RecordStreamInfo &rs, bool isMatched)

  Replace a record stream.
  

• void clear ()

  Clear the list of record streams.
  

• long read (const OSB_DB::Session &session, const RecordStreamFilter &filter, bool readAll)

  Read the record streams.
  

• long refresh (const OSB_DB::Session &session)

  Refresh the list of record streams from the database.
  

Public Attributes

• Cont selected_

  Primary record streams.
  

• Cont others_

  Parent and childs of record streams in selected_.
  

---

Member Typedef Documentation

typedef std::map<RecordStreamInfo::Oid, RecordStreamInfo> OSB_LIB::RecordStreams::Cont

STL container of record streams.

Definition at line 106 of file recordstreams.h.

typedef std::set<RecordStreamInfo::Oid> OSB_LIB::RecordStreams::RsIdSet

STL container of record streams.

Definition at line 104 of file recordstreams.h.

---

Member Function Documentation

void OSB_LIB::RecordStreams::clear

(

)

Clear the list of record streams.

bool OSB_LIB::RecordStreams::empty

(

)

const

List of primary record streams empty?

Returns:

empty() from selected_.

const RecordStreamInfo* OSB_LIB::RecordStreams::find

(

const RecordStreamInfo::Oid &

rsId

)

const

Find a record stream by its id.

RecordStreamInfo* OSB_LIB::RecordStreams::find

(

const RecordStreamInfo::Oid &

rsId

)

Find a record stream by its id.

RsIdSet OSB_LIB::RecordStreams::getChildren

(

const RecordStreamInfo::Oid &

rsId

)

const

Get all existing children of a record stream.

long OSB_LIB::RecordStreams::read	(	const OSB_DB::Session &	session,
		const RecordStreamFilter &	filter,
		bool	readAll
	)

Read the record streams.

Parameters:

	session	Database session to use.
	filter	Record stream filter to use.
	readAll	Flag to read the parent and childs of the matched streams.

Returns:

size(), see there.

Reads the stream that are matched by filter from the database and adds them to selected_.
The parent and childs of matched streams are stored in others_.

Note:

selected_ and others_ are not cleared before reading from the database, which allows clients to combine several filter settings (i.e., a logical or operation).

long OSB_LIB::RecordStreams::refresh

(

const OSB_DB::Session &

session

)

Refresh the list of record streams from the database.

Parameters:

session

Database session to use.

Returns:

size(), see there.

void OSB_LIB::RecordStreams::replace	(	const RecordStreamInfo &	rs,
		bool	isMatched
	)

Replace a record stream.

Parameters:

	rs	Record stream to add or replace.
	isMatched	Flag if the stream of matched by the filter (true) or is a secondary stream (false).

size_t OSB_LIB::RecordStreams::size

(

)

const

Number of primary record streams.

Returns:

size() from selected_.

---

Member Data Documentation

Cont OSB_LIB::RecordStreams::others_

Parent and childs of record streams in selected_.

Definition at line 185 of file recordstreams.h.

Cont OSB_LIB::RecordStreams::selected_

Primary record streams.

These are the ones matched by the filter used to call read() one or several times.

Definition at line 183 of file recordstreams.h.

---

The documentation for this struct was generated from the following file:

• recordstreams.h

---