Technical Reference:Parameter Definition - Revision history

Mellinger: /* (parent_scope) */

2024-02-08T15:32:12Z

(parent_scope)

← Older revision		Revision as of 15:32, 8 February 2024
Line 237:		Line 237:
	Just as filters themselves, parameters are located inside a hierarchy of filter nodes.		Just as filters themselves, parameters are located inside a hierarchy of filter nodes.
	By default, parameters are attached to the filter node by which they are published.		By default, parameters are attached to the filter node by which they are published.
	In rare cases, such as inheritance of filters from a common base class, and their use in alternation (as by the <tt>ChoiceCombination</tt> ~~base~~ class), parameters from the common base class may be duplicated, which is undesired.		In rare cases, such as inheritance of filters from a common base class, and their use in alternation (as by the <tt>ChoiceCombination</tt> class), parameters from the common base class may be duplicated, which is undesired.
	In this case, using <tt>(parent_scope)</tt> in the parameter declarations of the common base class will move ownership		In this case, using <tt>(parent_scope)</tt> in the parameter declarations of the common base class will move ownership
	up to the <tt>ChoiceCombination</tt> and thus they will only exist once despite being published by each of the two choices.		up to the <tt>ChoiceCombination</tt> and thus they will only exist once despite being published by each of the two choices.

Mellinger: /* (allow_override) */

2024-02-08T15:30:57Z

(allow_override)

← Older revision		Revision as of 15:30, 8 February 2024
Line 233:		Line 233:

	Changing general policy is not an option because it would break some code, so the <tt>allow_override</tt> flag was introduced to mark parameters for which "override current value" was desired as a policy.		Changing general policy is not an option because it would break some code, so the <tt>allow_override</tt> flag was introduced to mark parameters for which "override current value" was desired as a policy.

			===<tt>(parent_scope)</tt>===
			Just as filters themselves, parameters are located inside a hierarchy of filter nodes.
			By default, parameters are attached to the filter node by which they are published.
			In rare cases, such as inheritance of filters from a common base class, and their use in alternation (as by the <tt>ChoiceCombination</tt> base class), parameters from the common base class may be duplicated, which is undesired.
			In this case, using <tt>(parent_scope)</tt> in the parameter declarations of the common base class will move ownership
			up to the <tt>ChoiceCombination</tt> and thus they will only exist once despite being published by each of the two choices.

	==Grouping Parameters into Sections==		==Grouping Parameters into Sections==

Mellinger: /* Display Format/Policy specifiers */

2024-02-08T15:20:05Z

Display Format/Policy specifiers

← Older revision		Revision as of 15:20, 8 February 2024
Line 137:		Line 137:

	{\| border="1"		{\| border="1"
	\|+ ~~The currently~~ defined format identifiers		\|+ Currently defined format identifiers
	! Identifier !! Description		! Identifier !! Description
	\|-		\|-
Line 151:		Line 151:
	\|-		\|-
	\| <tt>(color)</tt> \|\| RGB color		\| <tt>(color)</tt> \|\| RGB color
	\|-
	~~\| <tt>(readonly)</tt> \|\| readonly property~~
	\|-
	~~\| <tt>(allow_override)</tt> \|\| allow override property~~
	\|}		\|}

Line 213:		Line 209:
	// Color of table cloth to put up for breakfast (color)		// Color of table cloth to put up for breakfast (color)
	</pre>		</pre>

			{\| border="1"
			\|+ Currently defined policy specifiers
			! Identifier !! Description
			\|-
			\| <tt>(readonly)</tt> \|\| readonly
			\|-
			\| <tt>(allow_override)</tt> \|\| allow override
			\|-
			\| <tt>(parent_scope)</tt> \|\| attach parameter to parent scope
			\|}

	===<tt>(readonly)</tt>===		===<tt>(readonly)</tt>===

Mellinger: /* (color) */

2024-01-24T14:43:40Z

(color)

@@ Line 213: / Line 213: @@
    // Color of table cloth to put up for breakfast (color)
 </pre>
 ==Grouping Parameters into Sections==

Mellinger: /* Display Format */

2024-01-24T14:40:01Z

Display Format

← Older revision		Revision as of 14:40, 24 January 2024
Line 120:		Line 120:
	sub-parameters within matrices as in the example above.		sub-parameters within matrices as in the example above.

	==Display Format==		==Display Format/Policy specifiers==
	Generally, a parameter's <tt>DataType</tt> field will be used to		Generally, a parameter's <tt>DataType</tt> field will be used to
	determine its appropriate display in a parameter editor.		determine its appropriate display in a parameter editor.
Line 151:		Line 151:
	\|-		\|-
	\| <tt>(color)</tt> \|\| RGB color		\| <tt>(color)</tt> \|\| RGB color
			\|-
			\| <tt>(readonly)</tt> \|\| readonly property
			\|-
			\| <tt>(allow_override)</tt> \|\| allow override property
	\|}		\|}

Mellinger: /* Parameter Lines */

2023-04-21T13:58:57Z

Parameter Lines

← Older revision		Revision as of 13:58, 21 April 2023
Line 24:		Line 24:
	*[[Technical Reference:Parameter File\|BCI2000 parameter files]]		*[[Technical Reference:Parameter File\|BCI2000 parameter files]]
	*[[Technical Reference:BCI2000 File Format\|BCI2000 data files]]		*[[Technical Reference:BCI2000 File Format\|BCI2000 data files]]
	*[[Programming Reference:GenericFilter Class\|~~Filter~~'s Publish() function]]		*[[Programming Reference:GenericFilter Class\|Filters' Publish() function]]
	*[[Technical Reference:BCI2000 Messages\|BCI2000 messages]] sent between modules.		*[[Technical Reference:BCI2000 Messages\|BCI2000 messages]] sent between modules.

Mellinger: /* Parameter Lines */

2023-04-21T13:58:42Z

Parameter Lines

← Older revision		Revision as of 13:58, 21 April 2023
Line 24:		Line 24:
	*[[Technical Reference:Parameter File\|BCI2000 parameter files]]		*[[Technical Reference:Parameter File\|BCI2000 parameter files]]
	*[[Technical Reference:BCI2000 File Format\|BCI2000 data files]]		*[[Technical Reference:BCI2000 File Format\|BCI2000 data files]]
	*[[Programming Reference:GenericFilter Class\|Filter ~~constructors~~]]		*[[Programming Reference:GenericFilter Class\|Filter's Publish() function]]
	*[[Technical Reference:BCI2000 Messages\|BCI2000 messages]] sent between modules.		*[[Technical Reference:BCI2000 Messages\|BCI2000 messages]] sent between modules.

Mellinger: /* Parameter Lines */

2019-08-07T15:57:59Z

Parameter Lines

← Older revision		Revision as of 15:57, 7 August 2019
Line 51:		Line 51:
	where, again, each NumValues entry may be substituted by a list of		where, again, each NumValues entry may be substituted by a list of
	textual labels.		textual labels.
	For matrices, values are given in ~~column~~-major order, i.e. listing		For matrices, values are given in row-major order, i.e. listing
	values from the first ~~column~~ first, then values from the second ~~column~~,		values from the first row first, then values from the second row,
	and so on, as in		and so on, as in
	Value(0,0) Value(0,1) ... Value(0,m) Value(1,0) Value(1,1) ... Value(1,m) ...		Value(0,0) Value(0,1) ... Value(0,m) Value(1,0) Value(1,1) ... Value(1,m) ...

Mellinger: /* Special Characters */

2009-06-29T07:07:00Z

Special Characters

← Older revision		Revision as of 07:07, 29 June 2009
Line 96:		Line 96:
	</pre>		</pre>
	defines a parameter ''SomeString'' which contains the value		defines a parameter ''SomeString'' which contains the value
	''a string		"a string
	with spaces''.		with spaces".
	The single <tt>%</tt> characters indicate that the		The single <tt>%</tt> characters indicate that the
	''DefaultValue'' ,		''DefaultValue'' ,

Mellinger: /* See also */

2008-05-07T17:35:37Z

← Older revision		Revision as of 13:58, 21 April 2023
Line 24:		Line 24:
	*[[Technical Reference:Parameter File\|BCI2000 parameter files]]		*[[Technical Reference:Parameter File\|BCI2000 parameter files]]
	*[[Technical Reference:BCI2000 File Format\|BCI2000 data files]]		*[[Technical Reference:BCI2000 File Format\|BCI2000 data files]]
	*[[Programming Reference:GenericFilter Class\|~~Filter~~'s Publish() function]]		*[[Programming Reference:GenericFilter Class\|Filters' Publish() function]]
	*[[Technical Reference:BCI2000 Messages\|BCI2000 messages]] sent between modules.		*[[Technical Reference:BCI2000 Messages\|BCI2000 messages]] sent between modules.

← Older revision		Revision as of 13:58, 21 April 2023
Line 24:		Line 24:
	*[[Technical Reference:Parameter File\|BCI2000 parameter files]]		*[[Technical Reference:Parameter File\|BCI2000 parameter files]]
	*[[Technical Reference:BCI2000 File Format\|BCI2000 data files]]		*[[Technical Reference:BCI2000 File Format\|BCI2000 data files]]
	*[[Programming Reference:GenericFilter Class\|Filter ~~constructors~~]]		*[[Programming Reference:GenericFilter Class\|Filter's Publish() function]]
	*[[Technical Reference:BCI2000 Messages\|BCI2000 messages]] sent between modules.		*[[Technical Reference:BCI2000 Messages\|BCI2000 messages]] sent between modules.

← Older revision		Revision as of 17:35, 7 May 2008
Line 233:		Line 233:

	==See also==		==See also==
	[[User Reference:Parameters]], [[Technical Reference:~~Parameter~~ Definition]]		[[User Reference:Parameters]], [[Technical Reference:State Definition]]

	[[Category:Specification]]		[[Category:Specification]]