 |
ITK
4.0.0
Insight Segmentation and Registration Toolkit
|
|
ITK
4.0.0
Insight Segmentation and Registration Toolkit
|
A base class that contains common methods used for parsing csv files. More...
#include <itkCSVFileReaderBase.h>
Inheritance diagram for itk::CSVFileReaderBase: Collaboration diagram for itk::CSVFileReaderBase:A base class that contains common methods used for parsing csv files.
CSVFileReaderBase is a base abstract class for reading csv files. It contains the methods GetDataDimension() which is used to count the number of rows and columns in the file data set. Only after this method is called should calls to the GetNextField() method be made. The method ConvertStringToValueType() can be used to convert a string obtained from GetNextField() to some desired numeric type. The Parse() method is what is used to do the full processing, that is, reading the file and parsing the data into some object. It is pure virtual as a different parsing method would be needed for parsing into different types of objects.
The user would need to specify if there are row and column headers in the file using the HasRowHeaders and HasColumnHeaders flags. Also, if row and/or column headers are enclosed in "" or any other string delimiter character being used, the user can set the option of turning the string delimiter character on with the UseStringDelimiterCharacter flag. This is also especially useful if headers such as "This,Header" contain commas or other field delimiter characters within them.
If the csv file has row and column headers, they do not necessarily need to be enclosed in "" or other string delimiter characters as long as you specify that row and/or column headers exist in the file. Turning on the HasRowHeaders or HasColumnHeaders flags will tell the reader to recognize them as headers.
The PrepareForParsing() method does not need to be called explicitly as it is called in the GetDataDimension() method.
Definition at line 63 of file itkCSVFileReaderBase.h.
Standard class typedefs
Reimplemented from itk::LightProcessObject.
Reimplemented in itk::CSVArray2DFileReader< TData >.
Definition at line 67 of file itkCSVFileReaderBase.h.
Reimplemented from itk::LightProcessObject.
Reimplemented in itk::CSVArray2DFileReader< TData >.
Definition at line 68 of file itkCSVFileReaderBase.h.
| itk::CSVFileReaderBase::CSVFileReaderBase | ( | ) | [protected] |
Converting a string to other numeric value types. This is a template method in a non-templated class so it needs to be defined within the .h. The only way it would be possible to have the definition in the .cxx source file would be either to include the .cxx file or to use the export keyword, which will be removed from the c++ language.
| virtual itk::CSVFileReaderBase::~CSVFileReaderBase | ( | ) | [inline, protected, virtual] |
Converting a string to other numeric value types. This is a template method in a non-templated class so it needs to be defined within the .h. The only way it would be possible to have the definition in the .cxx source file would be either to include the .cxx file or to use the export keyword, which will be removed from the c++ language.
Definition at line 173 of file itkCSVFileReaderBase.h.
| itk::CSVFileReaderBase::CSVFileReaderBase | ( | const Self & | ) | [private] |
Converting a string to other numeric value types. This is a template method in a non-templated class so it needs to be defined within the .h. The only way it would be possible to have the definition in the .cxx source file would be either to include the .cxx file or to use the export keyword, which will be removed from the c++ language.
| TData itk::CSVFileReaderBase::ConvertStringToValueType | ( | const std::string | str | ) | [inline] |
Converting a string to other numeric value types. This is a template method in a non-templated class so it needs to be defined within the .h. The only way it would be possible to have the definition in the .cxx source file would be either to include the .cxx file or to use the export keyword, which will be removed from the c++ language.
Definition at line 135 of file itkCSVFileReaderBase.h.
| void itk::CSVFileReaderBase::GetDataDimension | ( | SizeValueType & | rows, |
| SizeValueType & | columns | ||
| ) |
Counts the number of rows and columns in a file and prepares the file for iterative reading using the GetNextField() method.
| virtual char itk::CSVFileReaderBase::GetFieldDelimiterCharacter | ( | ) | [virtual] |
Get the field delimiter character.
| virtual bool itk::CSVFileReaderBase::GetHasColumnHeaders | ( | ) | const [virtual] |
Get the value of the HasColumnHeaders flag.
| virtual bool itk::CSVFileReaderBase::GetHasRowHeaders | ( | ) | const [virtual] |
Get the value of the HasRowHeaders flag.
| virtual const char* itk::CSVFileReaderBase::GetNameOfClass | ( | ) | const [virtual] |
Run-time type information (and related methods)
Reimplemented from itk::LightProcessObject.
Reimplemented in itk::CSVArray2DFileReader< TData >.
| void itk::CSVFileReaderBase::GetNextField | ( | std::string & | ) |
Gets the next entry in the file. Returns a string. This function must always only be called after GetDataDimension().
| virtual char itk::CSVFileReaderBase::GetStringDelimiterCharacter | ( | ) | [virtual] |
Get the string delimiter character.
| virtual bool itk::CSVFileReaderBase::GetUseStringDelimiterCharacter | ( | ) | const [virtual] |
Get the value of the UseStringDelimiterCharacter flag.
| virtual void itk::CSVFileReaderBase::HasColumnHeadersOff | ( | ) | [virtual] |
Boolean macros for setting HasRowHeaders, HasColumnHeaders and UseStringDelimiterCharacter. They can conveniently be set by appending On() or Off() to each of the variable names.
| virtual void itk::CSVFileReaderBase::HasColumnHeadersOn | ( | ) | [virtual] |
Boolean macros for setting HasRowHeaders, HasColumnHeaders and UseStringDelimiterCharacter. They can conveniently be set by appending On() or Off() to each of the variable names.
| virtual void itk::CSVFileReaderBase::HasRowHeadersOff | ( | ) | [virtual] |
Boolean macros for setting HasRowHeaders, HasColumnHeaders and UseStringDelimiterCharacter. They can conveniently be set by appending On() or Off() to each of the variable names.
| virtual void itk::CSVFileReaderBase::HasRowHeadersOn | ( | ) | [virtual] |
Boolean macros for setting HasRowHeaders, HasColumnHeaders and UseStringDelimiterCharacter. They can conveniently be set by appending On() or Off() to each of the variable names.
| void itk::CSVFileReaderBase::operator= | ( | const Self & | ) | [private] |
Converting a string to other numeric value types. This is a template method in a non-templated class so it needs to be defined within the .h. The only way it would be possible to have the definition in the .cxx source file would be either to include the .cxx file or to use the export keyword, which will be removed from the c++ language.
Reimplemented from itk::LightProcessObject.
Reimplemented in itk::CSVArray2DFileReader< TData >.
| virtual void itk::CSVFileReaderBase::Parse | ( | ) | [pure virtual] |
This method must be defined in derived classes to parse the entire file into some object. The GetNextField() method only gets one string at a time. This method would store those strings or convert them using ConvertStringToValueType() and store the numeric values into the object.
Implemented in itk::CSVArray2DFileReader< TData >.
| void itk::CSVFileReaderBase::PrepareForParsing | ( | ) | [protected] |
Check that all essential components are present and plugged in.
| void itk::CSVFileReaderBase::PrintSelf | ( | std::ostream & | os, |
| Indent | indent | ||
| ) | const [protected, virtual] |
Print method
Reimplemented from itk::LightProcessObject.
Reimplemented in itk::CSVArray2DFileReader< TData >.
| virtual void itk::CSVFileReaderBase::SetFieldDelimiterCharacter | ( | char | _arg | ) | [virtual] |
Set the field delimiter character. It is possible to set another character as a field delimiter character such as ';'. The default delimiter character is ','
| virtual void itk::CSVFileReaderBase::SetFileName | ( | const char * | _arg | ) | [virtual] |
Set the name of the file to be read
| virtual void itk::CSVFileReaderBase::SetHasColumnHeaders | ( | bool | _arg | ) | [virtual] |
Set the HasColumnHeaders flag to indicate existence of column headers in the file.
| virtual void itk::CSVFileReaderBase::SetHasRowHeaders | ( | bool | _arg | ) | [virtual] |
Set the HasRowHeaders flag to indicate existence of row headers in the file.
| virtual void itk::CSVFileReaderBase::SetStringDelimiterCharacter | ( | char | _arg | ) | [virtual] |
Set the string delimiter character if it is in use.
| virtual void itk::CSVFileReaderBase::SetUseStringDelimiterCharacter | ( | bool | _arg | ) | [virtual] |
Set the UseStringDelimiterCharacter flag on if column or row headers in the file are enclosed in "" or other characters.
| virtual void itk::CSVFileReaderBase::UseStringDelimiterCharacterOff | ( | ) | [virtual] |
Boolean macros for setting HasRowHeaders, HasColumnHeaders and UseStringDelimiterCharacter. They can conveniently be set by appending On() or Off() to each of the variable names.
| virtual void itk::CSVFileReaderBase::UseStringDelimiterCharacterOn | ( | ) | [virtual] |
Boolean macros for setting HasRowHeaders, HasColumnHeaders and UseStringDelimiterCharacter. They can conveniently be set by appending On() or Off() to each of the variable names.
int itk::CSVFileReaderBase::m_EndOfColumnHeadersLine [protected] |
Converting a string to other numeric value types. This is a template method in a non-templated class so it needs to be defined within the .h. The only way it would be possible to have the definition in the .cxx source file would be either to include the .cxx file or to use the export keyword, which will be removed from the c++ language.
Definition at line 169 of file itkCSVFileReaderBase.h.
char itk::CSVFileReaderBase::m_FieldDelimiterCharacter [protected] |
Converting a string to other numeric value types. This is a template method in a non-templated class so it needs to be defined within the .h. The only way it would be possible to have the definition in the .cxx source file would be either to include the .cxx file or to use the export keyword, which will be removed from the c++ language.
Definition at line 163 of file itkCSVFileReaderBase.h.
std::string itk::CSVFileReaderBase::m_FileName [protected] |
Converting a string to other numeric value types. This is a template method in a non-templated class so it needs to be defined within the .h. The only way it would be possible to have the definition in the .cxx source file would be either to include the .cxx file or to use the export keyword, which will be removed from the c++ language.
Definition at line 162 of file itkCSVFileReaderBase.h.
bool itk::CSVFileReaderBase::m_HasColumnHeaders [protected] |
Converting a string to other numeric value types. This is a template method in a non-templated class so it needs to be defined within the .h. The only way it would be possible to have the definition in the .cxx source file would be either to include the .cxx file or to use the export keyword, which will be removed from the c++ language.
Definition at line 167 of file itkCSVFileReaderBase.h.
bool itk::CSVFileReaderBase::m_HasRowHeaders [protected] |
Converting a string to other numeric value types. This is a template method in a non-templated class so it needs to be defined within the .h. The only way it would be possible to have the definition in the .cxx source file would be either to include the .cxx file or to use the export keyword, which will be removed from the c++ language.
Definition at line 166 of file itkCSVFileReaderBase.h.
std::ifstream itk::CSVFileReaderBase::m_InputStream [protected] |
Converting a string to other numeric value types. This is a template method in a non-templated class so it needs to be defined within the .h. The only way it would be possible to have the definition in the .cxx source file would be either to include the .cxx file or to use the export keyword, which will be removed from the c++ language.
Definition at line 168 of file itkCSVFileReaderBase.h.
std::string itk::CSVFileReaderBase::m_Line [protected] |
Converting a string to other numeric value types. This is a template method in a non-templated class so it needs to be defined within the .h. The only way it would be possible to have the definition in the .cxx source file would be either to include the .cxx file or to use the export keyword, which will be removed from the c++ language.
Definition at line 170 of file itkCSVFileReaderBase.h.
char itk::CSVFileReaderBase::m_StringDelimiterCharacter [protected] |
Converting a string to other numeric value types. This is a template method in a non-templated class so it needs to be defined within the .h. The only way it would be possible to have the definition in the .cxx source file would be either to include the .cxx file or to use the export keyword, which will be removed from the c++ language.
Definition at line 164 of file itkCSVFileReaderBase.h.
bool itk::CSVFileReaderBase::m_UseStringDelimiterCharacter [protected] |
Converting a string to other numeric value types. This is a template method in a non-templated class so it needs to be defined within the .h. The only way it would be possible to have the definition in the .cxx source file would be either to include the .cxx file or to use the export keyword, which will be removed from the c++ language.
Definition at line 165 of file itkCSVFileReaderBase.h.
1.7.4
