All Frameworks  Class Hierarchy  This Framework  Next  Indexes

FittingInterfaces Interface CATISampled

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

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


interface CATISampled

Definition of the CATISampled object.
Role: The Sampled class defines characteristics for simulatable tasks within DMU Fitting. CATISampled is the parent class for tracks and color actions. Key samples are recorded (as shots or CATIShots) for an object and then during simulation the object is interpolated with these samples.


Method Index


o AddAnalysis(CATBaseUnknown*,int,int)
Add (bind) an analysis object to the current sampled.
o AddShot(CATIShot*,CatFitSampledRecordMode,int)
Adds a shot to the sampled.
o AppendSampled(CATISampled*)
Appends the shots of a sampled to the current sampled.
o CreateShot(CATIShot*&,char*)
Create a new shot in the sampled.
o GetAnalysis(int&,CATBaseUnknown**&,int*&,int*&)
Returns the analyses objects bound to a Track.
o GetAnalysisStatus(unsigned int&,unsigned int&,unsigned int&,unsigned int&)
Returns the analyses settings for a Track.
o GetExistingInterpolaters(CATListOfCATString&)
Retrieves a list of the existing interpolators.
o GetIndice(CATIShot*,int&)
Retrieves the index of a shot.
o GetInterpolater(CATIInterpolater*&)
Retrieves the Sampled's interpolater.
o GetInterpolater(CATString&)
Retrieves the Sampled's interpolater.
o GetName(CATUnicodeString&)
Retrieves the name of the sampled.
o GetNbShots(int&)
Retrieves the number of shots.
o GetObject(CATBaseUnknown*&)
Retrieves the object for a sampled.
o GetScaling(double&)
Retrieves the scaling value associated to the sampled.
o GetShot(int,CATIShot*&)
Retrieves a specific shot.
o GetTime(double&)
Retrieves internal time of the sampled.
o GetType(CATString&)
Retrieve the type of the sampled.
o IsAuthorized(CATBaseUnknown*)
Check to see if it is possible to simulate an object.
o PlayTime(double)
Set the internal time of the sampled.
o RemoveAllAnalysis()
Removes all the analysis objects from the sampled.
o RemoveAllShots()
Removes all shots.
o RemoveAnalysis(CATBaseUnknown*)
Removes a specified analysis object from the sampled.
o RemoveAnalysis(int)
Removes a specified analysis object from the sampled.
o RemoveShot(CATIShot*)
Removes a shot.
o RemoveShot(int)
Removes a shot.
o ReorderShot(int,int)
Changes the order of two shots.
o Reverse()
Reverse shots contained in the sampled.
o SetAnalysisStatus(unsigned int,unsigned int,unsigned int,unsigned int)
Set the analyses settings for a sampled based object.
o SetInterpolater(CATString&)
Sets the Sampled's interpolater.
o SetName(CATUnicodeString)
Sets the name of the sampled.
o SetObject(CATBaseUnknown*,boolean)
Assign an Object for the sampled.
o SetScaling(double)
Stores the scaling value associated to the sampled.
o SetTime(double)
Set the internal time of the sampled.

Methods


o AddAnalysis
public virtual HRESULT AddAnalysis(CATBaseUnknown* iAnalysis,
int iAnalysisMode=2,
int iMonitorMode=0) =0
Add (bind) an analysis object to the current sampled. Role: Adds an analysis object (such as clash, distance) to the current sampled object. During simulation this analysis object is then evaluated at each step.
Parameters:
iAnalysis
The analysis to add (bind) to a Track
iAnalysisMode
Indicates the analysis status for iAnalysis
  • 0 for Off
  • 1 for On
  • 2 for Stop
  • 3 for Verbose
iMonitorMode
Indicates the monitor status for iAnalysis
  • 0 for Off
  • 1 for On
Returns:

Legal values:
S_OK : on Success
E_FAIL: on failure
o AddShot
public virtual HRESULT AddShot(CATIShot* iShot,
CatFitSampledRecordMode iMode=CatFitSampledAppend,
int iIndice=0) =0
Adds a shot to the sampled. Role Adds an already existing shot to the sampled.
Parameters:
iShot
A valid pointer to an already existing shot.
iMode
Recommended values
  • CatFitSampledAppend
    Used to add the shot at the end of the list of shots
  • CatFitSampledInsertAfter
    Used to add the shot after the supplied index
iIndice
Index of where to add the shot
Returns:

Legal values:
S_OK : on Success, iShot has been added correctly
E_FAIL: on failure
o AppendSampled
public virtual HRESULT AppendSampled(CATISampled* iSampled) =0
Appends the shots of a sampled to the current sampled. Role: Appends the shots of a specified sampled to the current sampled. Note that both the current sampled object and the specified sampled object (iSampled) need to be simulating the same item, otherwise E_FAIL is returned.
Parameters:
iSampled
A valid pointer to a sampled based object.
Returns:

Legal values:
S_OK : on Success, the shots have been appended.
E_FAIL: on failure
o CreateShot
public virtual HRESULT CreateShot(CATIShot*& oNewShot,
const char* iType=NULL) =0
Create a new shot in the sampled. Role: Creates a new shot within the sampled object. The created shot will be empty, that is it has no data assigned to it (numerical data needs to be assigned once the shot is created). Also, if other shots exist, then this shot will be added to the end of the set of shots.
Parameters:
oNewShot
The newly created shot.
iType
the type of shot to create
Returns:

Legal values:
S_OK : on Success, oNewShot has been created correctly
E_FAIL: on failure
o GetAnalysis
public virtual HRESULT GetAnalysis(int& oNb,
CATBaseUnknown**& oAnalysis,
int*& oState,
int*& oMonitor) =0
Returns the analyses objects bound to a Track.
Parameters:
oNb
The number of analyses bound to a Track
oAnalysis
A list of analyses bound to a Track
oState
A list of the analysis status for each analysis object - Off (0), On (1), Stop (2), Verbose (3)
oMonitor
A list of the monitor status for each analysis object - Off (0) or On (1)
Returns:

Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAnalysisStatus
public virtual HRESULT GetAnalysisStatus(unsigned int& oActivated,
unsigned int& oState,
unsigned int& oVerbose,
unsigned int& oMonitor) =0
Returns the analyses settings for a Track.
Parameters:
oActivated
Indicates whether the analyses are On or Off
oState
With oVerbose, indicates the state (On, Off, Stop, Verbose)
oVerbose
With oState, indicates the state (On, Off, Stop, Verbose)
oMonitor
Indicates whether the monitor is On or Off
Returns:

Legal values:
S_OK : on Success
E_FAIL: on failure
o GetExistingInterpolaters
public virtual HRESULT GetExistingInterpolaters(CATListOfCATString& oList) =0
Retrieves a list of the existing interpolators. Role: Get the list of interpolators that are available to the sampled.
Parameters:
oList
A list containing strings of all available interpolators
Returns:

Legal values:
S_OK : on Success
E_FAIL: on failure
o GetIndice
public virtual HRESULT GetIndice(CATIShot* iShot,
int& oIndice) =0
Retrieves the index of a shot. Role: Retrieves the index associated to a specifed shot, that is contained within the current sampled object.
Parameters:
iShot
A shot that is contained within the current sampled.
oIndice
The returned index of the shot
Returns:

Legal values:
S_OK : on Success, a valid index is returned
E_FAIL: on failure
o GetInterpolater
public virtual HRESULT GetInterpolater(CATIInterpolater*& oInterpolater) =0
Retrieves the Sampled's interpolater. Role: Retrieves the interpolator used by the sampled during simulation.
Parameters:
oInterpolater
A pointer to the interpolater used
Returns:

Legal values:
S_OK : on Success
E_FAIL: on failure
o GetInterpolater
public virtual HRESULT GetInterpolater(CATString& oName) =0
Retrieves the Sampled's interpolater. Role: Retrieves the interpolator used by the sampled during simulation.
Parameters:
oName
A string containing the name of the interpolater used.
Returns:

Legal values:
S_OK : on Success
E_FAIL: on failure
o GetName
public virtual HRESULT GetName(CATUnicodeString& oName)= 0
Retrieves the name of the sampled. Role: Retrieves the name of the sampled.
Parameters:
oName
The returned name of the sampled.
Returns:

Legal values:
S_OK : on Success
E_FAIL: on failure
o GetNbShots
public virtual HRESULT GetNbShots(int& oNb) =0
Retrieves the number of shots. Role: Retrieves the number of shots contained within the current sampled object.
Parameters:
oNb
An integer containing the number of shots.
Returns:

Legal values:
S_OK : on Success
E_FAIL: on failure
o GetObject
public virtual HRESULT GetObject(CATBaseUnknown*& oObject) =0
Retrieves the object for a sampled. Role: Retrieves the object that is associated to a sampled.
Parameters:
oObject
A pointer to the object that is used by the sampled.
Returns:

Legal values:
S_OK : on Success
E_FAIL: on failure
o GetScaling
public virtual HRESULT GetScaling(double& oScaling) =0
Retrieves the scaling value associated to the sampled. Role: Used to alter the duration of a sampled based simulation. Initially the scaling is set to one, however if the scaling is changed to 0.5 the sampled take one half of its initial time. Likewise, a scaling of two will cause the duration to double.
Parameters:
oScaling
The currently set value of the sampled's scaling value.
Returns:

Legal values:
S_OK : on Success,
E_FAIL: on failure
o GetShot
public virtual HRESULT GetShot(int iShot,
CATIShot*& oShot) =0
Retrieves a specific shot. Role: Retrieves a specific shot from the current sampled object. The shot returned is based on the specified index, iShot.
Parameters:
iShot
An integer specifing the index of the shot to return
oShot
A pointer to a shot
Returns:

Legal values:
S_OK : on Success, a shot is returned
E_FAIL: on failure
o GetTime
public virtual HRESULT GetTime(double& oTime) =0
Retrieves internal time of the sampled. Role: Retrieves the internal time associated to the current sampled object. A sampled object is used for time based simulations, and oTime is the time that the current sampled object is at.
Parameters:
oTime
The current time of the sampled object.
Returns:

Legal values:
S_OK : on Success, a valid time is returned
E_FAIL: on failure
o GetType
public virtual HRESULT GetType(CATString& oType) =0
Retrieve the type of the sampled. Role: A Sampled is used on various types; this method returns the type of the sampled.
Parameters:
oType
The type of the string. For example 'Track' will be returned for track objects and 'Color' for Color Action objects
Returns:

Legal values:
S_OK : on Success
E_FAIL: on failure
o IsAuthorized
public virtual HRESULT IsAuthorized(CATBaseUnknown* iObject=NULL) =0
Check to see if it is possible to simulate an object. Role: Used to check if it is possible to create a sampled based simulation with the specified object.
Parameters:
iObject
The time to set the sampled to.
Returns:

Legal values:
S_OK : on Success,
E_FAIL: on failure
o PlayTime
public virtual HRESULT PlayTime(double iTime) =0
Set the internal time of the sampled. Role: Set the internal time associated to the current sampled object. Unlike SetTime, this method will also change the state of the model to the specified time.
Parameters:
iTime
The time to set the sampled to.
Returns:

Legal values:
S_OK : on Success, the time has been changed.
E_FAIL: on failure
o RemoveAllAnalysis
public virtual HRESULT RemoveAllAnalysis()=0
Removes all the analysis objects from the sampled. Role: Removes all the assigned objects from the sampled.
Returns:

Legal values:
S_OK : on Success; all analysis objects have been removed.
E_FAIL: on failure
o RemoveAllShots
public virtual HRESULT RemoveAllShots()=0
Removes all shots. Role: Removes all shot contained in the current sampled.
Returns:

Legal values:
S_OK : on Success, all the shots have been removed
E_FAIL: on failure
o RemoveAnalysis
public virtual HRESULT RemoveAnalysis(CATBaseUnknown* iAnalysis) =0
Removes a specified analysis object from the sampled. Role: Removes a specified analysis object that has been assigned to the current sampled object.
Parameters:
iAnalysis
A valid pointer to an analysis object that is assigned to the current sampled.
Returns:

Legal values:
S_OK : on Success; the analysis object has been removed.
E_FAIL: on failure
o RemoveAnalysis
public virtual HRESULT RemoveAnalysis(int iIndice) =0
Removes a specified analysis object from the sampled. Role: Removes a specified analysis object that has been assigned to the current sampled object.
Parameters:
iIndice
An index to the associated analysis object.
Returns:

Legal values:
S_OK : on Success; the analysis object has been removed.
E_FAIL: on failure
o RemoveShot
public virtual HRESULT RemoveShot(CATIShot* iShot) =0
Removes a shot. Role: Removes a shot contained in the current sampled.
Parameters:
iShot
A valid pointer to a shot to be removed.
Returns:

Legal values:
S_OK : on Success, iShot has removed
E_FAIL: on failure
o RemoveShot
public virtual HRESULT RemoveShot(int iIndice) =0
Removes a shot. Role: Removes a shot contained in the current sampled.
Parameters:
iIndice
A valid index to a shot to be removed.
Returns:

Legal values:
S_OK : on Success, the shot at iIndice has been removed
E_FAIL: on failure
o ReorderShot
public virtual HRESULT ReorderShot(int iIndex1,
int iIndex2) =0
Changes the order of two shots. Role: Changes the order of two shots specified by the values of iIndex1 and iIndex2. The two shots are swapped at those positions.
Parameters:
iIndex1
The first shot used to change positions.
iIndex2
The second shot used to change positions.
Returns:

Legal values:
S_OK : on Success, the shots have been reordered.
E_FAIL: on failure
o Reverse
public virtual HRESULT Reverse()=0
Reverse shots contained in the sampled. Role: The order of the shots associated to the current sampled object is reversed, and thus the resulting simulation is effectively backwards.
Returns:

Legal values:
S_OK : on Success, the shots have been reversed.
E_FAIL: on failure
o SetAnalysisStatus
public virtual HRESULT SetAnalysisStatus(unsigned int iActivated,
unsigned int iState,
unsigned int iVerbose,
unsigned int iMonitor) =0
Set the analyses settings for a sampled based object.
Parameters:
iActivated
Indicates whether the analyses are On or Off
iState
With iVerbose, indicates the state (On, Off, Stop, Verbose)
iVerbose
With iState, indicates the state (On, Off, Stop, Verbose)
iMonitor
Indicates whether the monitor is On or Off
Returns:

Legal values:
S_OK : on Success
E_FAIL: on failure
o SetInterpolater
public virtual HRESULT SetInterpolater(CATString& iName) =0
Sets the Sampled's interpolater. Role: Sets the interpolator used by the sampled during simulation.
Parameters:
oName
A string containing the name of the interpolater used.
Returns:

Legal values:
S_OK : on Success
E_FAIL: on failure
o SetName
public virtual HRESULT SetName(CATUnicodeString iName)= 0
Sets the name of the sampled. Role: Sets the name of the sampled.
Parameters:
iName
The new name to sets the sampled to.
Returns:

Legal values:
S_OK : on Success
E_FAIL: on failure
o SetObject
public virtual HRESULT SetObject(CATBaseUnknown* iObject,
boolean iKeepAbsoluteDefinition=FALSE) =0
Assign an Object for the sampled. Role: Sets the object that will be used in the sampled based simulation.
Parameters:
iObject
Pointer to object to be assigned
iKeepAbsoluteDefinition
Currently set to FALSE.
Returns:

Legal values:
S_OK : on Success
E_FAIL: on failure
o SetScaling
public virtual HRESULT SetScaling(double iScaling) =0
Stores the scaling value associated to the sampled. Role: Used to alter the duration of a sampled based simulation. Initially the scaling is set to one, however if the scaling is changed to 0.5 the sampled take one half of its initial time. Likewise, a scaling of two will cause the duration to double.
Parameters:
iScaling
The new scaling value to set the current sampled.
Returns:

Legal values:
S_OK : on Success,
E_FAIL: on failure
o SetTime
public virtual HRESULT SetTime(double iTime) =0
Set the internal time of the sampled. Role: Set the internal time associated to the current sampled object. A sampled object is used for time based simulations, and the internal time can be set by
Parameters:
iTime
The time to set the sampled to.
Returns:

Legal values:
S_OK : on Success, the time has been set
E_FAIL: on failure

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

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