All Frameworks Class Hierarchy This Framework Previous Next Indexes
SimulationInterfaces Interface CATIReplayChannelScalarObserver
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---SimulationInterfaces.CATIReplayChannel
|
+---CATIReplayChannelScalarObserver
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIReplayChannelScalarObserver
Edit a channel scalar observer.
A scalar observer channel describes the evolution of one scalar over time.
It is made of samples : each sample contains the value of the scalar at a given time.
Method Index
- o
AddSample(double,double)
- Add a sample to the channel.
- o
GetName(char**)
- Get the name of the scalar value.
- o
GetSample(int,double*)
- Read the value of one sample of the channel.
- o
RemoveSample(int)
- Remove one sample of the channel.
Methods
o AddSample
public virtual HRESULT AddSample( | double | iTime, |
| double | iValue) const=0 |
-
Add a sample to the channel.
- Parameters:
-
- iTime
- Time of the sample. This time must be greater or equal to 0.
- iValue
- Value of the scalar at the time of the sample.
- Returns:
- HRESULT
o GetName
public virtual HRESULT GetName( | char** | oName) const=0 |
-
Get the name of the scalar value.
- Parameters:
-
- oName
- The name.
- Returns:
- HRESULT
o GetSample
public virtual HRESULT GetSample( | int | iIndex, |
| double* | oValue) const=0 |
-
Read the value of one sample of the channel.
- Parameters:
-
- iIndex
- The index of the sample. This index must be greater or equal to 1 and lower or equal to the number of samples.
- oValue
- Value of the scalar at the time of the sample.
- Returns:
- HRESULT
o RemoveSample
public virtual HRESULT RemoveSample( | int | iIndex) const=0 |
-
Remove one sample of the channel.
- Parameters:
-
- iIndex
- The index of the sample. This index must be greater or equal to 1 and lower or equal to the number of samples.
- Returns:
- HRESULT
This object is included in the file: CATIReplayChannelScalarObserver.h
If needed, your Imakefile.mk should include the module: CATSimulationInterfaces