Difference between revisions of "IC Python API:RLPy RStatus"

From Reallusion Wiki!
Jump to: navigation, search
m (→‎isError)
m
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{TOC}}
 
{{TOC}}
−
{{Parent|IC_Python_API:RL_Python_Modules#System|System Module}}
+
{{Parent|IC_Python_API:RL_Python_Modules|Modules}}
−
 
+
{{last_modified}}
−
Class in RLPy / Inherits from:_object
+
  
 
== Description ==
 
== Description ==
  
−
API level error handling.
+
This class facilitates error handling for each API.  It encapsulates the status code as a return value for each API function.  Developers can query, set, or output status codes through this class. The [[IC_Python_API:RLPy_RStatus|RStatus]] codes and their instructions are listed below:
  
−
Most API methods return this class. you can query, clear, and print the error code along with the error description.
+
{| class="wikitable"
 +
!Constant
 +
!Value
 +
|-
 +
|RStatus.Success
 +
|The operation was successful.
 +
|-
 +
|RStatus.Failure
 +
|The operation failed.
 +
|-
 +
|RStatus.InsufficientMemory
 +
|The operation failed due to insufficient memory.
 +
|-
 +
|RStatus.LicenseFailure
 +
|Application is not licensed for the attempted operation.
 +
|-
 +
|RStatus.IncompatibleVersion
 +
|The applied operation is not compatible with the current version.
 +
|-
 +
|RStatus.InvalidParameter
 +
|An invalid parameter was provided.
 +
|-
 +
|RStatus.UnknownParameter
 +
|The operation was called with an unrecognized argument.
 +
|-
 +
|RStatus.NotImplemented
 +
|This operation has not been implemented.
 +
|-
 +
|RStatus.Deprecated
 +
|This operation has been deprecated.
 +
|-
 +
|RStatus.NotFound
 +
|Not currently used.
 +
|-
 +
|RStatus.EndOfFile
 +
|Not currently used.
 +
|}
  
 
== Member Functions ==
 
== Member Functions ==
  
−
=== Clear ===
+
=== Clear( self ) ===
 +
 
 +
Clear the current error status. '''Success''' status code is returned upon calling this function.
 +
 
 +
See also: [[#IsError( self )|IsError( self )]]
 +
 
 +
<syntaxhighlight lang="python" line='line'>
 +
status = RLPy.RGlobal.SetTime(RLPy.RTime(1000))
 +
if status == RLPy.RStatus.Failure:
 +
    print("failure")
 +
    status.Clear()
 +
    print(status.IsError())  # False
 +
</syntaxhighlight>
 +
 
 +
=== GetStatusCode ( self ) ===
 +
 
 +
Get the current status code.  Refer to the status code table above.
  
−
{{Input|def RLPY.RStatus.Clear(self)}}
+
==== Returns ====
 +
:Return the internal status code - int
 +
:*RLPy.RStatus.Success
 +
:*RLPy.RStatus.Failure
 +
:*RLPy.RStatus.InsufficientMemory
 +
:*RLPy.RStatus.LicenseFailure
 +
:*RLPy.RStatus.IncompatibleVersion
 +
:*RLPy.RStatus.InvalidParameter
 +
:*RLPy.RStatus.UnknownParameter
 +
:*RLPy.RStatus.NotImplemented
 +
:*RLPy.RStatus.Deprecated
 +
:*RLPy.RStatus.NotFound
 +
:*RLPy.RStatus.EndOfFile
  
−
=== GetStatusCode ===
+
<syntaxhighlight lang="python" line='line'>
 +
if status.GetStatusCode() == RLPy.RStatus.Success:
 +
    print("sucess")                                # print sucess
 +
</syntaxhighlight>
  
−
{{Input|def RLPY.RStatus.GetStatusCode(self)}}
+
=== IsError( self ) ===
  
−
===IsError ===
+
Check whether the current status is an error.
  
−
{{Input|def RLPY.RStatus.IsError(self)}}
+
==== Returns ====
 +
:'''True''': An error has occured.
 +
:'''False''': No error.
  
−
== Constructor & Destructor ==
+
<syntaxhighlight lang="python" line='line'>
 +
status = RLPy.RGlobal.SetTime(RLPy.RTime(1000))
 +
 
 +
if status == RLPy.RStatus.Success:
 +
    print("sucess")                                # print sucess
 +
 
 +
if status == RLPy.RStatus.Failure:
 +
    print("failure")
 +
    status.Clear()
 +
    print(status.IsError())                        # False
 +
 
 +
if status.GetStatusCode() == RLPy.RStatus.Success:
 +
    print("sucess")                                # print sucess
 +
 
 +
print(status.IsError())
 +
</syntaxhighlight>

Latest revision as of 23:57, 13 April 2020

Main article: Modules.
Last modified: 04/13/2020

Description

This class facilitates error handling for each API. It encapsulates the status code as a return value for each API function. Developers can query, set, or output status codes through this class. The RStatus codes and their instructions are listed below:

Constant Value
RStatus.Success The operation was successful.
RStatus.Failure The operation failed.
RStatus.InsufficientMemory The operation failed due to insufficient memory.
RStatus.LicenseFailure Application is not licensed for the attempted operation.
RStatus.IncompatibleVersion The applied operation is not compatible with the current version.
RStatus.InvalidParameter An invalid parameter was provided.
RStatus.UnknownParameter The operation was called with an unrecognized argument.
RStatus.NotImplemented This operation has not been implemented.
RStatus.Deprecated This operation has been deprecated.
RStatus.NotFound Not currently used.
RStatus.EndOfFile Not currently used.

Member Functions

Clear( self )

Clear the current error status. Success status code is returned upon calling this function.

See also: IsError( self ) 

1 status = RLPy.RGlobal.SetTime(RLPy.RTime(1000))
2 if status == RLPy.RStatus.Failure:
3     print("failure")
4     status.Clear()
5     print(status.IsError())  # False

GetStatusCode ( self )

Get the current status code. Refer to the status code table above.

Returns

Return the internal status code - int
  • RLPy.RStatus.Success
  • RLPy.RStatus.Failure
  • RLPy.RStatus.InsufficientMemory
  • RLPy.RStatus.LicenseFailure
  • RLPy.RStatus.IncompatibleVersion
  • RLPy.RStatus.InvalidParameter
  • RLPy.RStatus.UnknownParameter
  • RLPy.RStatus.NotImplemented
  • RLPy.RStatus.Deprecated
  • RLPy.RStatus.NotFound
  • RLPy.RStatus.EndOfFile
1 if status.GetStatusCode() == RLPy.RStatus.Success:
2     print("sucess")                                 # print sucess

IsError( self )

Check whether the current status is an error.

Returns

True: An error has occured.
False: No error.
 1 status = RLPy.RGlobal.SetTime(RLPy.RTime(1000))
 2    
 3 if status == RLPy.RStatus.Success:
 4     print("sucess")                                 # print sucess
 5    
 6 if status == RLPy.RStatus.Failure:
 7     print("failure")
 8     status.Clear()
 9     print(status.IsError())                         # False
10    
11 if status.GetStatusCode() == RLPy.RStatus.Success:
12     print("sucess")                                 # print sucess
13    
14 print(status.IsError())
Retrieved from "https://wiki.reallusion.com/index.php?title=IC_Python_API:RLPy_RStatus&oldid=4524"