/search.css" rel="stylesheet" type="text/css"/> /search.js">
| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

In This Package:

Public Types | Public Member Functions | Static Public Member Functions | Private Attributes
DayaBay::JobInfo Class Reference

Basic information about the job. More...

#include <JobInfo.h>

Collaboration diagram for DayaBay::JobInfo:
Collaboration graph
[legend]

List of all members.

Public Types

typedef std::map< std::string,
std::string > 
JobParameters
 Container for job key,value pairs.

Public Member Functions

 JobInfo ()
 Default Constructor.
 JobInfo (const JobInfo &rh)
 Copy Constructor.
JobInfooperator= (const JobInfo &rh)
 Assignment operator.
virtual ~JobInfo ()
 Default Destructor.
bool exists (const std::string &name) const
 Return true if the parameter has a value.
std::string get (const std::string &name) const
 Return the parameter value.
void set (const std::string &name, const std::string &value)
 Set the parameter name/value.
std::ostream & fillStream (std::ostream &s) const
 Print the job information.
const DayaBay::JobIdjobId () const
 Retrieve const The unique ID number for this job.
void setJobId (const DayaBay::JobId &value)
 Update The unique ID number for this job.
const JobParametersparameters () const
 Retrieve const List of key,value job parameters.
void setParameters (const JobParameters &value)
 Update List of key,value job parameters.

Static Public Member Functions

static void * operator new (size_t size)
 operator new
static void * operator new (size_t size, void *pObj)
 placement operator new it is needed by libstdc++ 3.2.3 (e.g.
static void operator delete (void *p)
 operator delete
static void operator delete (void *p, void *pObj)
 placement operator delete not sure if really needed, but it does not harm

Private Attributes

DayaBay::JobId m_jobId
 The unique ID number for this job.
JobParameters m_parameters
 List of key,value job parameters.

Detailed Description

Basic information about the job.

Author:
dandwyer@caltech.edu created Thu Dec 5 17:43:07 2013

Definition at line 41 of file JobInfo.h.


Member Typedef Documentation

typedef std::map<std::string,std::string> DayaBay::JobInfo::JobParameters

Container for job key,value pairs.

Definition at line 46 of file JobInfo.h.


Constructor & Destructor Documentation

DayaBay::JobInfo::JobInfo ( ) [inline]

Default Constructor.

Definition at line 49 of file JobInfo.h.

              : m_jobId(),
                m_parameters() {}
DayaBay::JobInfo::JobInfo ( const JobInfo rh) [inline]

Copy Constructor.

Definition at line 145 of file JobInfo.h.

                                                        : 
   m_jobId( rh.m_jobId ),
   m_parameters( rh.m_parameters )
   {}
virtual DayaBay::JobInfo::~JobInfo ( ) [inline, virtual]

Default Destructor.

Definition at line 59 of file JobInfo.h.

{}

Member Function Documentation

DayaBay::JobInfo & DayaBay::JobInfo::operator= ( const JobInfo rh) [inline]

Assignment operator.

Definition at line 150 of file JobInfo.h.

                                                                           {
  if ( this != &rh ) {
    m_jobId      = rh.m_jobId;
    m_parameters = rh.m_parameters;
  }
  return *this;
}
bool DayaBay::JobInfo::exists ( const std::string &  name) const [inline]

Return true if the parameter has a value.

Definition at line 178 of file JobInfo.h.

{

          DayaBay::JobInfo::JobParameters::const_iterator pIter = m_parameters.find(name);
          if(pIter != m_parameters.end()){ 
            return true;
          }
          return false;
        
}
std::string DayaBay::JobInfo::get ( const std::string &  name) const [inline]

Return the parameter value.

Definition at line 189 of file JobInfo.h.

{

          DayaBay::JobInfo::JobParameters::const_iterator pIter = m_parameters.find(name);
          if(pIter != m_parameters.end()){ 
            return pIter->second;
          }
          return std::string();
        
}
void DayaBay::JobInfo::set ( const std::string &  name,
const std::string &  value 
) [inline]

Set the parameter name/value.

Definition at line 200 of file JobInfo.h.

{

          m_parameters[name]=value;
        
}
std::ostream & DayaBay::JobInfo::fillStream ( std::ostream &  s) const

Print the job information.

Definition at line 3 of file JobInfo.cc.

{
  s << "{ " 
    << " jobId : " << m_jobId.uuid() << std::endl;
  
  DayaBay::JobInfo::JobParameters::const_iterator it, done 
    = m_parameters.end();
  for (it=m_parameters.begin(); it != done; ++it) {
    s << " " << it->first << " : " << it->second << std::endl;
  }
  s << "}";
  return s;
}
const DayaBay::JobId & DayaBay::JobInfo::jobId ( ) const [inline]

Retrieve const The unique ID number for this job.

Definition at line 158 of file JobInfo.h.

{
  return m_jobId;
}
void DayaBay::JobInfo::setJobId ( const DayaBay::JobId value) [inline]

Update The unique ID number for this job.

Definition at line 163 of file JobInfo.h.

{
  m_jobId = value;
}
const DayaBay::JobInfo::JobParameters & DayaBay::JobInfo::parameters ( ) const [inline]

Retrieve const List of key,value job parameters.

Definition at line 168 of file JobInfo.h.

{
  return m_parameters;
}
void DayaBay::JobInfo::setParameters ( const JobParameters value) [inline]

Update List of key,value job parameters.

Definition at line 173 of file JobInfo.h.

{
  m_parameters = value;
}
static void* DayaBay::JobInfo::operator new ( size_t  size) [inline, static]

operator new

Definition at line 93 of file JobInfo.h.

    {
      return ( sizeof(JobInfo) == size ? 
               boost::singleton_pool<JobInfo, sizeof(JobInfo)>::malloc() :
               ::operator new(size) );
    }
static void* DayaBay::JobInfo::operator new ( size_t  size,
void *  pObj 
) [inline, static]

placement operator new it is needed by libstdc++ 3.2.3 (e.g.

in std::vector) it is not needed in libstdc++ >= 3.4

Definition at line 103 of file JobInfo.h.

    {
      return ::operator new (size,pObj);
    }
static void DayaBay::JobInfo::operator delete ( void *  p) [inline, static]

operator delete

Definition at line 109 of file JobInfo.h.

    {
      boost::singleton_pool<JobInfo, sizeof(JobInfo)>::is_from(p) ?
      boost::singleton_pool<JobInfo, sizeof(JobInfo)>::free(p) :
      ::operator delete(p);
    }
static void DayaBay::JobInfo::operator delete ( void *  p,
void *  pObj 
) [inline, static]

placement operator delete not sure if really needed, but it does not harm

Definition at line 118 of file JobInfo.h.

    {
      ::operator delete (p, pObj);
    }

Member Data Documentation

The unique ID number for this job.

Definition at line 127 of file JobInfo.h.

List of key,value job parameters.

Definition at line 128 of file JobInfo.h.


The documentation for this class was generated from the following files:
| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

Generated on Fri May 16 2014 09:59:11 for JobInfo by doxygen 1.7.4