SH::MetaNames Struct Reference

the names of common meta-data More...

#include <MetaNames.h>

Collaboration diagram for SH::MetaNames:

Static Public Member Functions
static const std::string &	openRetries ()
	the number of retries for opening a file More...
static unsigned	openRetries_default ()
	the default value of openRetries More...
static const std::string &	openRetriesWait ()
	the amount of time (in seconds) to wait when doing retries More...
static double	openRetriesWait_default ()
	the default value of openRetriesWait More...
static const std::string &	sampleName ()
	the name of the sample being processed More...

Detailed Description

the names of common meta-data

This is supposed to feed into the names in SH::MetaFields and EL::Job as this uses static functions which have no load order dependencies. Over time it may also replace them.

Definition at line 23 of file MetaNames.h.

Member Function Documentation

openRetries()

const std::string & SH::MetaNames::openRetries ( )

static

the number of retries for opening a file

Definition at line 22 of file MetaNames.cxx.

  {
    static const std::string result ("nc_open_retries");
    return result;
  }

openRetries_default()

unsigned SH::MetaNames::openRetries_default ( )

static

the default value of openRetries

Definition at line 31 of file MetaNames.cxx.

  {
    return 0;
  }

openRetriesWait()

const std::string & SH::MetaNames::openRetriesWait ( )

static

the amount of time (in seconds) to wait when doing retries

when an open fails this is the maximum number of seconds to wait, the actual time will be randomized. the rationale is that if the open failed because a hundred batch jobs try to open a file at the same time, then it is not very helpful if those hundred batch jobs retry all at the same time.

Definition at line 39 of file MetaNames.cxx.

  {
    static const std::string result ("nc_open_retries_wait");
    return result;
  }

openRetriesWait_default()

double SH::MetaNames::openRetriesWait_default ( )

static

the default value of openRetriesWait

Definition at line 48 of file MetaNames.cxx.

  {
    return 300;
  }

sampleName()

const std::string & SH::MetaNames::sampleName ( )

static

the name of the sample being processed

this gets set inside the Sample accessor methods for the name. the point here is that normally you would access the sample name via the accessors, but if all you have is the sample meta-data you can use that to extract the name

Definition at line 56 of file MetaNames.cxx.

  {
    static const std::string result ("sample_name");
    return result;
  }

---

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

• MetaNames.h
• MetaNames.cxx