EMANE  1.2.1
Public Member Functions | Protected Attributes | List of all members
EMANE::Agents::GPSDLocation::Agent Class Reference

Agent translating location events to NMEA gpsd messages. More...

#include <agent.h>

Inheritance diagram for EMANE::Agents::GPSDLocation::Agent:
EMANE::EventAgent EMANE::Component EMANE::PlatformServiceUser EMANE::Buildable EMANE::EventServiceUser EMANE::TimerServiceUser

Public Member Functions

 Agent (NEMId nemId, PlatformServiceProvider *pPlatformService)
 
 ~Agent ()
 
void initialize (Registrar &registrar) override
 
void configure (const ConfigurationUpdate &update) override
 
void start () override
 
void stop () override
 
void destroy () override throw ()
 
void processEvent (const EventId &, const Serialization &) override
 
void processTimedEvent (TimerEventId eventId, const TimePoint &expireTime, const TimePoint &scheduleTime, const TimePoint &fireTime, const void *arg) override
 
virtual void postStart ()
 
BuildId getBuildId () const
 
void setBuildId (BuildId bid)
 

Protected Attributes

NEMId id_
 
PlatformServiceProvider * pPlatformService_
 

Detailed Description

Agent translating location events to NMEA gpsd messages.

Definition at line 54 of file agent.h.

Constructor & Destructor Documentation

◆ Agent()

EMANE::Agents::GPSDLocation::Agent::Agent ( NEMId  nemId,
PlatformServiceProvider *  pPlatformService 
)

Definition at line 50 of file agent.cc.

◆ ~Agent()

EMANE::Agents::GPSDLocation::Agent::~Agent ( )

Definition at line 65 of file agent.cc.

Member Function Documentation

◆ configure()

void EMANE::Agents::GPSDLocation::Agent::configure ( const ConfigurationUpdate &  update)
overridevirtual

Configure the component.

Parameters
updateConfiguration update values
Exceptions
ConfigureExceptionthrown when a unexpected configuration item is encountered or there is a problem with the specified item value

Implements EMANE::Component.

Definition at line 81 of file agent.cc.

◆ destroy()

void EMANE::Agents::GPSDLocation::Agent::destroy ( )
throw (
)
overridevirtual

Destroy the component.

Implements EMANE::Component.

Definition at line 164 of file agent.cc.

◆ getBuildId()

EMANE::BuildId EMANE::Buildable::getBuildId ( ) const
inlineinherited

Gets the application wide unique BuildId of this object.

Returns
the BuildId

Definition at line 34 of file buildable.inl.

◆ initialize()

void EMANE::Agents::GPSDLocation::Agent::initialize ( Registrar &  registrar)
overridevirtual

Initialize the component.

Exceptions
InitializeExceptionthrown when an error is encountered during initialization

Implements EMANE::Component.

Definition at line 67 of file agent.cc.

◆ postStart()

virtual void EMANE::Component::postStart ( )
inlinevirtualinherited

Hook to run any post start functionaililty. Called after all the components have been started.

Reimplemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Transports::Virtual::VirtualTransport, EMANE::Models::TDMA::EventScheduler, EMANE::Models::TDMA::BaseModel, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::ShimLayer, EMANE::Application::TransportAdapterImpl, EMANE::MACLayer, EMANE::PHYLayer, EMANE::TransportLayer, EMANE::Application::TransportManagerImpl, and EMANE::Models::TDMA::BasicQueueManager.

Definition at line 119 of file component.h.

◆ processEvent()

void EMANE::Agents::GPSDLocation::Agent::processEvent ( const EventId &  eventId,
const Serialization &  serialization 
)
overridevirtual

Process an event.

Parameters
eventIdevent identifier corresponding to the serialized event
serializationopaque event object data

Reimplemented from EMANE::EventServiceUser.

Definition at line 168 of file agent.cc.

◆ processTimedEvent()

void EMANE::Agents::GPSDLocation::Agent::processTimedEvent ( TimerEventId  eventId,
const TimePoint &  expireTime,
const TimePoint &  scheduleTime,
const TimePoint &  fireTime,
const void *  arg 
)
overridevirtual

Process a timed event

Parameters
eventIdIdentifier corresponding to the timer being processed
expireTimeThe time the timer was scheduled to expire
scheduleTimeThe Time the timer was scheduled
fireTimeTime time The time the timer actually fired
argOpaque timed event data
Note
All times are abosulte using CLOCK_REALTIME

Reimplemented from EMANE::TimerServiceUser.

Definition at line 209 of file agent.cc.

◆ setBuildId()

void EMANE::Buildable::setBuildId ( BuildId  bid)
inlineinherited

Sets the application wide unique BuildId of this object. Builders assign a BuildId to objects at instantiation.

Parameters
bidthe BuildId
Note
: This method is for internal framework use only.

Definition at line 40 of file buildable.inl.

◆ start()

void EMANE::Agents::GPSDLocation::Agent::start ( )
overridevirtual

Start the component.

Exceptions
StartExceptionthrown when an error is encountered during start.

Implements EMANE::Component.

Definition at line 99 of file agent.cc.

◆ stop()

void EMANE::Agents::GPSDLocation::Agent::stop ( )
overridevirtual

Stop the component.

Exceptions
StopExceptionthrown when an error is encountered during stop

Implements EMANE::Component.

Definition at line 153 of file agent.cc.

Member Data Documentation

◆ id_

NEMId EMANE::EventAgent::id_
protectedinherited

Definition at line 68 of file eventagent.h.

◆ pPlatformService_

PlatformServiceProvider* EMANE::PlatformServiceUser::pPlatformService_
protectedinherited

Definition at line 64 of file platformserviceuser.h.

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