OSB_LIB::RecordSource Class Reference

Collaboration diagram for OSB_LIB::RecordSource:

[legend]List of all members.

---

Detailed Description

It contains the record source informations.

Definition at line 84 of file recordstream.h.

Public Types

• typedef Id< RecordSource > Oid

  Unique identifier for the record source.
  

Public Member Functions

• RecordSource (const Oid &oid=Oid())

  Default constructor with optional object id.
  

• RecordSource (const std::string &format, ModuleId generator)

  Constructor with generator and format.
  

• std::string filename (long seqNo) const

  Create the filename for a sequence number.
  

• bool read (const OSB_DB::Session &session)

  Read the record source from the database.
  

Read access to the members.

• const Oid & oid () const

  Returns the unique object identifier.
  

• const std::string & name () const

  Returns the name of the RecordSource.
  

• const std::string & format () const

  Returns the format of the RecordSource.
  

• ModuleId processor () const

  Returns the processor of this RecordSource.
  

• ModuleId generator () const

  Returns the generator of this RecordSource.
  

• const Id< Network > networkId () const

  Returns the network id of the RecordSource.
  

• const Id2< NetworkElement > & neId () const

  Returns the network element id of the RecordSource.
  

• const std::string & directory () const

  Returns the name of the directory where the record streams are stored for this record source.
  

• const std::string & basename () const

  Returns the basename of the file for this record source.
  

Private Attributes

• Oid oid_

  Unique object identifier for the record source.
  

• std::string name_

  Name of the record source.
  

• std::string format_

  Format of the record source.
  

• ModuleId processor_

  Processor for this record source.
  

• ModuleId generator_

  Generator for this record source.
  

• Id2< NetworkElement > neId_

  Unique identifier of the network element.
  

• std::string directory_

  Directory where the record streams are stored.
  

• std::string basename_

  Basename for the record stream file.
  

Friends

• struct OSB_DB::RecordSourceGw

  This is to access all the private attributes.
  

• struct OSB_DB::RecordStreamGw

---

Member Typedef Documentation

typedef Id<RecordSource> OSB_LIB::RecordSource::Oid

Unique identifier for the record source.

Definition at line 94 of file recordstream.h.

---

Constructor & Destructor Documentation

OSB_LIB::RecordSource::RecordSource

(

const Oid &

oid = Oid()

)

[inline, explicit]

Default constructor with optional object id.

If oid is set call read() after construction to populate all data members.

Definition at line 103 of file recordstream.h.

OSB_LIB::RecordSource::RecordSource	(	const std::string &	format,
		ModuleId	generator
	)

Constructor with generator and format.

Call read() after construction to populate all data members, including record source id.

Parameters:

	format	Format of the output generated.
	generator	Generator of record streams of this source.

---

Member Function Documentation

const std::string& OSB_LIB::RecordSource::basename

(

)

const [inline]

Returns the basename of the file for this record source.

Definition at line 146 of file recordstream.h.

References basename_.

const std::string& OSB_LIB::RecordSource::directory

(

)

const [inline]

Returns the name of the directory where the record streams are stored for this record source.

Definition at line 144 of file recordstream.h.

References directory_.

std::string OSB_LIB::RecordSource::filename

(

long

seqNo

)

const

Create the filename for a sequence number.

Parameters:

seqNo

Sequence number to use.

Returns:

The filename for seqNo, without directory. It is empty if the object id is not set.

const std::string& OSB_LIB::RecordSource::format

(

)

const [inline]

Returns the format of the RecordSource.

Definition at line 128 of file recordstream.h.

References format_.

ModuleId OSB_LIB::RecordSource::generator

(

)

const [inline]

Returns the generator of this RecordSource.

Definition at line 132 of file recordstream.h.

References generator_.

const std::string& OSB_LIB::RecordSource::name

(

)

const [inline]

Returns the name of the RecordSource.

Definition at line 126 of file recordstream.h.

References name_.

const Id2<NetworkElement>& OSB_LIB::RecordSource::neId

(

)

const [inline]

Returns the network element id of the RecordSource.

Definition at line 139 of file recordstream.h.

References neId_.

const Id<Network> OSB_LIB::RecordSource::networkId

(

)

const [inline]

Returns the network id of the RecordSource.

Definition at line 134 of file recordstream.h.

References neId_.

const Oid& OSB_LIB::RecordSource::oid

(

)

const [inline]

Returns the unique object identifier.

Definition at line 124 of file recordstream.h.

References oid_.

ModuleId OSB_LIB::RecordSource::processor

(

)

const [inline]

Returns the processor of this RecordSource.

Definition at line 130 of file recordstream.h.

References processor_.

bool OSB_LIB::RecordSource::read

(

const OSB_DB::Session &

session

)

Read the record source from the database.

Parameters:

session

Database session to use.

Exceptions:

OsbException

in case of a database error.

Returns:

True if object read successfully else false.

Reads the record source from the database using either the object id (if set) or format_ and generator_ as selection criteria.

---

Friends And Related Function Documentation

friend struct OSB_DB::RecordSourceGw [friend]

This is to access all the private attributes.

Definition at line 86 of file recordstream.h.

friend struct OSB_DB::RecordStreamGw [friend]

This is to access all the private attributes while filling the record stream info.

Definition at line 91 of file recordstream.h.

---

Member Data Documentation

std::string OSB_LIB::RecordSource::basename_ [private]

Basename for the record stream file.

Definition at line 187 of file recordstream.h.

Referenced by basename().

std::string OSB_LIB::RecordSource::directory_ [private]

Directory where the record streams are stored.

Definition at line 185 of file recordstream.h.

Referenced by directory().

std::string OSB_LIB::RecordSource::format_ [private]

Format of the record source.

Definition at line 177 of file recordstream.h.

Referenced by format().

ModuleId OSB_LIB::RecordSource::generator_ [private]

Generator for this record source.

Definition at line 181 of file recordstream.h.

Referenced by generator().

std::string OSB_LIB::RecordSource::name_ [private]

Name of the record source.

Definition at line 175 of file recordstream.h.

Referenced by name().

Id2<NetworkElement> OSB_LIB::RecordSource::neId_ [private]

Unique identifier of the network element.

Definition at line 183 of file recordstream.h.

Referenced by neId(), and networkId().

Oid OSB_LIB::RecordSource::oid_ [private]

Unique object identifier for the record source.

Definition at line 173 of file recordstream.h.

Referenced by oid().

ModuleId OSB_LIB::RecordSource::processor_ [private]

Processor for this record source.

Definition at line 179 of file recordstream.h.

Referenced by processor().

---

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

• recordstream.h

---