All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DNBSimulationInterfaces Interface DNBISimSimTraceSettingAtt

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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.

Here is the list of parameters to use and their meaning:


Method Index


o GetTraceAxisColor(unsigned int*,CATLONG32,CATLONG32*)
Retrieves the TraceAxisColor attribute.
o GetTraceAxisColorInfo(CATSettingInfo*)
Retrieves the state of the TraceAxisColor parameter.
o GetTraceAxisThick(unsigned int&)
Retrieves the TraceAxisThick attribute.
o GetTraceAxisThickInfo(CATSettingInfo*)
Retrieves the state of the TraceAxisThick parameter.
o GetTraceAxisType(unsigned int&)
Retrieves the TraceAxisType attribute.
o GetTraceAxisTypeInfo(CATSettingInfo*)
Retrieves the state of the TraceAxisType parameter.
o GetTraceAxisVisu(CATBoolean&)
Retrieves the TraceAxisVisu attribute.
o GetTraceAxisVisuInfo(CATSettingInfo*)
Retrieves the state of the TraceAxisVisu parameter.
o GetTraceDeletePath(CATBoolean&)
Retrieves the TraceDeletePath attribute.
o GetTraceDeletePathInfo(CATSettingInfo*)
Retrieves the state of the TraceDeletePath parameter.
o GetTraceLegend(unsigned int*,CATLONG32,CATLONG32*)
Retrieves the TraceLegend attribute.
o GetTraceLegendInfo(CATSettingInfo*)
Retrieves the state of the TraceLegend parameter.
o GetTraceLineColor(unsigned int*,CATLONG32,CATLONG32*)
Retrieves the TraceLineColor attribute.
o GetTraceLineColorInfo(CATSettingInfo*)
Retrieves the state of the TraceLineColor parameter.
o GetTraceLineThick(unsigned int&)
Retrieves the TraceLineThick attribute.
o GetTraceLineThickInfo(CATSettingInfo*)
Retrieves the state of the TraceLineThick parameter.
o GetTraceLineType(unsigned int&)
Retrieves the TraceLineType attribute.
o GetTraceLineTypeInfo(CATSettingInfo*)
Retrieves the state of the TraceLineType parameter.
o GetTraceLineVisu(CATBoolean&)
Retrieves the TraceLineVisu attribute.
o GetTraceLineVisuInfo(CATSettingInfo*)
Retrieves the state of the TraceLineVisu parameter.
o GetTracePointColor(unsigned int*,CATLONG32,CATLONG32*)
Retrieves the TracePointColor attribute.
o GetTracePointColorInfo(CATSettingInfo*)
Retrieves the state of the TracePointColor parameter.
o GetTracePointSymbol(unsigned int&)
Retrieves the TracePointSymbol attribute.
o GetTracePointSymbolInfo(CATSettingInfo*)
Retrieves the state of the TracePointSymbol parameter.
o GetTracePointVisu(CATBoolean&)
Retrieves the TracePointVisu attribute.
o GetTracePointVisuInfo(CATSettingInfo*)
Retrieves the state of the TracePointVisu parameter.
o SetTraceAxisColor(unsigned int*,CATLONG32)
Sets the TraceAxisColor attribute.
o SetTraceAxisColorLock(unsigned char)
Locks or unlocks the TraceAxisColor parameter.
o SetTraceAxisThick(unsigned int)
Sets the TraceAxisThick attribute.
o SetTraceAxisThickLock(unsigned char)
Locks or unlocks the TraceAxisThick parameter.
o SetTraceAxisType(unsigned int)
Sets the TraceAxisType attribute.
o SetTraceAxisTypeLock(unsigned char)
Locks or unlocks the TraceAxisType parameter.
o SetTraceAxisVisu(CATBoolean)
Sets the TraceAxisVisu attribute.
o SetTraceAxisVisuLock(unsigned char)
Locks or unlocks the TraceAxisVisu parameter.
o SetTraceDeletePath(CATBoolean)
Sets the TraceDeletePath attribute.
o SetTraceDeletePathLock(unsigned char)
Locks or unlocks the TraceDeletePath parameter.
o SetTraceLegend(unsigned int*,CATLONG32)
Sets the TraceLegend attribute.
o SetTraceLegendLock(unsigned char)
Locks or unlocks the TraceLegend parameter.
o SetTraceLineColor(unsigned int*,CATLONG32)
Sets the TraceLineColor attribute.
o SetTraceLineColorLock(unsigned char)
Locks or unlocks the TraceLineColor parameter.
o SetTraceLineThick(unsigned int)
Sets the TraceLineThick attribute.
o SetTraceLineThickLock(unsigned char)
Locks or unlocks the TraceLineThick parameter.
o SetTraceLineType(unsigned int)
Sets the TraceLineType attribute.
o SetTraceLineTypeLock(unsigned char)
Locks or unlocks the TraceLineType parameter.
o SetTraceLineVisu(CATBoolean)
Sets the TraceLineVisu attribute.
o SetTraceLineVisuLock(unsigned char)
Locks or unlocks the TraceLineVisu parameter.
o SetTracePointColor(unsigned int*,CATLONG32)
Sets the TracePointColor attribute.
o SetTracePointColorLock(unsigned char)
Locks or unlocks the TracePointColor parameter.
o SetTracePointSymbol(unsigned int)
Sets the TracePointSymbol attribute.
o SetTracePointSymbolLock(unsigned char)
Locks or unlocks the TracePointSymbol parameter.
o SetTracePointVisu(CATBoolean)
Sets the TracePointVisu attribute.
o SetTracePointVisuLock(unsigned char)
Locks or unlocks the TracePointVisu parameter.

Methods


o GetTraceAxisColor
public virtual HRESULT GetTraceAxisColor(unsigned int* ioColor,
CATLONG32 iMaxLength,
CATLONG32* oReadLength=NULL )= 0
Retrieves the TraceAxisColor attribute.
o GetTraceAxisColorInfo
public virtual HRESULT GetTraceAxisColorInfo(CATSettingInfo* oInfo)= 0
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 GetTraceAxisThick
public virtual HRESULT GetTraceAxisThick(unsigned int& ioThick)= 0
Retrieves the TraceAxisThick attribute.
o GetTraceAxisThickInfo
public virtual HRESULT GetTraceAxisThickInfo(CATSettingInfo* oInfo)= 0
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 GetTraceAxisType
public virtual HRESULT GetTraceAxisType(unsigned int& ioType)= 0
Retrieves the TraceAxisType attribute.
o GetTraceAxisTypeInfo
public virtual HRESULT GetTraceAxisTypeInfo(CATSettingInfo* oInfo)= 0
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 GetTraceAxisVisu
public virtual HRESULT GetTraceAxisVisu(CATBoolean& ioVisu)= 0
Retrieves the TraceAxisVisu attribute.
o GetTraceAxisVisuInfo
public virtual HRESULT GetTraceAxisVisuInfo(CATSettingInfo* oInfo)= 0
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 GetTraceDeletePath
public virtual HRESULT GetTraceDeletePath(CATBoolean& ioDelete)= 0
Retrieves the TraceDeletePath attribute.
o GetTraceDeletePathInfo
public virtual HRESULT GetTraceDeletePathInfo(CATSettingInfo* oInfo)= 0
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 GetTraceLegend
public virtual HRESULT GetTraceLegend(unsigned int* ioLegend,
CATLONG32 iMaxLength,
CATLONG32* oReadLength=NULL )= 0
Retrieves the TraceLegend attribute.
o GetTraceLegendInfo
public virtual HRESULT GetTraceLegendInfo(CATSettingInfo* oInfo)= 0
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 GetTraceLineColor
public virtual HRESULT GetTraceLineColor(unsigned int* ioColor,
CATLONG32 iMaxLength,
CATLONG32* oReadLength=NULL )= 0
Retrieves the TraceLineColor attribute.
o GetTraceLineColorInfo
public virtual HRESULT GetTraceLineColorInfo(CATSettingInfo* oInfo)= 0
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 GetTraceLineThick
public virtual HRESULT GetTraceLineThick(unsigned int& ioThick)= 0
Retrieves the TraceLineThick attribute.
o GetTraceLineThickInfo
public virtual HRESULT GetTraceLineThickInfo(CATSettingInfo* oInfo)= 0
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 GetTraceLineType
public virtual HRESULT GetTraceLineType(unsigned int& ioType)= 0
Retrieves the TraceLineType attribute.
o GetTraceLineTypeInfo
public virtual HRESULT GetTraceLineTypeInfo(CATSettingInfo* oInfo)= 0
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 GetTraceLineVisu
public virtual HRESULT GetTraceLineVisu(CATBoolean& ioVisu)= 0
Retrieves the TraceLineVisu attribute.
o GetTraceLineVisuInfo
public virtual HRESULT GetTraceLineVisuInfo(CATSettingInfo* oInfo)= 0
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 GetTracePointColor
public virtual HRESULT GetTracePointColor(unsigned int* ioColor,
CATLONG32 iMaxLength,
CATLONG32* oReadLength=NULL )= 0
Retrieves the TracePointColor attribute.
o GetTracePointColorInfo
public virtual HRESULT GetTracePointColorInfo(CATSettingInfo* oInfo)= 0
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 GetTracePointSymbol
public virtual HRESULT GetTracePointSymbol(unsigned int& ioType)= 0
Retrieves the TracePointSymbol attribute.
o GetTracePointSymbolInfo
public virtual HRESULT GetTracePointSymbolInfo(CATSettingInfo* oInfo)= 0
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 GetTracePointVisu
public virtual HRESULT GetTracePointVisu(CATBoolean& ioVisu)= 0
Retrieves the TracePointVisu attribute.
o GetTracePointVisuInfo
public virtual HRESULT GetTracePointVisuInfo(CATSettingInfo* oInfo)= 0
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 SetTraceAxisColor
public virtual HRESULT SetTraceAxisColor( const unsigned int* iColor,
CATLONG32 iLength=1 )= 0
Sets the TraceAxisColor attribute.
o SetTraceAxisColorLock
public virtual HRESULT SetTraceAxisColorLock(unsigned char iLocked)= 0
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 SetTraceAxisThick
public virtual HRESULT SetTraceAxisThick( const unsigned int iThick)= 0
Sets the TraceAxisThick attribute.
o SetTraceAxisThickLock
public virtual HRESULT SetTraceAxisThickLock(unsigned char iLocked)= 0
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 SetTraceAxisType
public virtual HRESULT SetTraceAxisType( const unsigned int iType)= 0
Sets the TraceAxisType attribute.
o SetTraceAxisTypeLock
public virtual HRESULT SetTraceAxisTypeLock(unsigned char iLocked)= 0
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 SetTraceAxisVisu
public virtual HRESULT SetTraceAxisVisu( const CATBoolean iVisu)= 0
Sets the TraceAxisVisu attribute.
o SetTraceAxisVisuLock
public virtual HRESULT SetTraceAxisVisuLock(unsigned char iLocked)= 0
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 SetTraceDeletePath
public virtual HRESULT SetTraceDeletePath( const CATBoolean iDelete)= 0
Sets the TraceDeletePath attribute.
o SetTraceDeletePathLock
public virtual HRESULT SetTraceDeletePathLock(unsigned char iLocked)= 0
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 SetTraceLegend
public virtual HRESULT SetTraceLegend( const unsigned int* iLegend,
CATLONG32 iLength=1 )= 0
Sets the TraceLegend attribute.
o SetTraceLegendLock
public virtual HRESULT SetTraceLegendLock(unsigned char iLocked)= 0
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 SetTraceLineColor
public virtual HRESULT SetTraceLineColor( const unsigned int* iColor,
CATLONG32 iLength=1 )= 0
Sets the TraceLineColor attribute.
o SetTraceLineColorLock
public virtual HRESULT SetTraceLineColorLock(unsigned char iLocked)= 0
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 SetTraceLineThick
public virtual HRESULT SetTraceLineThick( const unsigned int iThick)= 0
Sets the TraceLineThick attribute.
o SetTraceLineThickLock
public virtual HRESULT SetTraceLineThickLock(unsigned char iLocked)= 0
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 SetTraceLineType
public virtual HRESULT SetTraceLineType( const unsigned int iType)= 0
Sets the TraceLineType attribute.
o SetTraceLineTypeLock
public virtual HRESULT SetTraceLineTypeLock(unsigned char iLocked)= 0
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 SetTraceLineVisu
public virtual HRESULT SetTraceLineVisu( const CATBoolean iVisu)= 0
Sets the TraceLineVisu attribute.
o SetTraceLineVisuLock
public virtual HRESULT SetTraceLineVisuLock(unsigned char iLocked)= 0
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 SetTracePointColor
public virtual HRESULT SetTracePointColor( const unsigned int* iColor,
CATLONG32 iLength=1 )= 0
Sets the TracePointColor attribute.
o SetTracePointColorLock
public virtual HRESULT SetTracePointColorLock(unsigned char iLocked)= 0
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 SetTracePointSymbol
public virtual HRESULT SetTracePointSymbol( const unsigned int iType)= 0
Sets the TracePointSymbol attribute.
o SetTracePointSymbolLock
public virtual HRESULT SetTracePointSymbolLock(unsigned char iLocked)= 0
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 SetTracePointVisu
public virtual HRESULT SetTracePointVisu( const CATBoolean iVisu)= 0
Sets the TracePointVisu attribute.
o SetTracePointVisuLock
public virtual HRESULT SetTracePointVisuLock(unsigned char iLocked)= 0
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

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

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