Source code for abaqus.OdbDisplay.ViewerOptions

from abaqusConstants import *


class ViewerOptions:
    """The ViewerOptions object specifies options to set the result caching parameters. The
    ViewerOptions object has no constructor. Abaqus creates the *viewerOptions* member when 
    a session is started. 

    Notes
    -----
    This object can be accessed by:
    
    .. code-block:: python
        
        import visualization
        session.viewerOptions

    """

    def setValues(self, primaryVariableCaching: Boolean = ON, deformedVariableCaching: Boolean = ON,
                  cutVariableCaching: Boolean = ON, odbUpdateChecking: Boolean = ON,
                  odbUpdateCheckInterval: int = 0):
        """This method modifies the ViewerOptions object.
        
        Parameters
        ----------
        primaryVariableCaching
            A Boolean specifying whether results are currently cached. Caching improves the 
            performance of subsequent access. The default value is ON. 
        deformedVariableCaching
            A Boolean specifying whether deformation vectors are currently cached. Caching improves 
            the performance of subsequent access. The default value is ON. 
        cutVariableCaching
            A Boolean specifying whether the values used for displaying cut models are currently 
            cached. Caching improves the performance of subsequent access. The default value is ON. 
        odbUpdateChecking
            A Boolean specifying whether the current .odb file should be checked for updates. 
            Setting *odbUpdateChecking* to OFF can improve Viewer performance when accessing data 
            from a remote file. The default value is ON. 
        odbUpdateCheckInterval
            An Int specifying the minimum time between status checks (in seconds). The default value 
            is 0. 
        """
        pass