Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members

TSE3::Ins::InstrumentData Class Reference

Instrument data container class. More...

#include <Instrument.h>

Inheritance diagram for TSE3::Ins::InstrumentData:

Inheritance graph
[legend]
List of all members.

Public Member Functions

const std::string & title () const
const std::string & name (size_t index) const
void write (std::ostream &out) const

Protected Member Functions

 InstrumentData (std::string const &title, std::string const &insHeading, std::istream &in)
void load (const std::string &secname, std::istream &in)

Protected Attributes

const std::string insHeading
std::string _title
std::string * _names [128]

Static Protected Attributes

std::string empty

Detailed Description

Instrument data container class.

A base class for instrument data: many .ins file sections are based on simple lists of 0..127 values. This is a base class for such lists.

Author:
Pete Goodliffe
Version:
3.00


Constructor & Destructor Documentation

TSE3::Ins::InstrumentData::InstrumentData std::string const &  title,
std::string const &  insHeading,
std::istream &  in
[protected]
 

Contructor is private since this is a base class.


Member Function Documentation

const std::string& TSE3::Ins::InstrumentData::title  )  const [inline]
 

Returns the title of this data group.

Returns:
Title of the data group

const std::string& TSE3::Ins::InstrumentData::name size_t  index  )  const [inline]
 

Returns the name of the item with the given index. the index value must be between 0 and 127, or the results are undefined.

If no name has been defined for this element, returns an empty string.

Returns:
Name of the data element

void TSE3::Ins::InstrumentData::write std::ostream &  out  )  const
 

Write the .ins file subsection.

Parameters:
out ostream to write output to

void TSE3::Ins::InstrumentData::load const std::string &  secname,
std::istream &  in
[protected]
 

Loads the subsection 'secname' from the .ins section 'insHeading'. Pre: title and insHeading have been set up.


Member Data Documentation

const std::string TSE3::Ins::InstrumentData::insHeading [protected]
 

The .ins file heading for this section type. Derived classes MUST override this for load) to work.

See also:
load

std::string TSE3::Ins::InstrumentData::_title [protected]
 

std::string* TSE3::Ins::InstrumentData::_names[128] [protected]
 

std::string TSE3::Ins::InstrumentData::empty [static, protected]
 


The documentation for this class was generated from the following file:
Generated on Wed May 25 14:48:03 2005 for TSE3 by doxygen 1.3.2