All Frameworks  Class Hierarchy  This Framework  Indexes

DNBDeviceInterfaces Interface DNBISimDevAnalysisSettingAtt

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---DNBISimDevAnalysisSettingAtt
 

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


interface DNBISimDevAnalysisSettingAtt

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

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


Method Index


o GetAccelColor(unsigned int*,CATLONG32,CATLONG32*)
Retrieves the AccelColor attribute.
o GetAccelColorInfo(CATSettingInfo*)
Retrieves the state of the AccelColor parameter.
o GetAccelLimit(DNBAnalysisLevel&)
Retrieves the AccelLimit attribute.
o GetAccelLimitInfo(CATSettingInfo*)
Retrieves the state of the AccelLimit parameter.
o GetCautionColor(unsigned int*,CATLONG32,CATLONG32*)
Retrieves the CautionColor attribute.
o GetCautionColorInfo(CATSettingInfo*)
Retrieves the state of the CautionColor parameter.
o GetCautionZone(DNBAnalysisLevel&)
Retrieves the CautionZone attribute.
o GetCautionZoneInfo(CATSettingInfo*)
Retrieves the state of the CautionZone parameter.
o GetTravelColor(unsigned int*,CATLONG32,CATLONG32*)
Retrieves the TravelColor attribute.
o GetTravelColorInfo(CATSettingInfo*)
Retrieves the state of the TravelColor parameter.
o GetTravelLimit(DNBAnalysisLevel&)
Retrieves the TravelLimit attribute.
o GetTravelLimitInfo(CATSettingInfo*)
Retrieves the state of the TravelLimit parameter.
o GetVelocityColor(unsigned int*,CATLONG32,CATLONG32*)
Retrieves the VelocityColor attribute.
o GetVelocityColorInfo(CATSettingInfo*)
Retrieves the state of the VelocityColor parameter.
o GetVelocityLimit(DNBAnalysisLevel&)
Retrieves the VelocityLimit attribute.
o GetVelocityLimitInfo(CATSettingInfo*)
Retrieves the state of the VelocityLimit parameter.
o SetAccelColor(unsigned int*,CATLONG32)
Sets the AccelColor attribute.
o SetAccelColorLock(unsigned char)
Locks or unlocks the AccelColor parameter.
o SetAccelLimit(DNBAnalysisLevel)
Sets the AccelLimit attribute.
o SetAccelLimitLock(unsigned char)
Locks or unlocks the AccelLimit parameter.
o SetCautionColor(unsigned int*,CATLONG32)
Sets the CautionColor attribute.
o SetCautionColorLock(unsigned char)
Locks or unlocks the CautionColor parameter.
o SetCautionZone(DNBAnalysisLevel)
Sets the CautionZone attribute.
o SetCautionZoneLock(unsigned char)
Locks or unlocks the CautionZone parameter.
o SetTravelColor(unsigned int*,CATLONG32)
Sets the TravelColor attribute.
o SetTravelColorLock(unsigned char)
Locks or unlocks the TravelColor parameter.
o SetTravelLimit(DNBAnalysisLevel)
Sets the TravelLimit attribute.
o SetTravelLimitLock(unsigned char)
Locks or unlocks the TravelLimit parameter.
o SetVelocityColor(unsigned int*,CATLONG32)
Sets the VelocityColor attribute.
o SetVelocityColorLock(unsigned char)
Locks or unlocks the VelocityColor parameter.
o SetVelocityLimit(DNBAnalysisLevel)
Sets the VelocityLimit attribute.
o SetVelocityLimitLock(unsigned char)
Locks or unlocks the VelocityLimit parameter.

Methods


o GetAccelColor
public virtual HRESULT GetAccelColor(unsigned int* ioColor,
CATLONG32 iMaxLength,
CATLONG32* oReadLength=NULL )= 0
Retrieves the AccelColor attribute.
o GetAccelColorInfo
public virtual HRESULT GetAccelColorInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the AccelColor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAccelLimit
public virtual HRESULT GetAccelLimit(DNBAnalysisLevel& ioAnalysisLevel)= 0
Retrieves the AccelLimit attribute.
o GetAccelLimitInfo
public virtual HRESULT GetAccelLimitInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the AccelLimit parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetCautionColor
public virtual HRESULT GetCautionColor(unsigned int* ioColor,
CATLONG32 iMaxLength,
CATLONG32* oReadLength=NULL )= 0
Retrieves the CautionColor attribute.
o GetCautionColorInfo
public virtual HRESULT GetCautionColorInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the CautionColor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetCautionZone
public virtual HRESULT GetCautionZone(DNBAnalysisLevel& ioAnalysisLevel)= 0
Retrieves the CautionZone attribute.
o GetCautionZoneInfo
public virtual HRESULT GetCautionZoneInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the CautionZone parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTravelColor
public virtual HRESULT GetTravelColor(unsigned int* ioColor,
CATLONG32 iMaxLength,
CATLONG32* oReadLength=NULL )= 0
Retrieves the TravelColor attribute.
o GetTravelColorInfo
public virtual HRESULT GetTravelColorInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the TravelColor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTravelLimit
public virtual HRESULT GetTravelLimit(DNBAnalysisLevel& ioAnalysisLevel)= 0
Retrieves the TravelLimit attribute.
o GetTravelLimitInfo
public virtual HRESULT GetTravelLimitInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the TravelLimit parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetVelocityColor
public virtual HRESULT GetVelocityColor(unsigned int* ioColor,
CATLONG32 iMaxLength,
CATLONG32* oReadLength=NULL )= 0
Retrieves the VelocityColor attribute.
o GetVelocityColorInfo
public virtual HRESULT GetVelocityColorInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the VelocityColor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetVelocityLimit
public virtual HRESULT GetVelocityLimit(DNBAnalysisLevel& ioAnalysisLevel)= 0
Retrieves the VelocityLimit attribute.
o GetVelocityLimitInfo
public virtual HRESULT GetVelocityLimitInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the VelocityLimit parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAccelColor
public virtual HRESULT SetAccelColor( const unsigned int* iColor,
CATLONG32 iLength=1 )= 0
Sets the AccelColor attribute.
o SetAccelColorLock
public virtual HRESULT SetAccelColorLock(unsigned char iLocked)= 0
Locks or unlocks the AccelColor parameter.
Role: Locks or unlocks the AccelColor 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 SetAccelLimit
public virtual HRESULT SetAccelLimit( const DNBAnalysisLevel iAnalysisLevel)= 0
Sets the AccelLimit attribute.
o SetAccelLimitLock
public virtual HRESULT SetAccelLimitLock(unsigned char iLocked)= 0
Locks or unlocks the AccelLimit parameter.
Role: Locks or unlocks the AccelLimit 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 SetCautionColor
public virtual HRESULT SetCautionColor( const unsigned int* iColor,
CATLONG32 iLength=1 )= 0
Sets the CautionColor attribute.
o SetCautionColorLock
public virtual HRESULT SetCautionColorLock(unsigned char iLocked)= 0
Locks or unlocks the CautionColor parameter.
Role: Locks or unlocks the CautionColor 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 SetCautionZone
public virtual HRESULT SetCautionZone( const DNBAnalysisLevel iAnalysisLevel)= 0
Sets the CautionZone attribute.
o SetCautionZoneLock
public virtual HRESULT SetCautionZoneLock(unsigned char iLocked)= 0
Locks or unlocks the CautionZone parameter.
Role: Locks or unlocks the CautionZone 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 SetTravelColor
public virtual HRESULT SetTravelColor( const unsigned int* iColor,
CATLONG32 iLength=1 )= 0
Sets the TravelColor attribute.
o SetTravelColorLock
public virtual HRESULT SetTravelColorLock(unsigned char iLocked)= 0
Locks or unlocks the TravelColor parameter.
Role: Locks or unlocks the TravelColor 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 SetTravelLimit
public virtual HRESULT SetTravelLimit( const DNBAnalysisLevel iAnalysisLevel)= 0
Sets the TravelLimit attribute.
o SetTravelLimitLock
public virtual HRESULT SetTravelLimitLock(unsigned char iLocked)= 0
Locks or unlocks the TravelLimit parameter.
Role: Locks or unlocks the TravelLimit 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 SetVelocityColor
public virtual HRESULT SetVelocityColor( const unsigned int* iColor,
CATLONG32 iLength=1 )= 0
Sets the VelocityColor attribute.
o SetVelocityColorLock
public virtual HRESULT SetVelocityColorLock(unsigned char iLocked)= 0
Locks or unlocks the VelocityColor parameter.
Role: Locks or unlocks the VelocityColor 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 SetVelocityLimit
public virtual HRESULT SetVelocityLimit( const DNBAnalysisLevel iAnalysisLevel)= 0
Sets the VelocityLimit attribute.
o SetVelocityLimitLock
public virtual HRESULT SetVelocityLimitLock(unsigned char iLocked)= 0
Locks or unlocks the VelocityLimit parameter.
Role: Locks or unlocks the VelocityLimit 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: DNBISimDevAnalysisSettingAtt.h
If needed, your Imakefile.mk should include the module: DNBDeviceItf

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