All Frameworks Class Hierarchy This Framework Indexes
DNBSimulationInterfaces Interface DNBISimSimTraceSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface DNBISimSimTraceSettingAtt
Interface to handle parameters of Infrastructure-DELMIA Infrastructure-Simulation Trace Tools Options Tab page.
Role: This interface is implemented by a component which
represents the controller of Simulation Trace Tools Options parameter settings.
- Methods to set value of each parameter xxx
- Methods to get value of each parameter xxx
- Methods to get information on each parameter xxx
- Methods to lock/unlock value of each parameter xxx
Here is the list of parameters to use and their meaning:
- TracePointVisu: defines the option for displaying the points within a simulation trace.
- TracePointColor: defines the color to be used if displaying points within a simulation trace.
- TracePointSymbol: defines the symbol to be used if displaying points within a simulation trace.
- TraceLineVisu: defines the option for displaying the lines within a simulation trace.
- TraceLineColor: defines the color to be used if displaying lines within a simulation trace.
- TraceLineType: defines the line type to be used if displaying lines within a simulation trace.
- TraceLineThick: defines the thickness to be used if displaying lines within a simulation trace.
- TraceAxisVisu: defines the option for displaying the axis within a simulation trace.
- TraceAxisColor: defines the color to be used if displaying axis within a simulation trace.
- TraceAxisType: defines the line type to be used if displaying axis within a simulation trace.
- TraceAxisThick: defines the thickness to be used if displaying axis within a simulation trace.
- TraceDeletePath: defines the option for deleting the simulation trace when a new simulation is run.
- TraceLegend: defines the type of information to be displayed when a point/line/axis within a simulation trace is (pre)selected by the user.
The values are in order:
- All Legend (not used).
- Name.
- X.
- Y.
- Z.
- Yaw.
- Pitch.
- Roll.
- Cycle Time.
- Show Legend.
- Always Visible (not used).
Method Index
- o
GetTraceAxisColorInfo(CATSettingInfo*)
- Retrieves the state of the TraceAxisColor parameter.
- o
GetTraceAxisColor(unsigned int*,CATLONG32,CATLONG32*)
- Retrieves the TraceAxisColor attribute.
- o
GetTraceAxisThickInfo(CATSettingInfo*)
- Retrieves the state of the TraceAxisThick parameter.
- o
GetTraceAxisThick(unsigned int&)
- Retrieves the TraceAxisThick attribute.
- o
GetTraceAxisTypeInfo(CATSettingInfo*)
- Retrieves the state of the TraceAxisType parameter.
- o
GetTraceAxisType(unsigned int&)
- Retrieves the TraceAxisType attribute.
- o
GetTraceAxisVisuInfo(CATSettingInfo*)
- Retrieves the state of the TraceAxisVisu parameter.
- o
GetTraceAxisVisu(CATBoolean&)
- Retrieves the TraceAxisVisu attribute.
- o
GetTraceDeletePathInfo(CATSettingInfo*)
- Retrieves the state of the TraceDeletePath parameter.
- o
GetTraceDeletePath(CATBoolean&)
- Retrieves the TraceDeletePath attribute.
- o
GetTraceLegendInfo(CATSettingInfo*)
- Retrieves the state of the TraceLegend parameter.
- o
GetTraceLegend(unsigned int*,CATLONG32,CATLONG32*)
- Retrieves the TraceLegend attribute.
- o
GetTraceLineColorInfo(CATSettingInfo*)
- Retrieves the state of the TraceLineColor parameter.
- o
GetTraceLineColor(unsigned int*,CATLONG32,CATLONG32*)
- Retrieves the TraceLineColor attribute.
- o
GetTraceLineThickInfo(CATSettingInfo*)
- Retrieves the state of the TraceLineThick parameter.
- o
GetTraceLineThick(unsigned int&)
- Retrieves the TraceLineThick attribute.
- o
GetTraceLineTypeInfo(CATSettingInfo*)
- Retrieves the state of the TraceLineType parameter.
- o
GetTraceLineType(unsigned int&)
- Retrieves the TraceLineType attribute.
- o
GetTraceLineVisuInfo(CATSettingInfo*)
- Retrieves the state of the TraceLineVisu parameter.
- o
GetTraceLineVisu(CATBoolean&)
- Retrieves the TraceLineVisu attribute.
- o
GetTracePointColorInfo(CATSettingInfo*)
- Retrieves the state of the TracePointColor parameter.
- o
GetTracePointColor(unsigned int*,CATLONG32,CATLONG32*)
- Retrieves the TracePointColor attribute.
- o
GetTracePointSymbolInfo(CATSettingInfo*)
- Retrieves the state of the TracePointSymbol parameter.
- o
GetTracePointSymbol(unsigned int&)
- Retrieves the TracePointSymbol attribute.
- o
GetTracePointVisuInfo(CATSettingInfo*)
- Retrieves the state of the TracePointVisu parameter.
- o
GetTracePointVisu(CATBoolean&)
- Retrieves the TracePointVisu attribute.
- o
SetTraceAxisColorLock(unsigned char)
- Locks or unlocks the TraceAxisColor parameter.
- o
SetTraceAxisColor(unsigned int*,CATLONG32)
- Sets the TraceAxisColor attribute.
- o
SetTraceAxisThickLock(unsigned char)
- Locks or unlocks the TraceAxisThick parameter.
- o
SetTraceAxisThick(unsigned int)
- Sets the TraceAxisThick attribute.
- o
SetTraceAxisTypeLock(unsigned char)
- Locks or unlocks the TraceAxisType parameter.
- o
SetTraceAxisType(unsigned int)
- Sets the TraceAxisType attribute.
- o
SetTraceAxisVisuLock(unsigned char)
- Locks or unlocks the TraceAxisVisu parameter.
- o
SetTraceAxisVisu(CATBoolean)
- Sets the TraceAxisVisu attribute.
- o
SetTraceDeletePathLock(unsigned char)
- Locks or unlocks the TraceDeletePath parameter.
- o
SetTraceDeletePath(CATBoolean)
- Sets the TraceDeletePath attribute.
- o
SetTraceLegendLock(unsigned char)
- Locks or unlocks the TraceLegend parameter.
- o
SetTraceLegend(unsigned int*,CATLONG32)
- Sets the TraceLegend attribute.
- o
SetTraceLineColorLock(unsigned char)
- Locks or unlocks the TraceLineColor parameter.
- o
SetTraceLineColor(unsigned int*,CATLONG32)
- Sets the TraceLineColor attribute.
- o
SetTraceLineThickLock(unsigned char)
- Locks or unlocks the TraceLineThick parameter.
- o
SetTraceLineThick(unsigned int)
- Sets the TraceLineThick attribute.
- o
SetTraceLineTypeLock(unsigned char)
- Locks or unlocks the TraceLineType parameter.
- o
SetTraceLineType(unsigned int)
- Sets the TraceLineType attribute.
- o
SetTraceLineVisuLock(unsigned char)
- Locks or unlocks the TraceLineVisu parameter.
- o
SetTraceLineVisu(CATBoolean)
- Sets the TraceLineVisu attribute.
- o
SetTracePointColorLock(unsigned char)
- Locks or unlocks the TracePointColor parameter.
- o
SetTracePointColor(unsigned int*,CATLONG32)
- Sets the TracePointColor attribute.
- o
SetTracePointSymbolLock(unsigned char)
- Locks or unlocks the TracePointSymbol parameter.
- o
SetTracePointSymbol(unsigned int)
- Sets the TracePointSymbol attribute.
- o
SetTracePointVisuLock(unsigned char)
- Locks or unlocks the TracePointVisu parameter.
- o
SetTracePointVisu(CATBoolean)
- Sets the TracePointVisu attribute.
Methods
o GetTraceAxisColorInfo
| public virtual GetTraceAxisColorInfo( | | oInfo) |
-
Retrieves the state of the TraceAxisColor parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTraceAxisColor
| public virtual GetTraceAxisColor( | | ioColor, |
| | iMaxLength, |
| | oReadLength | =NULL ) |
-
Retrieves the TraceAxisColor attribute.
o GetTraceAxisThickInfo
| public virtual GetTraceAxisThickInfo( | | oInfo) |
-
Retrieves the state of the TraceAxisThick parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTraceAxisThick
| public virtual GetTraceAxisThick( | | ioThick) |
-
Retrieves the TraceAxisThick attribute.
o GetTraceAxisTypeInfo
| public virtual GetTraceAxisTypeInfo( | | oInfo) |
-
Retrieves the state of the TraceAxisType parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTraceAxisType
| public virtual GetTraceAxisType( | | ioType) |
-
Retrieves the TraceAxisType attribute.
o GetTraceAxisVisuInfo
| public virtual GetTraceAxisVisuInfo( | | oInfo) |
-
Retrieves the state of the TraceAxisVisu parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTraceAxisVisu
| public virtual GetTraceAxisVisu( | | ioVisu) |
-
Retrieves the TraceAxisVisu attribute.
o GetTraceDeletePathInfo
| public virtual GetTraceDeletePathInfo( | | oInfo) |
-
Retrieves the state of the TraceDeletePath parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTraceDeletePath
| public virtual GetTraceDeletePath( | | ioDelete) |
-
Retrieves the TraceDeletePath attribute.
o GetTraceLegendInfo
| public virtual GetTraceLegendInfo( | | oInfo) |
-
Retrieves the state of the TraceLegend parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTraceLegend
| public virtual GetTraceLegend( | | ioLegend, |
| | iMaxLength, |
| | oReadLength | =NULL ) |
-
Retrieves the TraceLegend attribute.
o GetTraceLineColorInfo
| public virtual GetTraceLineColorInfo( | | oInfo) |
-
Retrieves the state of the TraceLineColor parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTraceLineColor
| public virtual GetTraceLineColor( | | ioColor, |
| | iMaxLength, |
| | oReadLength | =NULL ) |
-
Retrieves the TraceLineColor attribute.
o GetTraceLineThickInfo
| public virtual GetTraceLineThickInfo( | | oInfo) |
-
Retrieves the state of the TraceLineThick parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTraceLineThick
| public virtual GetTraceLineThick( | | ioThick) |
-
Retrieves the TraceLineThick attribute.
o GetTraceLineTypeInfo
| public virtual GetTraceLineTypeInfo( | | oInfo) |
-
Retrieves the state of the TraceLineType parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTraceLineType
| public virtual GetTraceLineType( | | ioType) |
-
Retrieves the TraceLineType attribute.
o GetTraceLineVisuInfo
| public virtual GetTraceLineVisuInfo( | | oInfo) |
-
Retrieves the state of the TraceLineVisu parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTraceLineVisu
| public virtual GetTraceLineVisu( | | ioVisu) |
-
Retrieves the TraceLineVisu attribute.
o GetTracePointColorInfo
| public virtual GetTracePointColorInfo( | | oInfo) |
-
Retrieves the state of the TracePointColor parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTracePointColor
| public virtual GetTracePointColor( | | ioColor, |
| | iMaxLength, |
| | oReadLength | =NULL ) |
-
Retrieves the TracePointColor attribute.
o GetTracePointSymbolInfo
| public virtual GetTracePointSymbolInfo( | | oInfo) |
-
Retrieves the state of the TracePointSymbol parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTracePointSymbol
| public virtual GetTracePointSymbol( | | ioType) |
-
Retrieves the TracePointSymbol attribute.
o GetTracePointVisuInfo
| public virtual GetTracePointVisuInfo( | | oInfo) |
-
Retrieves the state of the TracePointVisu parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTracePointVisu
| public virtual GetTracePointVisu( | | ioVisu) |
-
Retrieves the TracePointVisu attribute.
o SetTraceAxisColorLock
| public virtual SetTraceAxisColorLock( | | iLocked) |
-
Locks or unlocks the TraceAxisColor parameter.
Role: Locks or unlocks the TraceAxisColor parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetTraceAxisColor
| public virtual SetTraceAxisColor( | const | iColor, |
| | iLength | =1 ) |
-
Sets the TraceAxisColor attribute.
o SetTraceAxisThickLock
| public virtual SetTraceAxisThickLock( | | iLocked) |
-
Locks or unlocks the TraceAxisThick parameter.
Role: Locks or unlocks the TraceAxisThick parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1: to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetTraceAxisThick
| public virtual SetTraceAxisThick( | const | iThick) |
-
Sets the TraceAxisThick attribute.
o SetTraceAxisTypeLock
| public virtual SetTraceAxisTypeLock( | | iLocked) |
-
Locks or unlocks the TraceAxisType parameter.
Role: Locks or unlocks the TraceAxisType parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1: to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetTraceAxisType
| public virtual SetTraceAxisType( | const | iType) |
-
Sets the TraceAxisType attribute.
o SetTraceAxisVisuLock
| public virtual SetTraceAxisVisuLock( | | iLocked) |
-
Locks or unlocks the TraceAxisVisu parameter.
Role: Locks or unlocks the TraceAxisVisu parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1: to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetTraceAxisVisu
| public virtual SetTraceAxisVisu( | const | iVisu) |
-
Sets the TraceAxisVisu attribute.
o SetTraceDeletePathLock
| public virtual SetTraceDeletePathLock( | | iLocked) |
-
Locks or unlocks the TraceDeletePath parameter.
Role: Locks or unlocks the TraceDeletePath parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1: to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetTraceDeletePath
| public virtual SetTraceDeletePath( | const | iDelete) |
-
Sets the TraceDeletePath attribute.
o SetTraceLegendLock
| public virtual SetTraceLegendLock( | | iLocked) |
-
Locks or unlocks the TraceLegend parameter.
Role: Locks or unlocks the TraceLegend parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetTraceLegend
| public virtual SetTraceLegend( | const | iLegend, |
| | iLength | =1 ) |
-
Sets the TraceLegend attribute.
o SetTraceLineColorLock
| public virtual SetTraceLineColorLock( | | iLocked) |
-
Locks or unlocks the TraceLineColor parameter.
Role: Locks or unlocks the TraceLineColor parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetTraceLineColor
| public virtual SetTraceLineColor( | const | iColor, |
| | iLength | =1 ) |
-
Sets the TraceLineColor attribute.
o SetTraceLineThickLock
| public virtual SetTraceLineThickLock( | | iLocked) |
-
Locks or unlocks the TraceLineThick parameter.
Role: Locks or unlocks the TraceLineThick parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1: to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetTraceLineThick
| public virtual SetTraceLineThick( | const | iThick) |
-
Sets the TraceLineThick attribute.
o SetTraceLineTypeLock
| public virtual SetTraceLineTypeLock( | | iLocked) |
-
Locks or unlocks the TraceLineType parameter.
Role: Locks or unlocks the TraceLineType parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1: to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetTraceLineType
| public virtual SetTraceLineType( | const | iType) |
-
Sets the TraceLineType attribute.
o SetTraceLineVisuLock
| public virtual SetTraceLineVisuLock( | | iLocked) |
-
Locks or unlocks the TraceLineVisu parameter.
Role: Locks or unlocks the TraceLineVisu parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1: to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetTraceLineVisu
| public virtual SetTraceLineVisu( | const | iVisu) |
-
Sets the TraceLineVisu attribute.
o SetTracePointColorLock
| public virtual SetTracePointColorLock( | | iLocked) |
-
Locks or unlocks the TracePointColor parameter.
Role: Locks or unlocks the TracePointColor parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetTracePointColor
| public virtual SetTracePointColor( | const | iColor, |
| | iLength | =1 ) |
-
Sets the TracePointColor attribute.
o SetTracePointSymbolLock
| public virtual SetTracePointSymbolLock( | | iLocked) |
-
Locks or unlocks the TracePointSymbol parameter.
Role: Locks or unlocks the TracePointSymbol parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1: to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetTracePointSymbol
| public virtual SetTracePointSymbol( | const | iType) |
-
Sets the TracePointSymbol attribute.
o SetTracePointVisuLock
| public virtual SetTracePointVisuLock( | | iLocked) |
-
Locks or unlocks the TracePointVisu parameter.
Role: Locks or unlocks the TracePointVisu parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1: to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetTracePointVisu
| public virtual SetTracePointVisu( | const | iVisu) |
-
Sets the TracePointVisu attribute.
This object is included in the file: DNBISimSimTraceSettingAtt.h
If needed, your Imakefile.mk should include the module: DNBSimulationItf