CrossNeighboursTextFileWriter Class Reference

Text file writer for cross-catalogue neighbour pairs. More...

#include <CrossNeighboursTextFileWriter.h>

Inheritance diagram for CrossNeighboursTextFileWriter:

[legend]

Collaboration diagram for CrossNeighboursTextFileWriter:

[legend]

List of all members.

Public Member Functions
	CrossNeighboursTextFileWriter (char const *aFileNameStr, bool aIsLarge=false)
	Constructor.
virtual	~CrossNeighboursTextFileWriter ()
virtual void	open ()
	Open file for writing.
virtual void	close ()
	Close file.
virtual void	write (Object const *aExternObjectPtr, Object const *aMainObjectPtr)
	Write an object pair row to the output text file.
Protected Attributes
FILE *	mFilePtr
char const *	mFileNameStr
bool	mIsLarge
Private Member Functions
	CrossNeighboursTextFileWriter ()
	CrossNeighboursTextFileWriter (CrossNeighboursTextFileWriter const &aCopy)
CrossNeighboursTextFileWriter &	operator= (CrossNeighboursTextFileWriter const &aCopy)

---

Detailed Description

Text file writer for cross-catalogue neighbour pairs.

Creates comma-separated text file with one row for each matching pair with columns: mainID, externalID, distanceMins (the source separation in arcminutes)

Definition at line 23 of file CrossNeighboursTextFileWriter.h.

---

Constructor & Destructor Documentation

CrossNeighboursTextFileWriter::CrossNeighboursTextFileWriter	(	char const *	aFileNameStr,
		bool	aIsLarge = false
	)

Constructor.

Parameters:

	aFileNameStr	Create output file with this name
	aIsLarge	Will file be larger than 2 Gb?

Definition at line 12 of file CrossNeighboursTextFileWriter.cpp.

virtual CrossNeighboursTextFileWriter::~CrossNeighboursTextFileWriter

(

)

[inline, virtual]

Definition at line 32 of file CrossNeighboursTextFileWriter.h.

CrossNeighboursTextFileWriter::CrossNeighboursTextFileWriter

(

)

[private]

CrossNeighboursTextFileWriter::CrossNeighboursTextFileWriter

(

CrossNeighboursTextFileWriter const &

aCopy

)

[private]

---

Member Function Documentation

void CrossNeighboursTextFileWriter::close

(

)

[virtual]

Close file.

Reimplemented from ObjectPairWriter.

Definition at line 26 of file CrossNeighboursTextFileWriter.cpp.

References FileUtil::close(), FileUtil::instance(), and mFilePtr.

void CrossNeighboursTextFileWriter::open

(

)

[virtual]

Open file for writing.

Reimplemented from ObjectPairWriter.

Definition at line 21 of file CrossNeighboursTextFileWriter.cpp.

References FileUtil::instance(), mFileNameStr, mFilePtr, mIsLarge, and FileUtil::writeOpen().

CrossNeighboursTextFileWriter& CrossNeighboursTextFileWriter::operator=

(

CrossNeighboursTextFileWriter const &

aCopy

)

[private]

virtual void CrossNeighboursTextFileWriter::write	(	Object const *	aExternObjectPtr,
		Object const *	aMainObjectPtr
	)			[inline, virtual]

Write an object pair row to the output text file.

Parameters:

	aExternObjectPtr	The pairing's external catalogue source Object
	aMainObjectPtr	The pairing's main catalogue source Object

Reimplemented from ObjectPairWriter.

Definition at line 44 of file CrossNeighboursTextFileWriter.h.

References Object::gcDistanceMins(), Datum::getId(), and mFilePtr.

---

Member Data Documentation

char const* CrossNeighboursTextFileWriter::mFileNameStr [protected]

Definition at line 57 of file CrossNeighboursTextFileWriter.h.

Referenced by open().

FILE* CrossNeighboursTextFileWriter::mFilePtr [protected]

Definition at line 56 of file CrossNeighboursTextFileWriter.h.

Referenced by close(), open(), and write().

bool CrossNeighboursTextFileWriter::mIsLarge [protected]

Definition at line 58 of file CrossNeighboursTextFileWriter.h.

Referenced by open().

---

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

• CrossNeighboursTextFileWriter.h
• CrossNeighboursTextFileWriter.cpp