ArLogFileConnection Class Reference

#include <ArLogFileConnection.h>

Inheritance diagram for ArLogFileConnection:

List of all members.

---

Detailed Description

For connecting through a log file.

Public Types
enum	Open { OPEN_FILE_NOT_FOUND = 1, OPEN_NOT_A_LOG_FILE }
Public Member Functions
	ArLogFileConnection ()
	Constructor.
virtual bool	close (void)
const char *	getLogFile (void)
	Gets the name of the host connected to.
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.
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 Attributes
bool	havePose
char	myName [100]
ArPose	myPose
char	mySubtype [20]
char	myType [20]
Protected Member Functions
void	buildStrMap (void)
Protected Attributes
FILE *	myFD
const char *	myLogFile
int	myStatus
ArStrMap	myStrMap
int	stopAfter

---

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

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: 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

---

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

• ArLogFileConnection.h
• ArLogFileConnection.cpp

---