All Frameworks Class Hierarchy This Framework Indexes
DNBDeviceInterfaces Interface 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.
- Methods to set value of each parameter xxx
- Methods to get value of each parameter xxx
- Methods to get information on each parameter xxx
- Methods to lock/unlock value of each parameter xxx
Here is the list of parameters to use and their meaning:
- TravelLimit: defines what behavior you can expect when the DOF travel limits are exeeded.
- VelocityLimit: defines what behavior you can expect when the DOF speed limits are exeeded.
- AccelLimit: defines what behavior you can expect when the DOF acceleration limits are exeeded.
- CautionZone: defines what behavior you can expect when the DOF caution zone limits are exeeded.
- TravelColor: defines the highlight color to be used when the DOF travel limits are exceeded.
- VelocityColor: defines the highlight color to be used when the DOF speed limits are exceeded.
- AccelColor: defines the highlight color to be used when the DOF acceleration limits are exceeded.
- CautionColor: defines the highlight color to be used when the DOF caution zone limits are exceeded.
Method Index
- o
GetAccelColorInfo(CATSettingInfo*)
- Retrieves the state of the AccelColor parameter.
- o
GetAccelColor(unsigned int*,CATLONG32,CATLONG32*)
- Retrieves the AccelColor attribute.
- o
GetAccelLimitInfo(CATSettingInfo*)
- Retrieves the state of the AccelLimit parameter.
- o
GetAccelLimit(DNBAnalysisLevel&)
- Retrieves the AccelLimit attribute.
- o
GetCautionColorInfo(CATSettingInfo*)
- Retrieves the state of the CautionColor parameter.
- o
GetCautionColor(unsigned int*,CATLONG32,CATLONG32*)
- Retrieves the CautionColor attribute.
- o
GetCautionZoneInfo(CATSettingInfo*)
- Retrieves the state of the CautionZone parameter.
- o
GetCautionZone(DNBAnalysisLevel&)
- Retrieves the CautionZone attribute.
- o
GetTravelColorInfo(CATSettingInfo*)
- Retrieves the state of the TravelColor parameter.
- o
GetTravelColor(unsigned int*,CATLONG32,CATLONG32*)
- Retrieves the TravelColor attribute.
- o
GetTravelLimitInfo(CATSettingInfo*)
- Retrieves the state of the TravelLimit parameter.
- o
GetTravelLimit(DNBAnalysisLevel&)
- Retrieves the TravelLimit attribute.
- o
GetVelocityColorInfo(CATSettingInfo*)
- Retrieves the state of the VelocityColor parameter.
- o
GetVelocityColor(unsigned int*,CATLONG32,CATLONG32*)
- Retrieves the VelocityColor attribute.
- o
GetVelocityLimitInfo(CATSettingInfo*)
- Retrieves the state of the VelocityLimit parameter.
- o
GetVelocityLimit(DNBAnalysisLevel&)
- Retrieves the VelocityLimit attribute.
- o
SetAccelColorLock(unsigned char)
- Locks or unlocks the AccelColor parameter.
- o
SetAccelColor(unsigned int*,CATLONG32)
- Sets the AccelColor attribute.
- o
SetAccelLimitLock(unsigned char)
- Locks or unlocks the AccelLimit parameter.
- o
SetAccelLimit(DNBAnalysisLevel)
- Sets the AccelLimit attribute.
- o
SetCautionColorLock(unsigned char)
- Locks or unlocks the CautionColor parameter.
- o
SetCautionColor(unsigned int*,CATLONG32)
- Sets the CautionColor attribute.
- o
SetCautionZoneLock(unsigned char)
- Locks or unlocks the CautionZone parameter.
- o
SetCautionZone(DNBAnalysisLevel)
- Sets the CautionZone attribute.
- o
SetTravelColorLock(unsigned char)
- Locks or unlocks the TravelColor parameter.
- o
SetTravelColor(unsigned int*,CATLONG32)
- Sets the TravelColor attribute.
- o
SetTravelLimitLock(unsigned char)
- Locks or unlocks the TravelLimit parameter.
- o
SetTravelLimit(DNBAnalysisLevel)
- Sets the TravelLimit attribute.
- o
SetVelocityColorLock(unsigned char)
- Locks or unlocks the VelocityColor parameter.
- o
SetVelocityColor(unsigned int*,CATLONG32)
- Sets the VelocityColor attribute.
- o
SetVelocityLimitLock(unsigned char)
- Locks or unlocks the VelocityLimit parameter.
- o
SetVelocityLimit(DNBAnalysisLevel)
- Sets the VelocityLimit attribute.
Methods
o GetAccelColorInfo
| public virtual GetAccelColorInfo( | | oInfo) |
-
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 GetAccelColor
| public virtual GetAccelColor( | | ioColor, |
| | iMaxLength, |
| | oReadLength | =NULL ) |
-
Retrieves the AccelColor attribute.
o GetAccelLimitInfo
| public virtual GetAccelLimitInfo( | | oInfo) |
-
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 GetAccelLimit
| public virtual GetAccelLimit( | | ioAnalysisLevel) |
-
Retrieves the AccelLimit attribute.
o GetCautionColorInfo
| public virtual GetCautionColorInfo( | | oInfo) |
-
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 GetCautionColor
| public virtual GetCautionColor( | | ioColor, |
| | iMaxLength, |
| | oReadLength | =NULL ) |
-
Retrieves the CautionColor attribute.
o GetCautionZoneInfo
| public virtual GetCautionZoneInfo( | | oInfo) |
-
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 GetCautionZone
| public virtual GetCautionZone( | | ioAnalysisLevel) |
-
Retrieves the CautionZone attribute.
o GetTravelColorInfo
| public virtual GetTravelColorInfo( | | oInfo) |
-
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 GetTravelColor
| public virtual GetTravelColor( | | ioColor, |
| | iMaxLength, |
| | oReadLength | =NULL ) |
-
Retrieves the TravelColor attribute.
o GetTravelLimitInfo
| public virtual GetTravelLimitInfo( | | oInfo) |
-
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 GetTravelLimit
| public virtual GetTravelLimit( | | ioAnalysisLevel) |
-
Retrieves the TravelLimit attribute.
o GetVelocityColorInfo
| public virtual GetVelocityColorInfo( | | oInfo) |
-
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 GetVelocityColor
| public virtual GetVelocityColor( | | ioColor, |
| | iMaxLength, |
| | oReadLength | =NULL ) |
-
Retrieves the VelocityColor attribute.
o GetVelocityLimitInfo
| public virtual GetVelocityLimitInfo( | | oInfo) |
-
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 GetVelocityLimit
| public virtual GetVelocityLimit( | | ioAnalysisLevel) |
-
Retrieves the VelocityLimit attribute.
o SetAccelColorLock
| public virtual SetAccelColorLock( | | iLocked) |
-
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 SetAccelColor
| public virtual SetAccelColor( | const | iColor, |
| | iLength | =1 ) |
-
Sets the AccelColor attribute.
o SetAccelLimitLock
| public virtual SetAccelLimitLock( | | iLocked) |
-
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 SetAccelLimit
| public virtual SetAccelLimit( | const | iAnalysisLevel) |
-
Sets the AccelLimit attribute.
o SetCautionColorLock
| public virtual SetCautionColorLock( | | iLocked) |
-
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 SetCautionColor
| public virtual SetCautionColor( | const | iColor, |
| | iLength | =1 ) |
-
Sets the CautionColor attribute.
o SetCautionZoneLock
| public virtual SetCautionZoneLock( | | iLocked) |
-
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 SetCautionZone
| public virtual SetCautionZone( | const | iAnalysisLevel) |
-
Sets the CautionZone attribute.
o SetTravelColorLock
| public virtual SetTravelColorLock( | | iLocked) |
-
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 SetTravelColor
| public virtual SetTravelColor( | const | iColor, |
| | iLength | =1 ) |
-
Sets the TravelColor attribute.
o SetTravelLimitLock
| public virtual SetTravelLimitLock( | | iLocked) |
-
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 SetTravelLimit
| public virtual SetTravelLimit( | const | iAnalysisLevel) |
-
Sets the TravelLimit attribute.
o SetVelocityColorLock
| public virtual SetVelocityColorLock( | | iLocked) |
-
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 SetVelocityColor
| public virtual SetVelocityColor( | const | iColor, |
| | iLength | =1 ) |
-
Sets the VelocityColor attribute.
o SetVelocityLimitLock
| public virtual SetVelocityLimitLock( | | iLocked) |
-
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
o SetVelocityLimit
| public virtual SetVelocityLimit( | const | iAnalysisLevel) |
-
Sets the VelocityLimit attribute.
This object is included in the file: DNBISimDevAnalysisSettingAtt.h
If needed, your Imakefile.mk should include the module: DNBDeviceItf