Programming Reference:Parameters - Revision history

Mellinger: /* =bool AllowOverride (r) */

2024-01-24T14:02:38Z

=bool AllowOverride (r)

← Older revision		Revision as of 14:02, 24 January 2024
Line 42:		Line 42:
	Whether the (readonly) flag has been specified in the parameter's comment.		Whether the (readonly) flag has been specified in the parameter's comment.

	====bool AllowOverride (r)===		====bool AllowOverride (r)====
	Whether the (allow_override) flag has been specified in the parameter's comment.		Whether the (allow_override) flag has been specified in the parameter's comment.
	====bool Changed (r)====		====bool Changed (r)====

Mellinger: /* =bool Readonly (r) */

2024-01-24T14:02:16Z

=bool Readonly (r)

← Older revision		Revision as of 14:02, 24 January 2024
Line 39:		Line 39:
	====string Comment (rw)====		====string Comment (rw)====
	The parameter's comment.		The parameter's comment.
	====bool Readonly (r)===		====bool Readonly (r)====
	Whether the (readonly) flag has been specified in the parameter's comment.		Whether the (readonly) flag has been specified in the parameter's comment.

	====bool AllowOverride (r)===		====bool AllowOverride (r)===
	Whether the (allow_override) flag has been specified in the parameter's comment.		Whether the (allow_override) flag has been specified in the parameter's comment.

Mellinger: /* Properties */

2024-01-24T14:01:27Z

Properties

← Older revision		Revision as of 14:01, 24 January 2024
Line 39:		Line 39:
	====string Comment (rw)====		====string Comment (rw)====
	The parameter's comment.		The parameter's comment.
			====bool Readonly (r)===
			Whether the (readonly) flag has been specified in the parameter's comment.
			====bool AllowOverride (r)===
			Whether the (allow_override) flag has been specified in the parameter's comment.
	====bool Changed (r)====		====bool Changed (r)====
	The parameter's changed flag is set to true when the parameter is modified. The flag may be reset to false by using the its '''Unchanged()''' method.		The parameter's changed flag is set to true when the parameter is modified. The flag may be reset to false by using the its '''Unchanged()''' method.

Mellinger: /* Param ByIndex( int index ) */

2022-08-12T14:24:15Z

Param ByIndex( int index )

← Older revision		Revision as of 14:24, 12 August 2022
Line 63:		Line 63:

	====Param ByIndex( int index )====		====Param ByIndex( int index )====
	Access to an individual <tt>Param</tt> object by its index.		Access to an individual <tt>Param</tt> object by its index. Indices span from <tt>0</tt> to <tt>Size()-1</tt>.

	====Clear()====		====Clear()====

Mellinger: /* Param operator[]( int index ) */

2022-08-12T14:23:24Z

Param operator[]( int index )

← Older revision		Revision as of 14:23, 12 August 2022
Line 62:		Line 62:
	Access to an individual <tt>Param</tt> object by its (partial) path. Parameter paths are formed possibly by a hierarchy of subchain names, then the filter name, and the parameter name.		Access to an individual <tt>Param</tt> object by its (partial) path. Parameter paths are formed possibly by a hierarchy of subchain names, then the filter name, and the parameter name.

	====Param ~~operator[]~~( int index )====		====Param ByIndex( int index )====
	Access to an individual <tt>Param</tt> object by its index.		Access to an individual <tt>Param</tt> object by its index.

	====Clear()====		====Clear()====
	Removes all <tt>Param</tt> objects from the list.		Removes all <tt>Param</tt> objects from the list.

Mellinger: /* Param operator[]( string name ) */

2022-08-12T14:22:59Z

Param operator[]( string name )

← Older revision		Revision as of 14:22, 12 August 2022
Line 59:		Line 59:
	==ParamList Class==		==ParamList Class==
	===Methods===		===Methods===
	====Param ~~operator[]~~( string name )====		====Param ByPath( string name )====
	Access to an individual <tt>Param</tt> object by its name.		Access to an individual <tt>Param</tt> object by its (partial) path. Parameter paths are formed possibly by a hierarchy of subchain names, then the filter name, and the parameter name.

	====Param operator[]( int index )====		====Param operator[]( int index )====
	Access to an individual <tt>Param</tt> object by its index.		Access to an individual <tt>Param</tt> object by its index.

Mellinger: /* See also */

2011-04-28T15:30:51Z

Mellinger: /* bool Load( string filename, bool importNonexisting = true ) */

2010-06-30T14:50:18Z

bool Load( string filename, bool importNonexisting = true )

← Older revision		Revision as of 14:50, 30 June 2010
Line 78:		Line 78:
	Saves the list as a [[Technical Reference:Parameter File\|BCI2000 Parameter File]] with the specified file name.		Saves the list as a [[Technical Reference:Parameter File\|BCI2000 Parameter File]] with the specified file name.
	====bool Load( string filename, bool importNonexisting = true )====		====bool Load( string filename, bool importNonexisting = true )====
	Loads parameters from a [[Technical Reference:Parameter File\|BCI2000 Parameter File]] specified in the first argument. For parameters already present in the list, their values are updated from the file. If the importNonexisting flag is set, parameters not present in the list will be added from the file; otherwise, such parameters will be ignored.		Loads parameters from a [[Technical Reference:Parameter File\|BCI2000 Parameter File]] specified in the first argument. For parameters already present in the list, their values are updated from the file. If the importNonexisting flag is set, parameters not present in the list will be added from the file; otherwise, such parameters will be ignored. Parameters from the "System" section will always be ignored.

	====Sort()====		====Sort()====
	Sorts the list according to their associated sorting hints. Smaller sorting hints will be located closer to the top of the list.		Sorts the list according to their associated sorting hints. Smaller sorting hints will be located closer to the top of the list.

Mellinger: /* Properties */

2010-06-29T14:58:11Z

Properties

← Older revision		Revision as of 14:58, 29 June 2010
Line 22:		Line 22:

	===Properties===		===Properties===
			This section gives a formal description of a <tt>Param</tt> object's set of properties. For a full discussion of parameters and their properties, see the [[Technical Reference:Parameter Definition\|BCI2000 Parameter Definition]] page.
			====HierarchicalLabel Sections (rw)====
			The parameter's hierarchy of sections, wrapped into a <tt>HierarchicalLabel</tt> object.
			====string Section (rw)====
			The parameter's top level section, corresponding to tabs in the operator's parameter configuration dialog.
			====string Type (rw)====
			The parameter's type.
			====string Name (r)====
			The parameter's name. This property is read-only to ensure consistency with the parameter's name index in a <tt>ParamList</tt> object.
			====string DefaultValue (rw)====
			The parameter's default value.
			====string LowRange (rw)====
			The lower bound on parameter values.
			====string HighRange (rw)====
			The upper bound on parameter values.
			====string Comment (rw)====
			The parameter's comment.
			====bool Changed (r)====
			The parameter's changed flag is set to true when the parameter is modified. The flag may be reset to false by using the its '''Unchanged()''' method.
			====int NumValues (rw)====
			For list-valued parameters, the number of entries in the list.
			====int NumRows (rw)====
			For matrix-valued parameters, the number of rows in the matrix.
			====int NumColumns (rw)====
			For matrix-valued parameters, the number of columns in the matrix.
			====ParamValue Value( index = 0 ), ParamValue Value( row, col ) (rw)====
			The parameter's values, indexed by either numeric indices, or strings representing labels.
			A <tt>ParamValue</tt> object may either contain a string to represent an individual value, or a <tt>Param</tt> object to represent a sub-parameter (in case of nested parameters).
			====LabelIndex Labels (rw)====
			For a list-valued parameter, the associated labels as a <tt>LabelIndex</tt> object.
			====LabelIndex RowLabels (rw)====
			For a matrix-valued parameter, its row labels as a <tt>LabelIndex</tt> object.
			====LabelIndex ColumnLabels (rw)====
			For a matrix-valued parameter, its column labels as a <tt>LabelIndex</tt> object.

	==ParamList Class==		==ParamList Class==

Mellinger: /* Param operator=( Param )= */

2010-06-29T14:37:48Z

Param operator=( Param )=

← Older revision		Revision as of 14:37, 29 June 2010
Line 7:		Line 7:
	====Param( string paramDefinition )====		====Param( string paramDefinition )====
	Constructs a <tt>Param</tt> object from a [[Technical Reference:Parameter Definition\|BCI2000 Parameter Definition]] string.		Constructs a <tt>Param</tt> object from a [[Technical Reference:Parameter Definition\|BCI2000 Parameter Definition]] string.
	====Param operator=( Param )=====		====Param operator=( Param )====
	Assigns from the given <tt>Param</tt> object.		Assigns from the given <tt>Param</tt> object.

	====Param AssignValues( Param )====		====Param AssignValues( Param )====
	Assigns the matrix of parameter values from the given <tt>Param</tt> object.		Assigns the matrix of parameter values from the given <tt>Param</tt> object.

← Older revision		Revision as of 15:30, 28 April 2011
Line 94:		Line 94:

	==See also==		==See also==
	[[Technical Reference:Parameter Definition]]		[[Technical Reference:Parameter Definition]], [[Programming Reference:Accessing Parameters and States]]

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