Programming Reference:GenericFileWriter Class - Revision history

Mellinger: Programming Reference:GenericFileWriter moved to Programming Reference:GenericFileWriter Class

2008-04-07T16:49:05Z

Programming Reference:GenericFileWriter moved to Programming Reference:GenericFileWriter Class

← Older revision		Revision as of 16:49, 7 April 2008
(No difference)

Mellinger: /* `Write()` rather than `Process()` */

2008-04-07T16:05:22Z

<tt>Write()</tt> rather than <tt>Process()</tt>

← Older revision		Revision as of 16:05, 7 April 2008
Line 25:		Line 25:
	Actual data output is supposed to take place from the <tt>Write()</tt> member function, which receives a <tt>GenericSignal</tt> and a <tt>StateVector</tt> argument.		Actual data output is supposed to take place from the <tt>Write()</tt> member function, which receives a <tt>GenericSignal</tt> and a <tt>StateVector</tt> argument.
	There, the state vector argument represents the state vector as it existed at the time when the signal, as provided in the signal argument, was acquired.		There, the state vector argument represents the state vector as it existed at the time when the signal, as provided in the signal argument, was acquired.

			For <tt>GenericFileWriter</tt> descendants, no <tt>Process()</tt> member function will be called.

	==See also==		==See also==

Mellinger: /* `Publish()` member function */

2008-04-07T16:04:28Z

<tt>Publish()</tt> member function

← Older revision		Revision as of 16:04, 7 April 2008
Line 9:		Line 9:
	Within the <tt>Publish()</tt> member, parameter and state requests may be specified using the <tt>..._DEFINITIONS</tt> macros as in constructors.		Within the <tt>Publish()</tt> member, parameter and state requests may be specified using the <tt>..._DEFINITIONS</tt> macros as in constructors.
	At the beginning of the <tt>Publish()</tt> member function, the inherited implementation of <tt>Publish()</tt> should be called, as in the following example:		At the beginning of the <tt>Publish()</tt> member function, the inherited implementation of <tt>Publish()</tt> should be called, as in the following example:
			<pre>
			void
			BCI2000FileWriter::Publish() const
			{
			FileWriterBase::Publish();

	~~void~~		BEGIN_PARAMETER_DEFINITIONS
	~~BCI2000FileWriter::Publish() const~~		"Storage string StorageTime= % % % % "
	{		"// time of beginning of data storage",
	~~FileWriterBase::Publish();~~		END_PARAMETER_DEFINITIONS
			}
	BEGIN_PARAMETER_DEFINITIONS		</pre>
	"Storage string StorageTime= % % % % "
	"// time of beginning of data storage",
	END_PARAMETER_DEFINITIONS
	}

	==<tt>Write()</tt> rather than <tt>Process()</tt>==		==<tt>Write()</tt> rather than <tt>Process()</tt>==

Mellinger at 16:04, 7 April 2008

2008-04-07T16:04:03Z

New page

The <tt>GenericFileWriter</tt> class is a specialization of the [[Programming Reference:GenericFilter Class|<tt>GenericFilter</tt> class]].
It is supposed to provide an interface to classes that implement data output into various file formats. Typically, such classes do not inherit from <tt>GenericFileWriter</tt> directly; rather, they inherit from the <tt>FileWriterBase</tt> class that additionally implements functionality common to all FileWriters, such as dealing with file naming, location, opening and closing.
<tt>FileWriterBase</tt> maintains an <tt>OutputStream</tt> property that provides access to a <tt>std::ostream</tt> object bound to the current output file.

The <tt>GenericFileWriter</tt> interface is identical to the <tt>GenericFilter</tt> interface, except for the following:

==<tt>Publish()</tt> member function==
Unlike other descendants of <tt>GenericFilter</tt>, <tt>GenericFileWriter</tt> descendants are supposed to issue parameter and state requests from a separate <tt>Publish()</tt> member function rather than their constructors.
Within the <tt>Publish()</tt> member, parameter and state requests may be specified using the <tt>..._DEFINITIONS</tt> macros as in constructors.
At the beginning of the <tt>Publish()</tt> member function, the inherited implementation of <tt>Publish()</tt> should be called, as in the following example:

void
BCI2000FileWriter::Publish() const
{
FileWriterBase::Publish();

BEGIN_PARAMETER_DEFINITIONS
"Storage string StorageTime= % % % % "
"// time of beginning of data storage",
END_PARAMETER_DEFINITIONS
}

==<tt>Write()</tt> rather than <tt>Process()</tt>==
Actual data output is supposed to take place from the <tt>Write()</tt> member function, which receives a <tt>GenericSignal</tt> and a <tt>StateVector</tt> argument.
There, the state vector argument represents the state vector as it existed at the time when the signal, as provided in the signal argument, was acquired.

==See also==
[[Programming Tutorial:Implementing a Data Acquisition Module]], [[Programming Reference:GenericFilter Class]]

[[Category:Framework API]] [[Category:Development]]

Programming Reference:GenericFileWriter Class - Revision history

Mellinger: Programming Reference:GenericFileWriter moved to Programming Reference:GenericFileWriter Class

Mellinger: /* Write() rather than Process() */

Mellinger: /* Publish() member function */

Mellinger at 16:04, 7 April 2008

Mellinger: /* `Write()` rather than `Process()` */

Mellinger: /* `Publish()` member function */