Difference between revisions of "CATable::Subscript"

(Marked this version for translation)
 
Line 3: Line 3:
 
<languages />
 
<languages />
 
<translate>
 
<translate>
= Subscript(indexObj, label) =
+
= Subscript(indexObj, label) = <!--T:1-->
  
 +
<!--T:2-->
 
Returns a slice of a table for which index «indexObj» is equal to «label». It returns a new [[CATable]] object with one fewer dimension than the original table. When used on a [[DefTable]], the sliced [[DefTable]] acts as a [[SubTable]], changing elements in the slice of the original table.
 
Returns a slice of a table for which index «indexObj» is equal to «label». It returns a new [[CATable]] object with one fewer dimension than the original table. When used on a [[DefTable]], the sliced [[DefTable]] acts as a [[SubTable]], changing elements in the slice of the original table.
  
= Parameters =
+
= Parameters = <!--T:3-->
  
 +
<!--T:4-->
 
;indexObj: CAObject
 
;indexObj: CAObject
 
;label: variant – the label in the index
 
;label: variant – the label in the index
  
=Return value =
+
=Return value = <!--T:5-->
  
 +
<!--T:6-->
 
[[CATable]]
 
[[CATable]]
  
= Example Usage =
+
= Example Usage = <!--T:7-->
  
  CATable tab = obj.[[CAEngine::ResultTable|ResultTable]];
+
  <!--T:8-->
 +
CATable tab = obj.[[CAEngine::ResultTable|ResultTable]];
 
  CAIndex in1 = tab.[[CATable::GetIndexObject|GetIndexObject]]("In1");
 
  CAIndex in1 = tab.[[CATable::GetIndexObject|GetIndexObject]]("In1");
 
  CATable subTab = obj.Subscript(in1,"January")
 
  CATable subTab = obj.Subscript(in1,"January")
  
= Remarks =
+
= Remarks = <!--T:9-->
  
 +
<!--T:10-->
 
The use of [[CATable::Subscript]](..) on a DefTable, acting as a [[SubTable]], was introduced in 4.2.3.
 
The use of [[CATable::Subscript]](..) on a DefTable, acting as a [[SubTable]], was introduced in 4.2.3.
  
 +
<!--T:11-->
 
When applied to a 1-D table, a 0-D table result, which is a non-array containing only one [[CATable::AtomicValue|atomic value]].  At that point, the [[CATable::AtomicValue]] method is used to access the value.
 
When applied to a 1-D table, a 0-D table result, which is a non-array containing only one [[CATable::AtomicValue|atomic value]].  At that point, the [[CATable::AtomicValue]] method is used to access the value.
  
= See Also =
+
= See Also = <!--T:12-->
  
 +
<!--T:13-->
 
* [[CATable::Slice]]
 
* [[CATable::Slice]]
 
* [[CATable::AtomicValue]]
 
* [[CATable::AtomicValue]]
 
</translate>
 
</translate>

Latest revision as of 01:15, 16 June 2015

ADE User Guide > ADE Server Class Reference > CATable

Other languages:
English • ‎中文

Subscript(indexObj, label)

Returns a slice of a table for which index «indexObj» is equal to «label». It returns a new CATable object with one fewer dimension than the original table. When used on a DefTable, the sliced DefTable acts as a SubTable, changing elements in the slice of the original table.

Parameters

indexObj
CAObject
label
variant – the label in the index

Return value

CATable

Example Usage

CATable tab = obj.ResultTable;
CAIndex in1 = tab.GetIndexObject("In1");
CATable subTab = obj.Subscript(in1,"January")

Remarks

The use of CATable::Subscript(..) on a DefTable, acting as a SubTable, was introduced in 4.2.3.

When applied to a 1-D table, a 0-D table result, which is a non-array containing only one atomic value. At that point, the CATable::AtomicValue method is used to access the value.

See Also

Comments


You are not allowed to post comments.