My Project
 All Classes Files Functions Variables Enumerations Enumerator Friends Macros Pages
gcp::util::HorizonsCommunicator Class Reference
Inheritance diagram for gcp::util::HorizonsCommunicator:
gcp::util::Communicator gcp::util::SpawnableTask< HorizonsCommunicatorMsg > gcp::util::GenericTask< HorizonsCommunicatorMsg > gcp::util::RunnableTask gcp::util::Runnable

Public Types

enum  CommState { STATE_INIT, STATE_WAIT, STATE_COMM, STATE_CHECK }
 

Public Member Functions

 HorizonsCommunicator (unsigned intervalInSeconds=300, bool useSshTunnel=false, std::string gateway="")
 
 HorizonsCommunicator (FdSet *fdSetPtr, unsigned intervalInSeconds=300, bool useSshTunnel=false, std::string getway="")
 
virtual ~HorizonsCommunicator ()
 
void getEphem (std::string source, std::string fileName, Date start, Date stop)
 
void addHandler (HORIZONS_HANDLER(*handler), void *args=0)
 
void removeHandler (HORIZONS_HANDLER(*handler))
 
void registerEphemeris (std::string sourceName, std::string fileName)
 
void deregisterEphemeris (std::string sourceName)
 
void clearEphemeris ()
 
void loadFile (std::string name)
 
void setFilename (std::string fileName)
 
void testFn ()
 
- Public Member Functions inherited from gcp::util::Communicator
 Communicator ()
 
virtual ~Communicator ()
 
bool timedOut ()
 
virtual int getFd ()
 
void run ()
 
virtual void processClientMessage ()
 
void registerTimeOut ()
 
- Public Member Functions inherited from gcp::util::SpawnableTask< HorizonsCommunicatorMsg >
 SpawnableTask (bool spawn)
 
virtual ~SpawnableTask ()
 
- Public Member Functions inherited from gcp::util::GenericTask< HorizonsCommunicatorMsg >
void sendRestartMsg ()
 
void sendStopMsg ()
 
void sendHeartBeatMsg ()
 
virtual void fwdTaskMsg (HorizonsCommunicatorMsg *msg)
 
- Public Member Functions inherited from gcp::util::RunnableTask
 RunnableTask (bool spawnThread)
 
virtual ~RunnableTask ()
 
- Public Member Functions inherited from gcp::util::Runnable
 Runnable (bool spawnThread, RUN_FN(*runFn))
 
 Runnable (bool spawnThread, RUN_FN(*runFn), int priority)
 
virtual ~Runnable ()
 
void blockForever ()
 
void spawn ()
 

Additional Inherited Members

- Static Public Member Functions inherited from gcp::util::RunnableTask
static RUN_FN (runFn)
 
- Static Public Member Functions inherited from gcp::util::Runnable
static THREAD_START (startUp)
 
- Static Public Attributes inherited from gcp::util::Communicator
static const unsigned COMMAND_TIMEOUT_SEC = 10
 
- Protected Member Functions inherited from gcp::util::Communicator
void enableTimeOut (bool enable)
 
void checkLine ()
 
virtual void sendNextString (void)
 
void advanceIterator (bool bufferReset)
 
void checkIterators ()
 
- Protected Member Functions inherited from gcp::util::SpawnableTask< HorizonsCommunicatorMsg >
void run ()
 
- Protected Member Functions inherited from gcp::util::GenericTask< HorizonsCommunicatorMsg >
 GenericTask ()
 
 GenericTask (Thread *thread)
 
virtual ~GenericTask ()
 
void sendTaskMsg (HorizonsCommunicatorMsg *msg)
 
void startThreads (void *arg)
 
void startThread (void *arg, unsigned order)
 
unsigned getMinStartOrder ()
 
bool threadsNeedStarting ()
 
void cancelThreads ()
 
void cancelThread (unsigned order)
 
unsigned getMinCancelOrder ()
 
bool threadsNeedCancelling ()
 
void pingThreads (void *arg)
 
void raise (std::string name, int sigNo)
 
ThreadgetThread (std::string name)
 
bool threadsAreRunning ()
 
void shutdownConnection (int fd)
 
virtual void restart (void)
 
virtual void processTaskMsg (bool *stop)
 
virtual void respondToHeartBeat ()
 
virtual void installTimer (HorizonsCommunicatorMsg *msg)
 
virtual void installSignal (HorizonsCommunicatorMsg *msg)
 
virtual void enableTimer (HorizonsCommunicatorMsg *msg)
 
virtual void addHandler (HorizonsCommunicatorMsg *msg)
 
void stepCommands ()
 
- Protected Member Functions inherited from gcp::util::Runnable
virtual void broadcastReady ()
 
void spawn (void *arg)
 
- Static Protected Member Functions inherited from gcp::util::Communicator
static COMM_PARSER_FN (sendNextString)
 
- Protected Attributes inherited from gcp::util::Communicator
gcp::util::TcpClientclient_
 
gcp::util::TimeVal timer_
 
std::list< std::string > sentStrings_
 
std::list< RcvdStrrcvdStrings_
 
std::list< std::string >::iterator sentStringIter_
 
std::list< RcvdStr >::iterator rcvdStringIter_
 
std::ostringstream os_
 
- Protected Attributes inherited from gcp::util::GenericTask< HorizonsCommunicatorMsg >
Threadthread_
 
std::vector< Thread * > threads_
 
PipeQ< HorizonsCommunicatorMsgmsgq_
 
gcp::util::FdSet fdSet_
 
std::vector< Command * > commands_
 
struct timeval * timeOut_
 
TimeVal commandTimeOut_
 
- Protected Attributes inherited from gcp::util::Runnable
ThreadspawnedThread_
 
bool spawned_
 
RUN_FN * runFn_
 

Constructor & Destructor Documentation

HorizonsCommunicator::HorizonsCommunicator ( unsigned  intervalInSeconds = 300,
bool  useSshTunnel = false,
std::string  gateway = "" 
)

....................................................................... Constructor.

HorizonsCommunicator::HorizonsCommunicator ( FdSet fdSetPtr,
unsigned  intervalInSeconds = 300,
bool  useSshTunnel = false,
std::string  gateway = "" 
)

....................................................................... Constructor.

HorizonsCommunicator::~HorizonsCommunicator ( )
virtual

....................................................................... Destructor.

Member Function Documentation

void HorizonsCommunicator::addHandler ( HORIZONS_HANDLER *  fn,
void *  args = 0 
)

....................................................................... Public method to add a handler to be called when the ephemeris file is updated

void HorizonsCommunicator::clearEphemeris ( )

....................................................................... Clear all ephemerides to be watched

void HorizonsCommunicator::deregisterEphemeris ( std::string  sourceName)

....................................................................... Deregister a source to be watched for ephemeris updates

void HorizonsCommunicator::getEphem ( std::string  source,
std::string  fileName,
Date  start,
Date  stop 
)

....................................................................... Send a message to this object to fetch an ephemeris

void HorizonsCommunicator::loadFile ( std::string  name)

....................................................................... Test method to read a Horizons format file

void HorizonsCommunicator::registerEphemeris ( std::string  sourceName,
std::string  fileName 
)

....................................................................... Register a source to be watched for ephemeris updates

void HorizonsCommunicator::setFilename ( std::string  fileName)

....................................................................... Set the output filename for the current ephemeris


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