LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
Public Types | Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
lsst::ctrl::events::LocationId Class Reference

Represent process that created an event. More...

#include <LocationId.h>

Public Types

typedef boost::shared_ptr
< LocationId
Ptr
 
typedef boost::shared_ptr
< LocationId const > 
ConstPtr
 

Public Member Functions

 LocationId ()
 LocationId object. This object represents the originating process process of an event. This consists of the host name, the process id of the process that created this LocationId and a local id which is unique for this process. When created, this represents a unique location ID. More...
 
 LocationId (LocationId const &id)
 LocationId object. This object represents the originating process of an event. When created, this represents a duplicated ID. More...
 
 LocationId (std::string const &hostname, int pid, int localID)
 LocationId object. This object represents the originating process of an event. When created, this represents a reconstituted ID. More...
 
std::string getHostName () const
 Retrieve the host name. More...
 
int getProcessID () const
 Retrieve the process id. More...
 
int getLocalID () const
 Retrieve the local id. More...
 

Protected Attributes

std::string _hostname
 used for localID & is unique for instances of LocationId in a process More...
 
int _pid
 host name More...
 
int _localID
 process id More...
 

Static Protected Attributes

static int _localCounter = 0
 

Detailed Description

Represent process that created an event.

Definition at line 49 of file LocationId.h.

Member Typedef Documentation

typedef boost::shared_ptr<LocationId const> lsst::ctrl::events::LocationId::ConstPtr

Definition at line 53 of file LocationId.h.

typedef boost::shared_ptr<LocationId> lsst::ctrl::events::LocationId::Ptr

Definition at line 52 of file LocationId.h.

Constructor & Destructor Documentation

lsst::ctrl::events::LocationId::LocationId ( )

LocationId object. This object represents the originating process process of an event. This consists of the host name, the process id of the process that created this LocationId and a local id which is unique for this process. When created, this represents a unique location ID.

Definition at line 43 of file LocationId.cc.

43  {
44  Host host = Host::getHost();
45  _hostname = host.getHostName();
46  _pid = getpid();
48 }
static Host const & getHost()
get the Host object, which can access the host and ip address.
Definition: Host.cc:49
std::string _hostname
used for localID &amp; is unique for instances of LocationId in a process
Definition: LocationId.h:97
lsst::ctrl::events::LocationId::LocationId ( LocationId const &  id)

LocationId object. This object represents the originating process of an event. When created, this represents a duplicated ID.

Definition at line 56 of file LocationId.cc.

56  {
57  _hostname = id.getHostName();
58  _pid = id.getProcessID();
59  _localID = id.getLocalID();
60 }
std::string _hostname
used for localID &amp; is unique for instances of LocationId in a process
Definition: LocationId.h:97
lsst::ctrl::events::LocationId::LocationId ( std::string const &  hostname,
int  pid,
int  localID 
)

LocationId object. This object represents the originating process of an event. When created, this represents a reconstituted ID.

Definition at line 50 of file LocationId.cc.

50  :
51  _hostname(hostname),
52  _pid(pid),
53  _localID(localID)
54  {}
std::string _hostname
used for localID &amp; is unique for instances of LocationId in a process
Definition: LocationId.h:97

Member Function Documentation

std::string lsst::ctrl::events::LocationId::getHostName ( ) const

Retrieve the host name.

Returns
a string containing the name of a host

Definition at line 64 of file LocationId.cc.

64  {
65  return _hostname;
66 }
std::string _hostname
used for localID &amp; is unique for instances of LocationId in a process
Definition: LocationId.h:97
int lsst::ctrl::events::LocationId::getLocalID ( ) const

Retrieve the local id.

Returns
an int of local id

Definition at line 72 of file LocationId.cc.

72  {
73  return _localID;
74 }
int lsst::ctrl::events::LocationId::getProcessID ( ) const

Retrieve the process id.

Returns
an int of the process id

Definition at line 68 of file LocationId.cc.

68  {
69  return _pid;
70 }

Member Data Documentation

std::string lsst::ctrl::events::LocationId::_hostname
protected

used for localID & is unique for instances of LocationId in a process

Definition at line 97 of file LocationId.h.

int lsst::ctrl::events::LocationId::_localCounter = 0
staticprotected

Definition at line 96 of file LocationId.h.

int lsst::ctrl::events::LocationId::_localID
protected

process id

Definition at line 99 of file LocationId.h.

int lsst::ctrl::events::LocationId::_pid
protected

host name

Definition at line 98 of file LocationId.h.


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