Class LoadPattern

loading/load_pattern.py:95–294

Load pattern definition. Wraps SAP2000 `LoadPatterns`. Attributes: name: Load pattern name load_type: Load type (`LoadPatternType`) self_weight_multiplier: Self-weight multiplier add_load_case: Whether to automatically create a corresponding linear

@dataclass
class LoadPattern:
    """
    Load pattern definition.

    Wraps SAP2000 `LoadPatterns`.
    
    Attributes:
        name: Load pattern name
        load_type: Load type (`LoadPatternType`)
        self_weight_multiplier: Self-weight multiplier
        add_load_case: Whether to automatically create a corresponding linear static load case
    """
    name: str = ""
    load_type: LoadPatternType = LoadPatternType.OTHER
    self_weight_multiplier: float = 0.0
    add_load_case: bool = True
    
    _object_type: ClassVar[str] = "LoadPatterns"
    
    def _create(self, model) -> int:
        """
        Create a load pattern.
        
        Args:
            model: SAP2000 SapModel object
            
        Returns:
            `0` if successful, `-1` if it already exists.
        """
        # Check whether the load pattern already exists.
        if self.name:
            try:
                existing = self.get_name_list(model)
                if self.name in existing:
                    return -1
            except Exception:
                pass
        
        result = model.LoadPatterns.Add(
            self.name,
            int(self.load_type),
            self.self_weight_multiplier,
            self.add_load_case
        )
        return com_ret(result)
    
    def _get(self, model) -> int:
        """
        Retrieve load pattern data from the model.
        
        Args:
            model: SAP2000 SapModel object
            
        Returns:
            `0` if successful.
        """
        # Get the load pattern type.
        result = model.LoadPatterns.GetLoadType(self.name, 0)