All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

DNBRobotInterfaces Interface DNBISimRobAnalysisSettingAtt

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

Methods


o GetLinAccelColor
public virtual HRESULT GetLinAccelColor(unsigned int* ioColor,
CATLONG32 iMaxLength,
CATLONG32* oReadLength=NULL )= 0
Retrieves the LinAccelColor attribute.
o GetLinAccelColorInfo
public virtual HRESULT GetLinAccelColorInfo(CATSettingInfo* oInfo)= 0
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 GetLinAccelLimit
public virtual HRESULT GetLinAccelLimit(DNBAnalysisLevel& ioAnalysisLevel)= 0
Retrieves the LinAccelLimit attribute.
o GetLinAccelLimitInfo
public virtual HRESULT GetLinAccelLimitInfo(CATSettingInfo* oInfo)= 0
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 GetLinSpeedColor
public virtual HRESULT GetLinSpeedColor(unsigned int* ioColor,
CATLONG32 iMaxLength,
CATLONG32* oReadLength=NULL )= 0
Retrieves the LinSpeedColor attribute.
o GetLinSpeedColorInfo
public virtual HRESULT GetLinSpeedColorInfo(CATSettingInfo* oInfo)= 0
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 GetLinSpeedLimit
public virtual HRESULT GetLinSpeedLimit(DNBAnalysisLevel& ioAnalysisLevel)= 0
Retrieves the LinSpeedLimit attribute.
o GetLinSpeedLimitInfo
public virtual HRESULT GetLinSpeedLimitInfo(CATSettingInfo* oInfo)= 0
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 GetReachColor
public virtual HRESULT GetReachColor(unsigned int* ioColor,
CATLONG32 iMaxLength,
CATLONG32* oReadLength=NULL )= 0
Retrieves the ReachColor attribute.
o GetReachColorInfo
public virtual HRESULT GetReachColorInfo(CATSettingInfo* oInfo)= 0
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 GetRotAccelColor
public virtual HRESULT GetRotAccelColor(unsigned int* ioColor,
CATLONG32 iMaxLength,
CATLONG32* oReadLength=NULL )= 0
Retrieves the RotAccelColor attribute.
o GetRotAccelColorInfo
public virtual HRESULT GetRotAccelColorInfo(CATSettingInfo* oInfo)= 0
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 GetRotAccelLimit
public virtual HRESULT GetRotAccelLimit(DNBAnalysisLevel& ioAnalysisLevel)= 0
Retrieves the RotAccelLimit attribute.
o GetRotAccelLimitInfo
public virtual HRESULT GetRotAccelLimitInfo(CATSettingInfo* oInfo)= 0
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 GetRotSpeedColor
public virtual HRESULT GetRotSpeedColor(unsigned int* ioColor,
CATLONG32 iMaxLength,
CATLONG32* oReadLength=NULL )= 0
Retrieves the RotSpeedColor attribute.
o GetRotSpeedColorInfo
public virtual HRESULT GetRotSpeedColorInfo(CATSettingInfo* oInfo)= 0
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 GetRotSpeedLimit
public virtual HRESULT GetRotSpeedLimit(DNBAnalysisLevel& ioAnalysisLevel)= 0
Retrieves the RotSpeedLimit attribute.
o GetRotSpeedLimitInfo
public virtual HRESULT GetRotSpeedLimitInfo(CATSettingInfo* oInfo)= 0
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 GetSingularColor
public virtual HRESULT GetSingularColor(unsigned int* ioColor,
CATLONG32 iMaxLength,
CATLONG32* oReadLength=NULL )= 0
Retrieves the SingularColor attribute.
o GetSingularColorInfo
public virtual HRESULT GetSingularColorInfo(CATSettingInfo* oInfo)= 0
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 SetLinAccelColor
public virtual HRESULT SetLinAccelColor( const unsigned int* iColor,
CATLONG32 iLength=1 )= 0
Sets the LinAccelColor attribute.
o SetLinAccelColorLock
public virtual HRESULT SetLinAccelColorLock(unsigned char iLocked)= 0
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 SetLinAccelLimit
public virtual HRESULT SetLinAccelLimit( const DNBAnalysisLevel iAnalysisLevel)= 0
Sets the LinAccelLimit attribute.
o SetLinAccelLimitLock
public virtual HRESULT SetLinAccelLimitLock(unsigned char iLocked)= 0
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 SetLinSpeedColor
public virtual HRESULT SetLinSpeedColor( const unsigned int* iColor,
CATLONG32 iLength=1 )= 0
Sets the LinSpeedColor attribute.
o SetLinSpeedColorLock
public virtual HRESULT SetLinSpeedColorLock(unsigned char iLocked)= 0
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 SetLinSpeedLimit
public virtual HRESULT SetLinSpeedLimit( const DNBAnalysisLevel iAnalysisLevel)= 0
Sets the LinSpeedLimit attribute.
o SetLinSpeedLimitLock
public virtual HRESULT SetLinSpeedLimitLock(unsigned char iLocked)= 0
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 SetReachColor
public virtual HRESULT SetReachColor( const unsigned int* iColor,
CATLONG32 iLength=1 )= 0
Sets the ReachColor attribute.
o SetReachColorLock
public virtual HRESULT SetReachColorLock(unsigned char iLocked)= 0
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 SetRotAccelColor
public virtual HRESULT SetRotAccelColor( const unsigned int* iColor,
CATLONG32 iLength=1 )= 0
Sets the RotAccelColor attribute.
o SetRotAccelColorLock
public virtual HRESULT SetRotAccelColorLock(unsigned char iLocked)= 0
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 SetRotAccelLimit
public virtual HRESULT SetRotAccelLimit( const DNBAnalysisLevel iAnalysisLevel)= 0
Sets the RotAccelLimit attribute.
o SetRotAccelLimitLock
public virtual HRESULT SetRotAccelLimitLock(unsigned char iLocked)= 0
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 SetRotSpeedColor
public virtual HRESULT SetRotSpeedColor( const unsigned int* iColor,
CATLONG32 iLength=1 )= 0
Sets the RotSpeedColor attribute.
o SetRotSpeedColorLock
public virtual HRESULT SetRotSpeedColorLock(unsigned char iLocked)= 0
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 SetRotSpeedLimit
public virtual HRESULT SetRotSpeedLimit( const DNBAnalysisLevel iAnalysisLevel)= 0
Sets the RotSpeedLimit attribute.
o SetRotSpeedLimitLock
public virtual HRESULT SetRotSpeedLimitLock(unsigned char iLocked)= 0
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 SetSingularColor
public virtual HRESULT SetSingularColor( const unsigned int* iColor,
CATLONG32 iLength=1 )= 0
Sets the SingularColor attribute.
o SetSingularColorLock
public virtual HRESULT SetSingularColorLock(unsigned char iLocked)= 0
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

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.