Coating
| C++ | Python |
|---|---|
| Cmaxwell::Ccoating | Ccoating |
Coating description.
Inherits from
Methods
...
| Name | Description |
|---|---|
| setName | |
| getName | |
| setState | |
| getState | |
| getReflectance | |
| setThickness | |
| getThickness | |
| setActiveThickness | |
| getActiveThickness | |
| setThicknessRange | |
| getThicknessRange |
...
| Sets coating name. | |
| getName | Gets coating name. |
| setState | Enables/disables the coating. |
| getState | Gets whether the coating is enabled. |
| getReflectance | Gets a reference of the Cmaxwell::Creflectance of this coating. |
| setThickness | Sets the thickness of the coating. |
| getThickness | Gets the thickness of the coating. |
| setActiveThickness | Sets the active thickness of the coating. |
| getActiveThickness | Gets the active thickness of the coating. |
| setThicknessRange | Sets the thickness range. |
| getThicknessRange | Gets the thickness range. |
Inherited methods
| Name | Description |
|---|---|
| isNull | Checks whether the object is null. |
| Anchor | ||||
|---|---|---|---|---|
|
setName
Sets coating name.
| Language | Syntax |
|---|---|
| C++ | byte setName( const char* pName ) |
| Python | int setName( str name ) |
Return value
0 = Error getting coating name.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getName
Gets coating name.
| Language | Syntax |
|---|---|
| C++ | byte getName( char** pName ) |
| Python | str getName() |
Return Value
C++
0 = Error getting coating name.
1 = Success.
Python
Coating name.
| Anchor | ||||
|---|---|---|---|---|
|
setState
Enables/disables the coating.
| Language | Syntax |
|---|---|
| C++ | byte setState( bool enabled ) |
| Python | int setState( bool enabled ) |
Return value
0 = Error enabling/disabling coating.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getState
Gets whether the coating is enabled.
| Language | Syntax |
|---|---|
| C++ | byte getState( bool& enabled ) |
| Python | bool getState() |
Return Value
C++
0 = Error getting coating enabled state.
1 = Success.
Python
Coating enabled state.
| Anchor | ||||
|---|---|---|---|---|
|
getReflectance
Gets a reference of the Cmaxwell::Creflectance of this coating.
| Language | Syntax |
|---|---|
| C++ | Cmaxwell::Creflectance getReflectance() |
| Python | Creflectance getReflectance() |
| Anchor | ||||
|---|---|---|---|---|
|
setThickness
Sets the thickness of the coating.
| Language | Syntax |
|---|---|
| C++ | byte setThickness( Cmultivalue::Cmap& map ) |
| Python | int setThickness( Cmap map ) |
Return value
0 = Error setting thickness.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getThickness
Gets the thickness of the coating.
| Language | Syntax |
|---|---|
| C++ | byte getThickness( Cmultivalue::Cmap & map ) |
| Python | Cmap getThickness() |
Return Value
C++
0 = Error getting thickness.
1 = Success.
Python
Coating thickness.
| Anchor | ||||
|---|---|---|---|---|
|
setActiveThickness
Sets the active thickness of the coating.
| Language | Syntax |
|---|---|
| C++ | byte setActiveThickness( Cmultivalue::Cmap& map ) |
| Python | int setActiveThickness( Cmap map ) |
Return value
0 = Error setting active thickness.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getActiveThickness
Gets the active thickness of the coating.
| Language | Syntax |
|---|---|
| C++ | byte getActiveThickness( Cmultivalue::Cmap & map ) |
| Python | Cmap getActiveThickness() |
Return Value
C++
0 = Error getting active thickness.
1 = Success.
Python
Coating active thickness.
| Anchor | ||||
|---|---|---|---|---|
|
setThicknessRange
Sets the thickness range of the coating.
| Language | Syntax |
|---|---|
| C++ | byte setThicknessRange( real min, real max ) |
| Python | int setThicknessRange( float min, float max ) |
Return value
0 = Error setting thickness range.
1 = Success.
| Anchor | ||||
|---|---|---|---|---|
|
getThicknessRange
Gets the active thickness of the coating.
Return Value
C++
0 = Error getting thickness range.
1 = Success.
Python
Tuple (min,max) containing thickness range.