JACOUSTICS::JDetectorMechanics Struct Reference

Auxiliary data structure for mechanical model parameters of strings in a given detector. More...

#include <JMechanics.hh>

Inheritance diagram for JACOUSTICS::JDetectorMechanics:

Public Types
enum	{ WILD_CARD = -1 }

Public Member Functions
void	load (const std::string &file_name)
	Load mechanical model parameters from file. More...
void	load (const int id)
	Load mechanical model parameters for given detector identifier. More...
const JMechanics &	operator() (const int string) const
	Get mechanical parameters for given string. More...

Static Public Member Functions
static std::string	getFilename (const int id)
	Get file name with mechanical model parameters for given detector identifier. More...

Public Attributes
JComment	comment

Friends
std::istream &	operator>> (std::istream &in, JDetectorMechanics &object)
	Read detector mechanics from input. More...
std::ostream &	operator<< (std::ostream &out, const JDetectorMechanics &object)
	Write detector mechanics to output. More...

Detailed Description

Auxiliary data structure for mechanical model parameters of strings in a given detector.

Note that the JDetectorMechanics::WILD_CARD acts as default value for the string number.

Definition at line 110 of file JMechanics.hh.

Member Enumeration Documentation

anonymous enum

Enumerator
WILD_CARD	wild card for string number.

Definition at line 113 of file JMechanics.hh.

         {
      WILD_CARD = -1   //!< wild card for string number.
    };

Member Function Documentation

static std::string JACOUSTICS::JDetectorMechanics::getFilename ( const int  id )

inlinestatic

Get file name with mechanical model parameters for given detector identifier.

Note that the environment variable LD_LIBRARY_PATH is used to obtain the path of the targeted file.

Parameters

id	detector identifier

Returns

file name

Definition at line 126 of file JMechanics.hh.

    {
      using namespace std;
      using namespace JPP;

      const string file_name = MAKE_STRING("mechanics_" << FILL(8,'0') << id << ".txt");

      return getFullFilename(LD_LIBRARY_PATH, file_name);
    }

void JACOUSTICS::JDetectorMechanics::load ( const std::string &  file_name )

inline

Load mechanical model parameters from file.

Parameters

file_name

file name

Definition at line 142 of file JMechanics.hh.

    {
      std::ifstream in(file_name.c_str());

      in >> *this;

      in.close();
    }

void JACOUSTICS::JDetectorMechanics::load ( const int  id )

inline

Load mechanical model parameters for given detector identifier.

Parameters

id	detector identifier

Definition at line 157 of file JMechanics.hh.

    {
      load(getFilename(id));
    }

const JMechanics& JACOUSTICS::JDetectorMechanics::operator() ( const int  string ) const

inline

Get mechanical parameters for given string.

Parameters

string

string number

Returns

mechanical parameters

Definition at line 169 of file JMechanics.hh.

    {
      static const JMechanics mechanics;

      const_iterator p;

      if      ((p = this->find(string))    != this->end())
        return p->second;
      else if ((p = this->find(WILD_CARD)) != this->end())
        return p->second;
      else
        return mechanics;
    }

Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  in, JDetectorMechanics &  object  )

friend

Read detector mechanics from input.

Parameters

in	input stream
object	detector mechanics

Returns

input stream

Definition at line 191 of file JMechanics.hh.

    {
      using namespace JPP;

      JStringStream is(in);

      if (getFileStatus(is.str().c_str())) {
        is.load();
      }

      object.clear();
      
      is >> object.comment;
      
      int        string;
      JMechanics mechanics;

      while (is >> string >> mechanics) {
        object[string] = mechanics;
      }

      return in;
    }

std::ostream& operator<< ( std::ostream &  out, const JDetectorMechanics &  object  )

friend

Write detector mechanics to output.

Parameters

out	output stream
object	detector mechanics

Returns

output stream

Definition at line 223 of file JMechanics.hh.

    {
      using namespace std;

      out << object.comment;
      
      for (JDetectorMechanics::const_iterator i = object.begin(); i != object.end(); ++i) {
        out << setw(4) << i->first << ' ' << i->second << endl;
      }

      return out;
    }

Member Data Documentation

JComment JACOUSTICS::JDetectorMechanics::comment

Definition at line 236 of file JMechanics.hh.

---

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

• JMechanics.hh