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.

                       {
    Host host = Host::getHost();
    _hostname = host.getHostName();
    _pid = getpid();
    _localID = _localCounter++;
}

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.

                                           {
    _hostname = id.getHostName();
    _pid = id.getProcessID();
    _localID = id.getLocalID();
}

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.

                                                                      : 
    _hostname(hostname),
    _pid(pid),
    _localID(localID) 
    {}

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.

                                        {
    return _hostname;
}

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.

                                 {
    return _localID;
}

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.

                                   {
    return _pid;
}

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:

• /home/lsstsw/stack/Linux64/ctrl_events/11.0-2-g68503cd/include/lsst/ctrl/events/LocationId.h
• /home/lsstsw/stack/Linux64/ctrl_events/11.0-2-g68503cd/src/LocationId.cc