Difference between revisions of "AxisSet class"
(Created page with "{{CGscriptClass_Template |Name=<nowiki>AxisSet</nowiki> |Description=<nowiki>Represents aall axis in a data cache specification.</nowiki> |Constructors= {{CGscriptConstructors...") |
|||
| Line 2: | Line 2: | ||
|Name=<nowiki>AxisSet</nowiki> | |Name=<nowiki>AxisSet</nowiki> | ||
|Description=<nowiki>Represents aall axis in a data cache specification.</nowiki> | |Description=<nowiki>Represents aall axis in a data cache specification.</nowiki> | ||
| − | |Constructors= | + | |InheritsFrom=object|Constructors= |
{{CGscriptConstructors_Template|Description=<nowiki>Load axisset for current dcs</nowiki>}} | {{CGscriptConstructors_Template|Description=<nowiki>Load axisset for current dcs</nowiki>}} | ||
|Methods= | |Methods= | ||
| Line 16: | Line 16: | ||
|Description=<nowiki>Return true if an axis of the name exists</nowiki>}} | |Description=<nowiki>Return true if an axis of the name exists</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Clear</nowiki>|Description=<nowiki>Remove all axis and groups from the set</nowiki>}} | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Clear</nowiki>|Description=<nowiki>Remove all axis and groups from the set</nowiki>}} | ||
| − | {{CGscriptMethods_Template|ReturnType= | + | {{CGscriptMethods_Template|ReturnType=object|Name=<nowiki>this[] { get; }</nowiki>|Parameters= |
{{CGscriptParameters_Template|Type=int|Name=<nowiki>axisIndex</nowiki>|Description=<nowiki>Index of axis.</nowiki>}} | {{CGscriptParameters_Template|Type=int|Name=<nowiki>axisIndex</nowiki>|Description=<nowiki>Index of axis.</nowiki>}} | ||
|Description=<nowiki>Get an axis based on index.</nowiki>}} | |Description=<nowiki>Get an axis based on index.</nowiki>}} | ||
| Line 34: | Line 34: | ||
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Reset</nowiki>|Description=<nowiki>Reset axisset to last saved axisset</nowiki>}} | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Reset</nowiki>|Description=<nowiki>Reset axisset to last saved axisset</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the DCS, which saves the axisset also</nowiki>}} | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the DCS, which saves the axisset also</nowiki>}} | ||
| − | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}} | + | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}} |
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>UpdateAxis</nowiki>|Parameters= | {{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>UpdateAxis</nowiki>|Parameters= | ||
{{CGscriptParameters_Template|Type=Axis|Name=<nowiki>axis</nowiki>|Description=<nowiki>Axis to update</nowiki>}} | {{CGscriptParameters_Template|Type=Axis|Name=<nowiki>axis</nowiki>|Description=<nowiki>Axis to update</nowiki>}} | ||
| Line 42: | Line 42: | ||
{{CGscriptProperties_Template|ReturnType=Array of AxisGroup|Name=<nowiki>Groups</nowiki>|HasGetter=1|Description=<nowiki>Get the groups of the set</nowiki>}} | {{CGscriptProperties_Template|ReturnType=Array of AxisGroup|Name=<nowiki>Groups</nowiki>|HasGetter=1|Description=<nowiki>Get the groups of the set</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | ||
| − | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} |
|StaticMethods= | |StaticMethods= | ||
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>AxisSet_addAxis</nowiki>|Parameters= | {{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>AxisSet_addAxis</nowiki>|Parameters= | ||
Latest revision as of 08:38, 2 July 2020
AxisSet
Represents aall axis in a data cache specification.
Parent class
Inherits from object
Constructors
- () - Load axisset for current dcs
Methods
- bool AddAxis(Axis axis "Axis to add") - Add axis to set
- Empty AddGroup(AxisGroup groups "Group to add") - Add a group
- Empty AutoFix() - Remove all invalid axis from set
- bool AxisExists(string name "Name of axis to find") - Return true if an axis of the name exists
- Empty Clear() - Remove all axis and groups from the set
- object this[] { get; }(int axisIndex "Index of axis.") - Get an axis based on index.
- object this[] { get; }(string axisName "The axis name to lookup.") - Get an item based on a axis name.
- Axis GetAxis(string name "Name of axis to find") - Get axis by name
- Array of string GetAxisNames() - Get all axis names
- bool RemoveAxis(string name "Name of axis to remove") - Remove axis from set
- Empty RemoveGroup(AxisGroup groups "Group to remove") - Remove a group
- Empty Reset() - Reset axisset to last saved axisset
- Empty Save() - Save the DCS, which saves the axisset also
- (From object) string ToString() - The string representation of the object.
- bool UpdateAxis(Axis axis "Axis to update") - Add axis to update
Properties
- int Count { get; } - Returns the number of axes in the set
- Array of AxisGroup Groups { get; } - Get the groups of the set
- string ObjectTypeName { get; } - The name of the type of object.
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
Static Methods
- bool AxisSet_addAxis(Axis axis "Axis to add") - Add axis to set
- Empty AxisSet_autoFix() - Remove all invalid axis from set
- bool AxisSet_axisExists(string name "Name of axis to find") - Return true if an axis of the name exists
- Empty AxisSet_clear() - Remove all axis from the set
- int AxisSet_count() - Returns the number of axes in the set
- Axis AxisSet_getAxis(string name "Name of axis to find") - Get axis by name
- Array of string AxisSet_getAxisNames() - Get all axis names
- bool AxisSet_removeAxis(string name "Name of axis to remove") - Remove axis from set
- Empty AxisSet_reset() - Reset axisset to last saved axisset
- Empty AxisSet_save() - Save the DCS, which saves the axisset also
- bool AxisSet_updateAxis(Axis axis "Axis to update") - Add axis to update
