space_protocols_slurp Class Reference

#include <slurp.h>

Inheritance diagram for space_protocols_slurp:

Public Types
typedef boost::shared_ptr < space_protocols_slurp >	pointer
Public Member Functions
virtual	~space_protocols_slurp ()
void	read_and_process (void)
record::pointer	query_by_name (const rcstring &name_or_alias) const
record::pointer	query_by_number (int number) const
record::pointer	query_by_number (const rcstring &number) const
Static Public Member Functions
static pointer	create (const rcstring &filename)
Private Types
typedef std::map< rcstring, record::pointer >	by_name_t
typedef std::map< int, record::pointer >	by_number_t
Private Member Functions
	space_protocols_slurp (const rcstring &filename)
void	process (const record::pointer &rp)
	space_protocols_slurp ()
	space_protocols_slurp (const space_protocols_slurp &)
space_protocols_slurp &	operator= (const space_protocols_slurp &)
Private Attributes
by_name_t	by_name
by_number_t	by_number

---

Detailed Description

The space_protocols_slurp class is used to process the protocols file records, filing each away for later checks. This checks the file for inter-row validity.

Definition at line 30 of file slurp.h.

---

Member Typedef Documentation

typedef std::map<rcstring, record::pointer> space_protocols_slurp::by_name_t [private]

Definition at line 94 of file slurp.h.

typedef std::map<int, record::pointer> space_protocols_slurp::by_number_t [private]

Definition at line 102 of file slurp.h.

typedef boost::shared_ptr<space_protocols_slurp> space_protocols_slurp::pointer

Reimplemented from space_protocols.

Definition at line 34 of file slurp.h.

---

Constructor & Destructor Documentation

space_protocols_slurp::~space_protocols_slurp

(

)

[virtual]

The destructor.

Definition at line 25 of file slurp.cc.

space_protocols_slurp::space_protocols_slurp

(

const rcstring &

filename

)

[private]

The constructor. It is private on purpose, use the create class method instead.

Parameters:

filename

The name of the file to be read.

Definition at line 30 of file slurp.cc.

space_protocols_slurp::space_protocols_slurp

(

)

[private]

The default constructor. Do not use.

space_protocols_slurp::space_protocols_slurp

(

const space_protocols_slurp &

)

[private]

The copy constructor. Do not use.

---

Member Function Documentation

space_protocols_slurp::pointer space_protocols_slurp::create

(

const rcstring &

filename

)

[static]

The create class method is used to create new dynamically allocated instances of this class.

Parameters:

filename

The name of the file to be read.

Reimplemented from space_protocols.

Definition at line 37 of file slurp.cc.

space_protocols_slurp& space_protocols_slurp::operator=

(

const space_protocols_slurp &

)

[private]

The assignment operator. Do not use.

void space_protocols_slurp::process

(

const record::pointer &

rp

)

[private]

The process method use used to process each record.

Definition at line 44 of file slurp.cc.

space_protocols::record::pointer space_protocols_slurp::query_by_name

(

const rcstring &

name_or_alias

)

const

The query_by_name method is used to retrieve a protocols record by protocol name. Returns NULL if no such record.

Definition at line 145 of file slurp.cc.

space_protocols::record::pointer space_protocols_slurp::query_by_number

(

int

number

)

const

The query_by_number method is used to retrieve a protocols record by protocol number. Returns NULL if no such record.

Definition at line 169 of file slurp.cc.

space_protocols::record::pointer space_protocols_slurp::query_by_number

(

const rcstring &

number

)

const

The query_by_number method is used to retrieve a protocols record by protocol number. Returns NULL if no such record.

Definition at line 156 of file slurp.cc.

void space_protocols_slurp::read_and_process

(

void

)

The read_and_process method is used to read the file and process all of the records.

Definition at line 131 of file slurp.cc.

---

Field Documentation

by_name_t space_protocols_slurp::by_name [private]

The by_name instance variable is used to index protocols records by name.

Definition at line 100 of file slurp.h.

by_number_t space_protocols_slurp::by_number [private]

The by_number instance variable is used to index protocols records by number.

Definition at line 108 of file slurp.h.

---

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

• lib/space/protocols/slurp.h
• lib/space/protocols/slurp.cc