All Frameworks  Object Hierarchy  This Framework  Indexes   

SimTraceSettingAtt (Object)

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:

Property Index

TraceAxisColor
Returns or sets the TraceAxisColor parameter.
TraceAxisThick
Returns or sets the TraceAxisThick parameter.
TraceAxisType
Returns or sets the TraceAxisType parameter.
TraceAxisVisu
Returns or sets the TraceAxisVisu parameter.
TraceDeletePath
Returns or sets the TraceDeletePath parameter.
TraceLegend
Returns or sets the TraceLegend parameter.
TraceLineColor
Returns or sets the TraceLineColor parameter.
TraceLineThick
Returns or sets the TraceLineThick parameter.
TraceLineType
Returns or sets the TraceLineType parameter.
TraceLineVisu
Returns or sets the TraceLineVisu parameter.
TracePointColor
Returns or sets the TracePointColor parameter.
TracePointSymbol
Returns or sets the TracePointSymbol parameter.
TracePointVisu
Returns or sets the TracePointVisu parameter.

Method Index

GetTraceAxisColorInfo
Retrieves environment informations for the TraceAxisColor parameter.
GetTraceAxisThickInfo
Retrieves environment informations for the TraceAxisThick parameter.
GetTraceAxisTypeInfo
Retrieves environment informations for the TraceAxisType parameter.
GetTraceAxisVisuInfo
Retrieves environment informations for the TraceAxisVisu parameter.
GetTraceDeletePathInfo
Retrieves environment informations for the TraceDeletePath parameter.
GetTraceLegendInfo
Retrieves environment informations for the TraceLegend parameter.
GetTraceLineColorInfo
Retrieves environment informations for the TraceLineColor parameter.
GetTraceLineThickInfo
Retrieves environment informations for the TraceLineThick parameter.
GetTraceLineTypeInfo
Retrieves environment informations for the TraceLineType parameter.
GetTraceLineVisuInfo
Retrieves environment informations for the TraceLineVisu parameter.
GetTracePointColorInfo
Retrieves environment informations for the TracePointColor parameter.
GetTracePointSymbolInfo
Retrieves environment informations for the TracePointSymbol parameter.
GetTracePointVisuInfo
Retrieves environment informations for the TracePointVisu parameter.
SetTraceAxisColorLock
Locks or unlocks the TraceAxisColor parameter.
SetTraceAxisThickLock
Locks or unlocks the TraceAxisThick parameter.
SetTraceAxisTypeLock
Locks or unlocks the TraceAxisType parameter.
SetTraceAxisVisuLock
Locks or unlocks the TraceAxisVisu parameter.
SetTraceDeletePathLock
Locks or unlocks the TraceDeletePath parameter.
SetTraceLegendLock
Locks or unlocks the TraceLegend parameter.
SetTraceLineColorLock
Locks or unlocks the TraceLineColor parameter.
SetTraceLineThickLock
Locks or unlocks the TraceLineThick parameter.
SetTraceLineTypeLock
Locks or unlocks the TraceLineType parameter.
SetTraceLineVisuLock
Locks or unlocks the TraceLineVisu parameter.
SetTracePointColorLock
Locks or unlocks the TracePointColor parameter.
SetTracePointSymbolLock
Locks or unlocks the TracePointSymbol parameter.
SetTracePointVisuLock
Locks or unlocks the TracePointVisu parameter.

Properties


o Property TraceAxisColor() As
Returns or sets the TraceAxisColor parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property TraceAxisThick() As
Returns or sets the TraceAxisThick parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property TraceAxisType() As
Returns or sets the TraceAxisType parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property TraceAxisVisu() As
Returns or sets the TraceAxisVisu parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property TraceDeletePath() As
Returns or sets the TraceDeletePath parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property TraceLegend() As
Returns or sets the TraceLegend parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property TraceLineColor() As
Returns or sets the TraceLineColor parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property TraceLineThick() As
Returns or sets the TraceLineThick parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property TraceLineType() As
Returns or sets the TraceLineType parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property TraceLineVisu() As
Returns or sets the TraceLineVisu parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property TracePointColor() As
Returns or sets the TracePointColor parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property TracePointSymbol() As
Returns or sets the TracePointSymbol parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property TracePointVisu() As
Returns or sets the TracePointVisu parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Methods


o Func GetTraceAxisColorInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the TraceAxisColor parameter.
Role:Retrieves the state of the TraceAxisColor parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetTraceAxisThickInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the TraceAxisThick parameter.
Role:Retrieves the state of the TraceAxisThick parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetTraceAxisTypeInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the TraceAxisType parameter.
Role:Retrieves the state of the TraceAxisType parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetTraceAxisVisuInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the TraceAxisVisu parameter.
Role:Retrieves the state of the TraceAxisVisu parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetTraceDeletePathInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the TraceDeletePath parameter.
Role:Retrieves the state of the TraceDeletePath parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetTraceLegendInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the TraceLegend parameter.
Role:Retrieves the state of the TraceLegend parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetTraceLineColorInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the TraceLineColor parameter.
Role:Retrieves the state of the TraceLineColor parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetTraceLineThickInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the TraceLineThick parameter.
Role:Retrieves the state of the TraceLineThick parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetTraceLineTypeInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the TraceLineType parameter.
Role:Retrieves the state of the TraceLineType parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetTraceLineVisuInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the TraceLineVisu parameter.
Role:Retrieves the state of the TraceLineVisu parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetTracePointColorInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the TracePointColor parameter.
Role:Retrieves the state of the TracePointColor parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetTracePointSymbolInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the TracePointSymbol parameter.
Role:Retrieves the state of the TracePointSymbol parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetTracePointVisuInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the TracePointVisu parameter.
Role:Retrieves the state of the TracePointVisu parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Sub SetTraceAxisColorLock( iLocked)
Locks or unlocks the TraceAxisColor parameter.
Role:Locks or unlocks the TraceAxisColor parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetTraceAxisThickLock( iLocked)
Locks or unlocks the TraceAxisThick parameter.
Role:Locks or unlocks the TraceAxisThick parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetTraceAxisTypeLock( iLocked)
Locks or unlocks the TraceAxisType parameter.
Role:Locks or unlocks the TraceAxisType parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetTraceAxisVisuLock( iLocked)
Locks or unlocks the TraceAxisVisu parameter.
Role:Locks or unlocks the TraceAxisVisu parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetTraceDeletePathLock( iLocked)
Locks or unlocks the TraceDeletePath parameter.
Role:Locks or unlocks the TraceDeletePath parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetTraceLegendLock( iLocked)
Locks or unlocks the TraceLegend parameter.
Role:Locks or unlocks the TraceLegend parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetTraceLineColorLock( iLocked)
Locks or unlocks the TraceLineColor parameter.
Role:Locks or unlocks the TraceLineColor parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetTraceLineThickLock( iLocked)
Locks or unlocks the TraceLineThick parameter.
Role:Locks or unlocks the TraceLineThick parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetTraceLineTypeLock( iLocked)
Locks or unlocks the TraceLineType parameter.
Role:Locks or unlocks the TraceLineType parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetTraceLineVisuLock( iLocked)
Locks or unlocks the TraceLineVisu parameter.
Role:Locks or unlocks the TraceLineVisu parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetTracePointColorLock( iLocked)
Locks or unlocks the TracePointColor parameter.
Role:Locks or unlocks the TracePointColor parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetTracePointSymbolLock( iLocked)
Locks or unlocks the TracePointSymbol parameter.
Role:Locks or unlocks the TracePointSymbol parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetTracePointVisuLock( iLocked)
Locks or unlocks the TracePointVisu parameter.
Role:Locks or unlocks the TracePointVisu parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

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