NDEVR
API Documentation
INIOptionabstract

A class used with INIFactory to store a reference to an object in the program that can be inherited to provide read and write functionality to the factory. More...

Public Member Functions

 INIOption ()
 Constructs a default INIOption.
virtual ~INIOption ()
 Virtual destructor for safe polymorphic cleanup.
virtual INIOptioncopy () const =0
 Creates a deep copy of this INIOption.
virtual void readOptionAscii (Scanner &option)=0
 Reads an option value from a Scanner stream.
virtual void readOptionAscii (String option)=0
 Reads an option value from an ASCII string representation.
virtual void readOptionBinary (const char *bytes)=0
 Reads the option value from a raw binary byte buffer.
virtual String writeOptionAscii () const =0
 Writes the option value to an ASCII string representation.
virtual void writeOptionBinary (FILE *stream) const =0
 Writes the option value in binary format to a file stream.

Detailed Description

A class used with INIFactory to store a reference to an object in the program that can be inherited to provide read and write functionality to the factory.


Definition at line 48 of file INIReader.h.

Member Function Documentation

◆ copy()

virtual INIOption * INIOption::copy ( ) const
pure virtual

Creates a deep copy of this INIOption.

Returns
A newly allocated copy of this option.

References INIOption().

◆ readOptionAscii() [1/2]

virtual void INIOption::readOptionAscii ( Scanner & option)
pure virtual

Reads an option value from a Scanner stream.

Parameters
[in]optionThe scanner to read the option value from.

◆ readOptionAscii() [2/2]

virtual void INIOption::readOptionAscii ( String option)
pure virtual

Reads an option value from an ASCII string representation.

Parameters
[in]optionThe string containing the option value to parse.

◆ readOptionBinary()

virtual void INIOption::readOptionBinary ( const char * bytes)
pure virtual

Reads the option value from a raw binary byte buffer.

Parameters
[in]bytesPointer to the raw bytes to read from.

◆ writeOptionAscii()

virtual String INIOption::writeOptionAscii ( ) const
pure virtual

Writes the option value to an ASCII string representation.

Returns
A string containing the serialized option value.

◆ writeOptionBinary()

virtual void INIOption::writeOptionBinary ( FILE * stream) const
pure virtual

Writes the option value in binary format to a file stream.

Parameters
[in]streamThe file stream to write to.

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