Main Page   Class Hierarchy   Compound List   Compound Members  

ArLogFileConnection Class Reference

For connecting through a log file. More...

#include <ArLogFileConnection.h>

Inheritance diagram for ArLogFileConnection::

ArDeviceConnection List of all members.

Public Types

enum  Open { OPEN_FILE_NOT_FOUND = 1, OPEN_NOT_A_LOG_FILE }

Public Methods

 ArLogFileConnection (void)
 Constructor.

virtual ~ArLogFileConnection (void)
 Destructor also closes connection.

int open (const char *fname=NULL)
 Opens a connection to the given host and port. More...

virtual bool openSimple (void)
 Opens the connection again, using the values from setLocation or.

virtual int getStatus (void)
 Gets the status of the connection, which is one of the enum status. More...

virtual bool close (void)
 Closes the connection. More...

virtual int read (const char *data, unsigned int size, unsigned int msWait=0)
 Reads data from connection. More...

virtual int write (const char *data, unsigned int size)
 Writes data to connection. More...

virtual std::string getOpenMessage (int messageNumber)
 Gets the string of the message associated with opening the device. More...

virtual ArTime getTimeRead (int index)
 Gets the time data was read in. More...

virtual bool isTimeStamping (void)
 sees if timestamping is really going on or not. More...

const char * getLogFile (void)
 Gets the name of the host connected to. More...

ArPose getLogPose (void)
 Gets the initial pose of the robot.

int internalOpen (void)
 Internal function used by open and openSimple.


Detailed Description

For connecting through a log file.


Member Enumeration Documentation

enum ArLogFileConnection::Open
 

Enumeration values:
OPEN_FILE_NOT_FOUND  Can't find the file.
OPEN_NOT_A_LOG_FILE  Doesn't look like a log file.


Member Function Documentation

bool ArLogFileConnection::close void    [virtual]
 

Closes the connection.

Returns:
whether the close succeeded or not

Reimplemented from ArDeviceConnection.

const char * ArLogFileConnection::getLogFile void   
 

Gets the name of the host connected to.

Returns:
the name of the log file

std::string ArLogFileConnection::getOpenMessage int    messageNumber [virtual]
 

Gets the string of the message associated with opening the device.

Each class inherited from this one has an open method which returns 0 for success or an integer which can be passed into this function to obtain a string describing the reason for failure

Parameters:
messageNumber  the number returned from the open
Returns:
the error description associated with the messageNumber

Reimplemented from ArDeviceConnection.

int ArLogFileConnection::getStatus void    [virtual]
 

Gets the status of the connection, which is one of the enum status.

Gets the status of the connection, which is one of the enum status. If you want to get a string to go along with the number, use getStatusMessage

Returns:
the status of the connection
See also:
getStatusMessage

Reimplemented from ArDeviceConnection.

ArTime ArLogFileConnection::getTimeRead int    index [virtual]
 

Gets the time data was read in.

Parameters:
index  looks like this is the index back in the number of bytes last read in
Returns:
the time the last read data was read in

Reimplemented from ArDeviceConnection.

bool ArLogFileConnection::isTimeStamping void    [virtual]
 

sees if timestamping is really going on or not.

Returns:
true if real timestamping is happening, false otherwise

Reimplemented from ArDeviceConnection.

int ArLogFileConnection::open const char *    fname = NULL
 

Opens a connection to the given host and port.

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

int ArLogFileConnection::read const char *    data,
unsigned int    size,
unsigned int    msWait = 0
[virtual]
 

Reads data from connection.

Reads data from connection

Parameters:
data  pointer to a character array to read the data into
size  maximum number of bytes to read
msWait  read blocks for this many milliseconds (not at all for < 0)
Returns:
number of bytes read, or -1 for failure
See also:
write, writePacket

Reimplemented from ArDeviceConnection.

int ArLogFileConnection::write const char *    data,
unsigned int    size
[virtual]
 

Writes data to connection.

Writes data to connection

Parameters:
data  pointer to a character array to write the data from
size  number of bytes to write
Returns:
number of bytes read, or -1 for failure
See also:
read, writePacket

Reimplemented from ArDeviceConnection.


The documentation for this class was generated from the following files:
Generated on Tue Nov 12 17:43:57 2002 for Aria by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001