All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

FittingInterfaces Interface CATISiShuttle

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATISiShuttle
 

Usage: you must use this class as is. You should never derive it.


interface CATISiShuttle

Definition of the CATISiShuttle object.
Role: The shuttle object is used to define a grouping of products. Once products have been placed in the shuttle then they can be moved all at once. Also the shuttle has a base location defined by the shuttle axis.


Method Index


o AddShuttleList(CATISiList_var)
Append a list to the shuttle.
o GetNumberOfShuttleAxises()
Retrieve the number of shuttle axises.
o GetNumberOfShuttleLists()
Retrieve the number shuttle lists.
o GetReferenceObject()
Returns the shuttle's reference object.
o GetShuttleAxis(CATMathTransformation&,int)
Retrieve shuttle axis information.
o GetShuttleList(int)
Retrieve a specific shuttle list.
o GetShuttleName()
Retrieve the name of the shuttle.
o RemoveShuttleAxis(int)
Remove a specific shuttle axis.
o RemoveShuttleList(int)
Removes a list from the shuttle.
o SetReferenceObject(CATIMovable_var)
Sets the shuttle's reference object.
o SetShuttleAxis(CATMathTransformation&,int,boolean)
Sets the shuttle axis information.
o SetShuttleList(CATISiList_var,int)
Stores a list to the shuttle.
o SetShuttleName(CATUnicodeString)
Set the name of the shuttle.

Methods


o AddShuttleList
public virtual void AddShuttleList(CATISiList_var iList) const=0
Append a list to the shuttle. Role: Appends a list of items to the shuttle.
Parameters:
iList
The list of items to append to the shuttle.
o GetNumberOfShuttleAxises
public virtual int GetNumberOfShuttleAxises()const=0
Retrieve the number of shuttle axises. Role: Retrieve the number of axises associated to the shuttle.
Returns:
The number of axises.
o GetNumberOfShuttleLists
public virtual int GetNumberOfShuttleLists()const=0
Retrieve the number shuttle lists. Role: Retrieve the number of lists of items associated to the shuttle.
Returns:
The number of lists.
o GetReferenceObject
public virtual CATIMovable_var GetReferenceObject()const=0
Returns the shuttle's reference object. Role: Returns the shuttle's reference object.
Returns:
The shuttle's reference object.
o GetShuttleAxis
public virtual void GetShuttleAxis(CATMathTransformation& oAxis,
int iInd=0) const=0
Retrieve shuttle axis information. Role: Retrieve information about the shuttle's axis position.
Parameters:
oAxis
The position of a shuttle axis.
iInd
Used to specify which shuttle axis to retrieve. Note that if no parameters are specified the first axis is used.
o GetShuttleList
public virtual CATISiList_var GetShuttleList(int iInd=0) const=0
Retrieve a specific shuttle list. Role: Retrieve a list of items from the current shuttle.
Parameters:
iInd
Used to specify a particular list from the shuttle. Note that if this is not specified then the first shuttle is returned.
Returns:
A list contained within the shuttle.
o GetShuttleName
public virtual CATUnicodeString GetShuttleName()const=0
Retrieve the name of the shuttle. Role: Used to retrieve the name of the shuttle object.
Returns:
The name of the shuttle.
o RemoveShuttleAxis
public virtual void RemoveShuttleAxis(int iInd) const=0
Remove a specific shuttle axis. Role: Used to remove a specific assigned shuttle axis.
Parameters:
iInd
Used to specify which shuttle axis to remove
o RemoveShuttleList
public virtual void RemoveShuttleList(int iInd) const=0
Removes a list from the shuttle. Role: Removes a list of items from the shuttle.
Parameters:
iInd
Index to specify the which list should be removed.
o SetReferenceObject
public virtual int SetReferenceObject(CATIMovable_var iRef) const=0
Sets the shuttle's reference object. Role: Sets the shuttle's reference object.
Parameters:
iRef
A movable object to be assigned as the reference object.
Returns:
0 : OK
1 : The Set operation failed. It can be the result of a cross reference.
o SetShuttleAxis
public virtual void SetShuttleAxis( const CATMathTransformation& iAxis,
int iInd=-1,
boolean iTrans=FALSE) const=0
Sets the shuttle axis information. Role: Sets positional information about the shuttle's axis.
Parameters:
iAxis
The position of a shuttle axis.
iInd
Used to specify which shuttle axis to set. Note that if no parameters are specified the default behavior is to set it as the\ first shuttle axis.
iTrans
Used to specify if to use transient move or not. It is recommended to use the default of FALSE.
o SetShuttleList
public virtual void SetShuttleList(CATISiList_var iList,
int iInd=-1) const=0
Stores a list to the shuttle. Role: Stores a list of items to the shuttle.
Parameters:
iList
The list of items to store in the shuttle.
iInd
Index to specify the position of where the list should be stored. If this parameter is not provided, then iList is added to the end.
o SetShuttleName
public virtual void SetShuttleName(CATUnicodeString iName) const=0
Set the name of the shuttle. Role: Used to set the name of the shuttle object.
Parameters:
iName
The new name to set the to the shuttle.

This object is included in the file: CATISiShuttle.h
If needed, your Imakefile.mk should include the module: CATFittingInterfaces

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