All Frameworks  Object Hierarchy  This Framework  Indexes

Sampleds (Collection)

The collection of all the Sampled objects currently contained in the current document.
A Sampled object is the base type for Track objects.

Method Index

AddFromSel
Creates a new Sampled from the selection and adds it to the Sampleds collection.
Add
Creates a new Sampled object and adds it to the Sampleds collection.
Item
Returns a CATIASampled object using its index from the CATIASampled collection.
Remove
Removes a CATIASampled object from the CATIASampled collection.

Methods


o Func AddFromSel() As
Creates a new Sampled from the selection and adds it to the Sampleds collection.
Returns:
The created Sampled
Example:
The following example creates a Sampled (called newSampled) with in the Sampleds collection. 
 Set newSampled = Sampleds.Add
o Func Add() As
Creates a new Sampled object and adds it to the Sampleds collection.
Returns:
The created Sampled
Example:
The following example creates a Sampled (called newSampled) with in the Sampleds collection. 
 Set newSampled = Sampleds.Add
o Func Item( iIndex) As
Returns a CATIASampled object using its index from the CATIASampled collection.
Parameters:
iIndex
The index of the sampled to retrieve from the collection of sampleds. Numerically, the index value corresponds to the rank of the sampled in the collection (ie. the first is 1, second is 2, ...).
Returns:
The retrieved Sampled
Example:
The following example retrieves the second Sampled from the Sampleds collection of the active document. 
 Dim newSampled as Sampled
 Set newSampled = Sampleds.Item (2)
o Sub Remove( iIndex)
Removes a CATIASampled object from the CATIASampled collection.
Parameters:
iIndex
The index of the sampled to remove from the collection of sampleds. Numerically, the index value corresponds to the rank of the sampled in the collection (ie. the first is 1, second is 2, ...).
Example:
The following example removes the third Sampled from the Sampleds collection of the active document. 
 Sampleds.Remove (3)

Copyright © 2003, Dassault Systèmes. All rights reserved.