Programming Reference:GenericSignal Class - Revision history

Mellinger: /* SetValue(uint channel, uint element, double value) */

2025-06-19T19:08:56Z

SetValue(uint channel, uint element, double value)

← Older revision		Revision as of 19:08, 19 June 2025
Line 31:		Line 31:

	'''NOTE:''' Access to individual values is inefficient for large numbers of elements and channels.		'''NOTE:''' Access to individual values is inefficient for large numbers of elements and channels.
	Use <tt>MutableData~~()</tt> or <tt>ConstData~~()</tt> to obtain a pointer to the underlying data instead.		Use <tt>MutableData()</tt> to obtain a pointer to the underlying data instead.

	===double* MutableData()===		===double* MutableData()===

Mellinger: /* WriteValueBinary(ostream, const double* value) */

2025-06-19T19:06:41Z

WriteValueBinary(ostream, const double* value)

← Older revision		Revision as of 19:06, 19 June 2025
Line 60:		Line 60:
	===istream ExtractFrom(istream)===		===istream ExtractFrom(istream)===
	Reads the signal's content as written by <tt>InsertInto()</tt>.		Reads the signal's content as written by <tt>InsertInto()</tt>.
	===WriteValueBinary(ostream, const double* ~~value~~)===		===WriteValueBinary(ostream, const double*)===
	Writes a single value into the given stream in binary form, using the format present in <tt>Properties().Type()</tt>.		Writes a single value into the given stream in binary form, using the format present in <tt>Properties().Type()</tt>.

Mellinger: /* ReadValueBinary(istream, uint channel, uint element) */

2025-06-19T19:06:24Z

ReadValueBinary(istream, uint channel, uint element)

← Older revision		Revision as of 19:06, 19 June 2025
Line 63:		Line 63:
	Writes a single value into the given stream in binary form, using the format present in <tt>Properties().Type()</tt>.		Writes a single value into the given stream in binary form, using the format present in <tt>Properties().Type()</tt>.

	===ReadValueBinary(istream, ~~uint channel, uint element~~)===		===ReadValueBinary(istream, double*)===
	Reads a single value from the given stream in binary form.		Reads a single value from the given stream in binary form, using the format present in <tt>Properties().Type()</tt>.

	===Serialize(ostream)===		===Serialize(ostream)===
	Writes the entire signal into the given stream in binary form. If <tt>ShareAcrossModules</tt> has been called, a reference to shared memory is written rather than signal data.		Writes the entire signal into the given stream in binary form. If <tt>ShareAcrossModules</tt> has been called, a reference to shared memory is written rather than signal data.

Mellinger: /* WriteValueBinary(ostream, uint channel, uint element) */

2025-06-19T19:05:43Z

WriteValueBinary(ostream, uint channel, uint element)

← Older revision		Revision as of 19:05, 19 June 2025
Line 60:		Line 60:
	===istream ExtractFrom(istream)===		===istream ExtractFrom(istream)===
	Reads the signal's content as written by <tt>InsertInto()</tt>.		Reads the signal's content as written by <tt>InsertInto()</tt>.
	===WriteValueBinary(ostream, ~~uint channel, uint element~~)===		===WriteValueBinary(ostream, const double* value)===
	Writes a single value into the given stream in binary form.		Writes a single value into the given stream in binary form, using the format present in <tt>Properties().Type()</tt>.

	===ReadValueBinary(istream, uint channel, uint element)===		===ReadValueBinary(istream, uint channel, uint element)===
	Reads a single value from the given stream in binary form.		Reads a single value from the given stream in binary form.

Mellinger: /* SetValue(uint channel, uint element, double value) */

2025-06-19T19:02:34Z

SetValue(uint channel, uint element, double value)

@@ Line 32: / Line 32: @@
 '''NOTE:''' Access to individual values is inefficient for large numbers of elements and channels.
 Use <tt>MutableData()</tt> or <tt>ConstData()</tt> to obtain a pointer to the underlying data instead.
 ===SetAllValues(double value)===

Mellinger: /* SetValue(uint channel, uint element, double value) */

2025-06-19T18:47:22Z

SetValue(uint channel, uint element, double value)

← Older revision		Revision as of 18:47, 19 June 2025
Line 29:		Line 29:
	===SetValue(uint channel, uint element, double value)===		===SetValue(uint channel, uint element, double value)===
	Sets the value at the given channel and element index.		Sets the value at the given channel and element index.

			'''NOTE:''' Access to individual values is inefficient for large numbers of elements and channels.
			Use <tt>MutableData()</tt> or <tt>ConstData()</tt> to obtain a pointer to the underlying data instead.

	===SetAllValues(double value)===		===SetAllValues(double value)===
	Sets all signal values to the value given as argument.		Sets all signal values to the value given as argument.

Mellinger: /* double Value(uint channel, uint element), operator()(uint channel, uint element) */

2025-06-19T18:47:06Z

double Value(uint channel, uint element), operator()(uint channel, uint element)

← Older revision		Revision as of 18:47, 19 June 2025
Line 24:		Line 24:
	Returns the value at the given channel and element index.		Returns the value at the given channel and element index.

	'''NOTE:''' ~~This~~ is inefficient for large numbers of elements and channels.		'''NOTE:''' Access to individual values is inefficient for large numbers of elements and channels.
	Use <tt>MutableData()</tt> or <tt>ConstData()</tt> to obtain a pointer to the underlying data instead.		Use <tt>MutableData()</tt> or <tt>ConstData()</tt> to obtain a pointer to the underlying data instead.

Mellinger: /* double Value(uint channel, uint element), operator()(uint channel, uint element) */

2025-06-19T18:46:28Z

double Value(uint channel, uint element), operator()(uint channel, uint element)

← Older revision		Revision as of 18:46, 19 June 2025
Line 23:		Line 23:
	===double Value(uint channel, uint element), operator()(uint channel, uint element)===		===double Value(uint channel, uint element), operator()(uint channel, uint element)===
	Returns the value at the given channel and element index.		Returns the value at the given channel and element index.
	NOTE: This is inefficient for large numbers of elements and channels.
			'''NOTE:''' This is inefficient for large numbers of elements and channels.
	Use <tt>MutableData()</tt> or <tt>ConstData()</tt> to obtain a pointer to the underlying data instead.		Use <tt>MutableData()</tt> or <tt>ConstData()</tt> to obtain a pointer to the underlying data instead.

Mellinger: /* double Value(uint channel, uint element), operator()(uint channel, uint element) */

2025-06-19T18:46:13Z

double Value(uint channel, uint element), operator()(uint channel, uint element)

← Older revision		Revision as of 18:46, 19 June 2025
Line 23:		Line 23:
	===double Value(uint channel, uint element), operator()(uint channel, uint element)===		===double Value(uint channel, uint element), operator()(uint channel, uint element)===
	Returns the value at the given channel and element index.		Returns the value at the given channel and element index.
			NOTE: This is inefficient for large numbers of elements and channels.
			Use <tt>MutableData()</tt> or <tt>ConstData()</tt> to obtain a pointer to the underlying data instead.

	===SetValue(uint channel, uint element, double value)===		===SetValue(uint channel, uint element, double value)===
	Sets the value at the given channel and element index.		Sets the value at the given channel and element index.

Mellinger: /* bool ShareAcrossModules() */

2019-02-12T14:08:00Z

bool ShareAcrossModules()

← Older revision		Revision as of 14:08, 12 February 2019
Line 30:		Line 30:
	If the signal contains a shallow copy of another signal, replace it with a deep copy.		If the signal contains a shallow copy of another signal, replace it with a deep copy.
	===bool ShareAcrossModules()===		===bool ShareAcrossModules()===
	~~Moves~~ signal data into a newly assigned shared memory block. <tt>Serialize()</tt> will output a short reference to that shared memory block rather than the signal's data content.		If data is not contained in shared memory already, this function moves signal data into a newly assigned shared memory block. <tt>Serialize()</tt> will output a short reference to that shared memory block rather than the signal's data content.
			Returns <tt>true</tt> if data was newly moved into shared memory, <tt>false</tt> otherwise.

	===ostream InsertInto(ostream)===		===ostream InsertInto(ostream)===
	Writes the signal's content to the given stream in human readable format.		Writes the signal's content to the given stream in human readable format.