This class provides an interface to manage File Format Details. More...
#include <AuxFile.h>
Public Member Functions | |
| TextFormat (const TextFormat &textFormat)=default | |
| void | Log () override |
| Implement this method in the derived class to specify logging behaviour. | |
| std::string & | getFormatName () |
| Return the format name. | |
| std::string & | getUniqueIdentifier () |
| Return the unique identifier for the text format. | |
| std::string & | getExtensionName () |
| Returns the extension name. | |
| void | setExtensionName (const std::string &extensionName) |
| Sets the extension name. | |
| void | setUniqueIdentifier (const std::string &uniqueIdentifier) |
| Sets the unique identifier for the text format. | |
| void | setFormatName (const std::string &formatName) |
| Sets the format name. | |
| virtual void | read (std::string &line, int props=0)=0 |
| Implement this function to specify the read operation for the file. | |
| virtual void | write (const std::string &line, int props=0)=0 |
| Implement this function to specify the write operation for the file. | |
Protected Attributes | |
| std::string | formatName |
| std::string | uniqueIdentifier |
| std::string | extensionName |
Additional Inherited Members | |
 Protected Member Functions inherited from AuxPort::ILog | |
| void | setColour (const ColourType &colourType) |
| This function allows you to set text colour for the text to be printed onto the console. | |
Detailed Description
This class provides an interface to manage File Format Details.
Member Function Documentation
◆ getExtensionName()
| std::string & AuxPort::TextFormat::getExtensionName | ( | ) |
Returns the extension name.
Definition at line 258 of file AuxFile.cpp.
◆ getFormatName()
| std::string & AuxPort::TextFormat::getFormatName | ( | ) |
Return the format name.
Definition at line 248 of file AuxFile.cpp.
◆ getUniqueIdentifier()
| std::string & AuxPort::TextFormat::getUniqueIdentifier | ( | ) |
Return the unique identifier for the text format.
Definition at line 253 of file AuxFile.cpp.
◆ Log()
|
overridevirtual |
Implement this method in the derived class to specify logging behaviour.
Reimplemented from AuxPort::ILog.
Definition at line 239 of file AuxFile.cpp.
◆ setExtensionName()
| void AuxPort::TextFormat::setExtensionName | ( | const std::string & | extensionName | ) |
Sets the extension name.
Definition at line 263 of file AuxFile.cpp.
◆ setFormatName()
| void AuxPort::TextFormat::setFormatName | ( | const std::string & | formatName | ) |
Sets the format name.
Definition at line 273 of file AuxFile.cpp.
◆ setUniqueIdentifier()
| void AuxPort::TextFormat::setUniqueIdentifier | ( | const std::string & | uniqueIdentifier | ) |
Sets the unique identifier for the text format.
Definition at line 268 of file AuxFile.cpp.
Member Data Documentation
◆ extensionName
◆ formatName
◆ uniqueIdentifier
|
protected |
The documentation for this class was generated from the following files:
- C:/ROOT/AuxPort/AuxPort_Master/master/AuxPort/Core/File/AuxFile.h
- C:/ROOT/AuxPort/AuxPort_Master/master/AuxPort/Core/File/AuxFile.cpp
