Aria  2.7.5.2
ArLogFileConnection Class Reference

For connecting through a log file. More...

#include <ArLogFileConnection.h>

Inherits ArDeviceConnection.

Public Types

enum  Open { OPEN_FILE_NOT_FOUND = 1, OPEN_NOT_A_LOG_FILE }
 
- Public Types inherited from ArDeviceConnection
enum  Status {
  STATUS_NEVER_OPENED = 1, STATUS_OPEN, STATUS_OPEN_FAILED, STATUS_CLOSED_NORMALLY,
  STATUS_CLOSED_ERROR
}
 

Public Member Functions

 ArLogFileConnection ()
 Constructor.
 
virtual bool close (void)
 
const char * getLogFile (void)
 Gets the name of the host connected to. More...
 
virtual const char * getOpenMessage (int messageNumber)
 
virtual int getStatus (void)
 
virtual ArTime getTimeRead (int index)
 
int internalOpen (void)
 Internal function used by open and openSimple.
 
virtual bool isTimeStamping (void)
 
int open (const char *fname=NULL)
 Opens a connection to the given host and port. More...
 
virtual bool openSimple (void)
 
virtual int read (const char *data, unsigned int size, unsigned int msWait=0)
 
void setLogFile (const char *fname=NULL)
 
virtual int write (const char *data, unsigned int size)
 
virtual ~ArLogFileConnection ()
 Destructor also closes connection.
 
- Public Member Functions inherited from ArDeviceConnection
 ArDeviceConnection ()
 constructor
 
const char * getStatusMessage (int messageNumber) const
 Gets the description string associated with the status. More...
 
virtual int writePacket (ArBasePacket *packet)
 Writes data to connection. More...
 
virtual ~ArDeviceConnection ()
 destructor also forces a close on the connection
 

Public Attributes

bool havePose
 
char myName [100]
 
ArPose myPose
 
char mySubtype [20]
 
char myType [20]
 

Protected Member Functions

void buildStrMap (void)
 
- Protected Member Functions inherited from ArDeviceConnection
void buildStrMap (void)
 

Protected Attributes

FILE * myFD
 
const char * myLogFile
 
int myStatus
 
ArStrMap myStrMap
 
int stopAfter
 

Additional Inherited Members

- Static Protected Attributes inherited from ArDeviceConnection
static ArStrMap ourStrMap
 
static bool ourStrMapInited = false
 

Detailed Description

For connecting through a log file.

Member Enumeration Documentation

Enumerator
OPEN_FILE_NOT_FOUND 

Can't find the file.

OPEN_NOT_A_LOG_FILE 

Doesn't look like a log file.

Member Function Documentation

const char * ArLogFileConnection::getLogFile ( void  )

Gets the name of the host connected to.

Returns
the name of the log file
int ArLogFileConnection::open ( const char *  fname = NULL)

Opens a connection to the given host and port.

Parameters
fnamethe file to connect to, if NULL (default) then robot.log
Returns
0 for success, otherwise one of the open enums
See Also
getOpenMessage

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