All Frameworks  Class Hierarchy  This Framework  Indexes   

DNBRobotInterfaces Interface DNBISimRobAnalysisSettingAtt

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface DNBISimRobAnalysisSettingAtt

Interface to handle parameters of Infrastructure-DELMIA Infrastructure-Robot Analysis Tools Options Tab page.
Role: This interface is implemented by a component which represents the controller of Robot Analysis Tools Options parameter settings.

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


Method Index


o GetLinAccelColorInfo(CATSettingInfo*)
Retrieves the state of the LinAccelColor parameter.
o GetLinAccelColor(unsigned int*,CATLONG32,CATLONG32*)
Retrieves the LinAccelColor attribute.
o GetLinAccelLimitInfo(CATSettingInfo*)
Retrieves the state of the LinAccelLimit parameter.
o GetLinAccelLimit(DNBAnalysisLevel&)
Retrieves the LinAccelLimit attribute.
o GetLinSpeedColorInfo(CATSettingInfo*)
Retrieves the state of the LinSpeedColor parameter.
o GetLinSpeedColor(unsigned int*,CATLONG32,CATLONG32*)
Retrieves the LinSpeedColor attribute.
o GetLinSpeedLimitInfo(CATSettingInfo*)
Retrieves the state of the LinSpeedLimit parameter.
o GetLinSpeedLimit(DNBAnalysisLevel&)
Retrieves the LinSpeedLimit attribute.
o GetReachColorInfo(CATSettingInfo*)
Retrieves the state of the ReachColor parameter.
o GetReachColor(unsigned int*,CATLONG32,CATLONG32*)
Retrieves the ReachColor attribute.
o GetRotAccelColorInfo(CATSettingInfo*)
Retrieves the state of the RotAccelColor parameter.
o GetRotAccelColor(unsigned int*,CATLONG32,CATLONG32*)
Retrieves the RotAccelColor attribute.
o GetRotAccelLimitInfo(CATSettingInfo*)
Retrieves the state of the RotAccelLimit parameter.
o GetRotAccelLimit(DNBAnalysisLevel&)
Retrieves the RotAccelLimit attribute.
o GetRotSpeedColorInfo(CATSettingInfo*)
Retrieves the state of the RotSpeedColor parameter.
o GetRotSpeedColor(unsigned int*,CATLONG32,CATLONG32*)
Retrieves the RotSpeedColor attribute.
o GetRotSpeedLimitInfo(CATSettingInfo*)
Retrieves the state of the RotSpeedLimit parameter.
o GetRotSpeedLimit(DNBAnalysisLevel&)
Retrieves the RotSpeedLimit attribute.
o GetSingularColorInfo(CATSettingInfo*)
Retrieves the state of the SingularColor parameter.
o GetSingularColor(unsigned int*,CATLONG32,CATLONG32*)
Retrieves the SingularColor attribute.
o SetLinAccelColorLock(unsigned char)
Locks or unlocks the LinAccelColor parameter.
o SetLinAccelColor(unsigned int*,CATLONG32)
Sets the LinAccelColor attribute.
o SetLinAccelLimitLock(unsigned char)
Locks or unlocks the LinAccelLimit parameter.
o SetLinAccelLimit(DNBAnalysisLevel)
Sets the LinAccelLimit attribute.
o SetLinSpeedColorLock(unsigned char)
Locks or unlocks the LinSpeedColor parameter.
o SetLinSpeedColor(unsigned int*,CATLONG32)
Sets the LinSpeedColor attribute.
o SetLinSpeedLimitLock(unsigned char)
Locks or unlocks the LinSpeedLimit parameter.
o SetLinSpeedLimit(DNBAnalysisLevel)
Sets the LinSpeedLimit attribute.
o SetReachColorLock(unsigned char)
Locks or unlocks the ReachColor parameter.
o SetReachColor(unsigned int*,CATLONG32)
Sets the ReachColor attribute.
o SetRotAccelColorLock(unsigned char)
Locks or unlocks the RotAccelColor parameter.
o SetRotAccelColor(unsigned int*,CATLONG32)
Sets the RotAccelColor attribute.
o SetRotAccelLimitLock(unsigned char)
Locks or unlocks the RotAccelLimit parameter.
o SetRotAccelLimit(DNBAnalysisLevel)
Sets the RotAccelLimit attribute.
o SetRotSpeedColorLock(unsigned char)
Locks or unlocks the RotSpeedColor parameter.
o SetRotSpeedColor(unsigned int*,CATLONG32)
Sets the RotSpeedColor attribute.
o SetRotSpeedLimitLock(unsigned char)
Locks or unlocks the RotSpeedLimit parameter.
o SetRotSpeedLimit(DNBAnalysisLevel)
Sets the RotSpeedLimit attribute.
o SetSingularColorLock(unsigned char)
Locks or unlocks the SingularColor parameter.
o SetSingularColor(unsigned int*,CATLONG32)
Sets the SingularColor attribute.

Methods


o GetLinAccelColorInfo
public virtual GetLinAccelColorInfo( oInfo)
Retrieves the state of the LinAccelColor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetLinAccelColor
public virtual GetLinAccelColor( ioColor,
iMaxLength,
oReadLength=NULL )
Retrieves the LinAccelColor attribute.
o GetLinAccelLimitInfo
public virtual GetLinAccelLimitInfo( oInfo)
Retrieves the state of the LinAccelLimit parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetLinAccelLimit
public virtual GetLinAccelLimit( ioAnalysisLevel)
Retrieves the LinAccelLimit attribute.
o GetLinSpeedColorInfo
public virtual GetLinSpeedColorInfo( oInfo)
Retrieves the state of the LinSpeedColor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetLinSpeedColor
public virtual GetLinSpeedColor( ioColor,
iMaxLength,
oReadLength=NULL )
Retrieves the LinSpeedColor attribute.
o GetLinSpeedLimitInfo
public virtual GetLinSpeedLimitInfo( oInfo)
Retrieves the state of the LinSpeedLimit parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetLinSpeedLimit
public virtual GetLinSpeedLimit( ioAnalysisLevel)
Retrieves the LinSpeedLimit attribute.
o GetReachColorInfo
public virtual GetReachColorInfo( oInfo)
Retrieves the state of the ReachColor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReachColor
public virtual GetReachColor( ioColor,
iMaxLength,
oReadLength=NULL )
Retrieves the ReachColor attribute.
o GetRotAccelColorInfo
public virtual GetRotAccelColorInfo( oInfo)
Retrieves the state of the RotAccelColor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRotAccelColor
public virtual GetRotAccelColor( ioColor,
iMaxLength,
oReadLength=NULL )
Retrieves the RotAccelColor attribute.
o GetRotAccelLimitInfo
public virtual GetRotAccelLimitInfo( oInfo)
Retrieves the state of the RotAccelLimit parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRotAccelLimit
public virtual GetRotAccelLimit( ioAnalysisLevel)
Retrieves the RotAccelLimit attribute.
o GetRotSpeedColorInfo
public virtual GetRotSpeedColorInfo( oInfo)
Retrieves the state of the RotSpeedColor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRotSpeedColor
public virtual GetRotSpeedColor( ioColor,
iMaxLength,
oReadLength=NULL )
Retrieves the RotSpeedColor attribute.
o GetRotSpeedLimitInfo
public virtual GetRotSpeedLimitInfo( oInfo)
Retrieves the state of the RotSpeedLimit parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetRotSpeedLimit
public virtual GetRotSpeedLimit( ioAnalysisLevel)
Retrieves the RotSpeedLimit attribute.
o GetSingularColorInfo
public virtual GetSingularColorInfo( oInfo)
Retrieves the state of the SingularColor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSingularColor
public virtual GetSingularColor( ioColor,
iMaxLength,
oReadLength=NULL )
Retrieves the SingularColor attribute.
o SetLinAccelColorLock
public virtual SetLinAccelColorLock( iLocked)
Locks or unlocks the LinAccelColor parameter.
Role: Locks or unlocks the LinAccelColor 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 SetLinAccelColor
public virtual SetLinAccelColor( const iColor,
iLength=1 )
Sets the LinAccelColor attribute.
o SetLinAccelLimitLock
public virtual SetLinAccelLimitLock( iLocked)
Locks or unlocks the LinAccelLimit parameter.
Role: Locks or unlocks the LinAccelLimit 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 SetLinAccelLimit
public virtual SetLinAccelLimit( const iAnalysisLevel)
Sets the LinAccelLimit attribute.
o SetLinSpeedColorLock
public virtual SetLinSpeedColorLock( iLocked)
Locks or unlocks the LinSpeedColor parameter.
Role: Locks or unlocks the LinSpeedColor 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 SetLinSpeedColor
public virtual SetLinSpeedColor( const iColor,
iLength=1 )
Sets the LinSpeedColor attribute.
o SetLinSpeedLimitLock
public virtual SetLinSpeedLimitLock( iLocked)
Locks or unlocks the LinSpeedLimit parameter.
Role: Locks or unlocks the LinSpeedLimit 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 SetLinSpeedLimit
public virtual SetLinSpeedLimit( const iAnalysisLevel)
Sets the LinSpeedLimit attribute.
o SetReachColorLock
public virtual SetReachColorLock( iLocked)
Locks or unlocks the ReachColor parameter.
Role: Locks or unlocks the ReachColor 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 SetReachColor
public virtual SetReachColor( const iColor,
iLength=1 )
Sets the ReachColor attribute.
o SetRotAccelColorLock
public virtual SetRotAccelColorLock( iLocked)
Locks or unlocks the RotAccelColor parameter.
Role: Locks or unlocks the RotAccelColor 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 SetRotAccelColor
public virtual SetRotAccelColor( const iColor,
iLength=1 )
Sets the RotAccelColor attribute.
o SetRotAccelLimitLock
public virtual SetRotAccelLimitLock( iLocked)
Locks or unlocks the RotAccelLimit parameter.
Role: Locks or unlocks the RotAccelLimit 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 SetRotAccelLimit
public virtual SetRotAccelLimit( const iAnalysisLevel)
Sets the RotAccelLimit attribute.
o SetRotSpeedColorLock
public virtual SetRotSpeedColorLock( iLocked)
Locks or unlocks the RotSpeedColor parameter.
Role: Locks or unlocks the RotSpeedColor 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 SetRotSpeedColor
public virtual SetRotSpeedColor( const iColor,
iLength=1 )
Sets the RotSpeedColor attribute.
o SetRotSpeedLimitLock
public virtual SetRotSpeedLimitLock( iLocked)
Locks or unlocks the RotSpeedLimit parameter.
Role: Locks or unlocks the RotSpeedLimit 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 SetRotSpeedLimit
public virtual SetRotSpeedLimit( const iAnalysisLevel)
Sets the RotSpeedLimit attribute.
o SetSingularColorLock
public virtual SetSingularColorLock( iLocked)
Locks or unlocks the SingularColor parameter.
Role: Locks or unlocks the SingularColor 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 SetSingularColor
public virtual SetSingularColor( const iColor,
iLength=1 )
Sets the SingularColor attribute.

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

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